Order structure
Order's structure
This is order structure that has been stored in the system
Structure
Orders structure
| Field name | Types | Required/Optional | Description |
|---|---|---|---|
| customerId | string(50) | R | Customer's id |
| receiverName | string(50) | R | Receiver name for order |
| firstName | string(30) | R | First name for order |
| lastName | string(30) | R | Last name for order |
| streetAddress | string(50) | R | Street address for order |
| streetAddress2 | string(50) | O | Street address2 for order |
| district | string(50) | R | District for order |
| subDistrict | string(50) | R | Sub-district for order |
| province | string(50) | R | Province for order |
| postalCode | string(10) | R | Postal code for order |
| phoneNumber | string(10) | R | Phone number for order |
| string(50) | R | Email for order | |
| orderNumber | string(12) | R | Order's number |
| state | string(30) | R | Order's state |
| platform | string(15) | R | Order's platform |
| note | string(50) | O | Order's note from customer |
| grandTotal | number(10) | R | Order’s grand total |
| totalPrice | number(10) | R | Order’s total price |
| shippingPrice | number(10) | R | Order’s total shipping price |
| vatPrice | number(10) | R | Order's vat price |
| vatValue | number(1) | R | Order's vat value |
| vatOptions | string(10) | R | Order's vat option |
| discountTotalPrice | number(10) | R | Order's total discount price |
| platform | string(10) | R | Order's platform |
| items | list of item | R | Selected Items’ in order |
| shippedDetail | object | O | Order shipped detail |
| createdAt | string(20) | R | Order's created date |
| updatedAt | string(20) | R | Order's updated date |
| shippedAt | string(20) | O | Order's shipped date |
| paymentMethodType | string(50) | O | Order's payment method type |
| shippingDescription | string(50) | O | Order's shipping description |
| attachments | list of attachment | O | Order's attachments |
| totalWeight | number(10) | O | Order's total weight |
Order's state
Possible state for order
{
"ABANDONED": "ABANDONED", // Customer's ignore order
"CANCELLED": "CANCELLED", // Order has been cancelled by admin or customer
"COD_PICKED_UP": "COD_PICKED_UP", // Order has been picked up by COD carrier
"COD_PREPARE_TO_SHIP": "COD_PREPARE_TO_SHIP", // Order has been prepared to ship for COD to pick up
"COD_REJECTED": "COD_REJECTED", // Order has been rejected by customer
"COMPLETED": "COMPLETED", // Order is completed
"ORDER_PLACED": "ORDER_PLACED", // Order placed
"PENDING_FOR_SHIPPING_COST": "PENDING_FOR_SHIPPING_COST", // Order is waiting for shipping price to be specified
"PREPARE_TO_SHIPPING": "PREPARE_TO_SHIPPING", // Order is in prepare to ship (after order has been paid)
"WAIT_FOR_PAYMENT_APPROVE": "WAIT_FOR_PAYMENT_APPROVE", // Waiting for payment approval by admin (customers sent proof of payment to the system)
"VOIDED": "VOIDED" // Admin voided order back as requested from customer or etc
}
Order's platform
{
"FACEBOOK": "FACEBOOK",
"LINE": "LINE",
"OFFLINE": "OFFLINE"
}
Order's shipped detail
{
"detail": [
{
"carrierName": "Thaipost-EMS",
"deliveryDate": "Fri Jan 15 2021 17:43:23 GMT+0700 (Indochina Time)", // Date time in ISO string
"trackingNumber": "6786786786789",
"otherCarrierName": ""
}
]
}
Order's payment method type
{
"BANK_QRCODE": "BANK_QR_CODE",
"BANK_TRANSFER": "BANK_TRANSFER",
"BILLPAYMENT_CENPAY": "BILL_PAYMENT_CEN_PAY",
"CASH_ON_DELIVERY": "CASH_ON_DELIVERY",
"CHILL_PAY_OTHER_METHOD": "CHILL_PAY_OTHER_METHOD",
"CREDITCARD_KBANK": "CREDIT_CARD_K_BANK",
"DEEPLE_PAY": "DEEPLE_PAY",
"EPAYMENT_ALIPAY": "ELECTRONIC_PAYMENT_ALI_PAY",
"EPAYMENT_BLUEPAY": "ELECTRONIC_PAYMENT_BLUE_PAY",
"EPAYMENT_LINEPAY": "ELECTRONIC_PAYMENT_LINE_PAY",
"EPAYMENT_WECHAT_PAY": "ELECTRONIC_PAYMENT_WE_CHAT_PAY",
"INSTALLMENT_KBANK": "INSTALLMENT_K_BANK",
"INSTALLMENT_TBANK": "INSTALLMENT_T_BANK",
"INTERNETBANK_BAY": "INTERNET_BANKING_BAY",
"INTERNETBANK_BBL": "INTERNET_BANKING_BBL",
"INTERNETBANK_KTB": "INTERNET_BANKING_KTB",
"INTERNETBANK_SCB": "INTERNET_BANKING_SCB",
"INTERNETBANK_TBANK": "INTERNET_BANKING_T_BANK",
"PAYPLUS_KBANK": "PAY_PLUS_K_BANK",
"PROMPT_PAY": "PROMPT_PAY"
}
Example of order structure
{
"customerId": "C508a937a5a6a4664a97ed7aa68ff383f",
"createdAt": "2020-04-02T13:50:18.848Z",
"updatedAt": "2020-04-02T13:50:18.848Z",
"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",
"platform": "LINE",
"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
},
{
"productCode": "VA-4015",
"price": 250,
"amount": 1,
"digitalContents": [
{
"content": "_CONTENT_",
"refId": "AAASKASCXZC12"
}
]
}
],
"shippedDetail": {
"detail": [
{
"carrierName": "Thaipost-EMS",
"deliveryDate": "Fri Jan 15 2021 17:43:23 GMT+0700 (Indochina Time)", // Date time in ISO string
"trackingNumber": "TH-123456",
"otherCarrierName": ""
}
]
},
"attachments": [
{
"id": "DASDK_ASDKASD",
"type": "RECEIPT"
},
{
"id": "ASXKQO_XKJS",
"type": "RECEIPT"
}
],
"totalWeight": 100
}