Get all orders
Endpoint
/v1/orders
Resource method
GET
Parameters
URL parameter
| Field name | Types | Required/Optional | Description |
|---|---|---|---|
| from | string(20) | O | Date from (format: YYYY-MM-DD) e.g. 2021-10-01 |
| to | string(20) | O | Date to (format: YYYY-MM-DD) e.g. 2021-10-30 |
| state | string(20) | O | Order's state (default to ALL) |
| page | number(20) | R | Order's page |
| pageSize | number(20) | R | Order's page size |
Example expected response object
{
"data": [
{
"customerId": "C508a937a5a6a4664a97ed7aa68ff383f",
"receiverName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"streetAddress": "T-One Building, 8 Sukhumvit",
"district": "Khet Khlong Toei",
"subDistrict": "Phra Khanong",
"province": "Bangkok",
"postalCode": "10110",
"phoneNumber": "0987654321",
"email": "john-doe@email.com",
"orderNumber": "ON2005220001",
"paymentMethodType": "CASH_ON_DELIVERY",
"state": "ORDER_PLACED",
"note": "customer's note",
"grandTotal": 1100,
"totalProductDiscount": 0,
"totalPrice": 934.58,
"shippingDescription": "Kerry",
"shippingPrice": 100,
"vatPrice": 65.42,
"vatValue": 7,
"vatOptions": "INCLUDED",
"items": [
{
"productCode": "VA-4017",
"price": 250,
"amount": 4,
"weight": 10
},
{
"productCode": "VA-4015",
"price": 250,
"amount": 1,
"digitalContents": [
{
"content": "_CONTENT_",
"refId": "AAASKASCXZC12"
}
],
"weight": 10
}
],
"attachments": [
{
"id": "DASDK_ASDKASD",
"type": "RECEIPT"
},
{
"id": "ASXKQO_XKJS",
"type": "RECEIPT"
}
],
"totalWeight": 20
}
],
"total": 1
}