GET api/BillingService/ListOrders?pageIndex={pageIndex}&pageSize={pageSize}&state={state}
Documentation for 'ListOrders'.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| pageIndex | Documentation for 'pageIndex'. |
Define this parameter in the request URI. |
| pageSize | Documentation for 'pageSize'. |
Define this parameter in the request URI. |
| state | Documentation for 'state'. |
Define this parameter in the request URI. |
Response Information
Response body formats
application/json, text/json
Sample:
{
"Orders": [
{
"reference_number": "sample string 1",
"order_utc_time": "sample string 2",
"payment_utc_time": "sample string 3",
"order_amount": 4.0,
"tax_type": 64,
"currency_type": "sample string 6",
"order_state": 64,
"paid": true,
"order_detail": [
{
"product_text_id": "sample string 1",
"quantity": 2,
"promotion_code": "sample string 3"
},
{
"product_text_id": "sample string 1",
"quantity": 2,
"promotion_code": "sample string 3"
},
{
"product_text_id": "sample string 1",
"quantity": 2,
"promotion_code": "sample string 3"
}
]
},
{
"reference_number": "sample string 1",
"order_utc_time": "sample string 2",
"payment_utc_time": "sample string 3",
"order_amount": 4.0,
"tax_type": 64,
"currency_type": "sample string 6",
"order_state": 64,
"paid": true,
"order_detail": [
{
"product_text_id": "sample string 1",
"quantity": 2,
"promotion_code": "sample string 3"
},
{
"product_text_id": "sample string 1",
"quantity": 2,
"promotion_code": "sample string 3"
},
{
"product_text_id": "sample string 1",
"quantity": 2,
"promotion_code": "sample string 3"
}
]
},
{
"reference_number": "sample string 1",
"order_utc_time": "sample string 2",
"payment_utc_time": "sample string 3",
"order_amount": 4.0,
"tax_type": 64,
"currency_type": "sample string 6",
"order_state": 64,
"paid": true,
"order_detail": [
{
"product_text_id": "sample string 1",
"quantity": 2,
"promotion_code": "sample string 3"
},
{
"product_text_id": "sample string 1",
"quantity": 2,
"promotion_code": "sample string 3"
},
{
"product_text_id": "sample string 1",
"quantity": 2,
"promotion_code": "sample string 3"
}
]
}
],
"total_count": 1,
"page_index": 2,
"page_size": 3,
"is_success": true,
"error_message": "sample string 5",
"exception_name": "sample string 6",
"error_code": 7
}
application/xml, text/xml
Sample:
<ListOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MMS.RestApi.Entities.Billing">
<error_code xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">7</error_code>
<error_message xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 5</error_message>
<exception_name xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 6</exception_name>
<is_success xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">true</is_success>
<page_index xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi.Entities">2</page_index>
<page_size xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi.Entities">3</page_size>
<total_count xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi.Entities">1</total_count>
<Orders>
<Order>
<currency_type>sample string 6</currency_type>
<order_amount>4</order_amount>
<order_detail>
<OrderItem>
<product_text_id>sample string 1</product_text_id>
<promotion_code>sample string 3</promotion_code>
<quantity>2</quantity>
</OrderItem>
<OrderItem>
<product_text_id>sample string 1</product_text_id>
<promotion_code>sample string 3</promotion_code>
<quantity>2</quantity>
</OrderItem>
<OrderItem>
<product_text_id>sample string 1</product_text_id>
<promotion_code>sample string 3</promotion_code>
<quantity>2</quantity>
</OrderItem>
</order_detail>
<order_state>64</order_state>
<order_utc_time>sample string 2</order_utc_time>
<paid>true</paid>
<payment_utc_time>sample string 3</payment_utc_time>
<reference_number>sample string 1</reference_number>
<tax_type>64</tax_type>
</Order>
<Order>
<currency_type>sample string 6</currency_type>
<order_amount>4</order_amount>
<order_detail>
<OrderItem>
<product_text_id>sample string 1</product_text_id>
<promotion_code>sample string 3</promotion_code>
<quantity>2</quantity>
</OrderItem>
<OrderItem>
<product_text_id>sample string 1</product_text_id>
<promotion_code>sample string 3</promotion_code>
<quantity>2</quantity>
</OrderItem>
<OrderItem>
<product_text_id>sample string 1</product_text_id>
<promotion_code>sample string 3</promotion_code>
<quantity>2</quantity>
</OrderItem>
</order_detail>
<order_state>64</order_state>
<order_utc_time>sample string 2</order_utc_time>
<paid>true</paid>
<payment_utc_time>sample string 3</payment_utc_time>
<reference_number>sample string 1</reference_number>
<tax_type>64</tax_type>
</Order>
<Order>
<currency_type>sample string 6</currency_type>
<order_amount>4</order_amount>
<order_detail>
<OrderItem>
<product_text_id>sample string 1</product_text_id>
<promotion_code>sample string 3</promotion_code>
<quantity>2</quantity>
</OrderItem>
<OrderItem>
<product_text_id>sample string 1</product_text_id>
<promotion_code>sample string 3</promotion_code>
<quantity>2</quantity>
</OrderItem>
<OrderItem>
<product_text_id>sample string 1</product_text_id>
<promotion_code>sample string 3</promotion_code>
<quantity>2</quantity>
</OrderItem>
</order_detail>
<order_state>64</order_state>
<order_utc_time>sample string 2</order_utc_time>
<paid>true</paid>
<payment_utc_time>sample string 3</payment_utc_time>
<reference_number>sample string 1</reference_number>
<tax_type>64</tax_type>
</Order>
</Orders>
</ListOrderResponse>