Order List

All orders, as per filter details

API Endpoint

URL	{base url}/api/Order/OrderList
Method	POST
Authorization	Bearer Token
Content-Type	application/json

Request Headers

Parameter	Type	Required	Description
APIKEY	string	true	System key code

Request Parameters

Parameter	Type	Required	Description
Limit	integer	true	The number of records to retrieve.
LoadIndex	integer	true	The starting index for retrieving data.
Active	boolean	false	Specifies the status of the data (True = Active, False = Inactive).
Sortby	string	false	Specifies the field to sort the data by (e.g., createdate).
SortType	string	false	Specifies the sorting direction (asc = ascending, desc = descending).
OrderId	string	false	The unique identifier for the order.
OrderNo	string	false	The order number.
TrackingNo	string	false	The tracking number of the parcel.
Platform	string	false	The platform name.
Status	string	false	The status of the order.
From_Date	string	false	Filter data from a specific date (format: dd-mm-yyyy, Gregorian).
To_Date	string	false	Filter data up to a specific date (format: dd-mm-yyyy, Gregorian).

Request JSON Example

{
  "Limit": 10,
  "LoadIndex": 1,
  "Active": true,
  "Sortby": "CreateDate",
  "SortType": "desc",
  "OrderId": "",
  "OrderNo": "",
  "TrackingNo": "",
  "Platform": "",
  "Status": "",
  "From_Date": "01-10-2024",
  "To_Date": "31-12-2024"
}
    

Response Parameters

Parameter	Type	Description
Id	integer	Error status, e.g., 0 means no error.
Success	boolean	Indicates the success status.
Message	string	Response message.
RequestId	string	Reference to the request.
Size	integer	Number of data items.
Data	object	Product information.

Data

Parameter	Type	Description
Id	string	OMS ID of the order.
Seller	string	Seller code.
ShopId	string	Shop ID.
Platform	object	Sales channel.
OrderId	string	Order ID.
OrderNo	string	Order number.
OrderDate	string	Order date.
OrderStatus	object	Order status information.
Campaign	string	Campaign.
Customer	object	Customer information.
Recipient	object	Recipient information.
Logistics	object	Logistics information.
TrackingNo	string	Tracking number.
AllQty	string	Total quantity.
PayAmount	string	Payment amount.
Discount	string	Discount.
ShippFree	string	Free shipping.
PaymentId	string	Payment method ID.
Remark	string	Remark.
Tag	string	Tag.
UpdateDate	string	Last update date.
CreateDate	string	Creation date.
OrderSkus	object	Order items.

OrderSkus

Parameter	Type	Description
SkuId	string	SKU ID.
SkuCode	string	Product code.
SkuDesc1	string	Product description.
SkuDesc2	string	Additional product description.
Qty	integer	Quantity.
Unit	object	Unit information.
UnitPrice	decimal	Unit price.
Discount	decimal	Unit discount.

Response JSON Example

{
    "Id": 0,
    "Success": true,
    "Message": "SUCCESS",
    "RequestId": "E9828A3D-1980-445F-9106-D3F540ACFA14",
    "Size": 1,
    "Data": [
        {
            "Id": "C9C1D129-6289-45CF-9143-716AA2851AE4",
            "Seller": "22043",
            "ShopId": null,
            "Platform": {
                "Id": "3BAE6C4EA722485C80FE3639883F8BDE",
                "Name": "Facebook Market Place",
                "ShotName": "Facebook Market Place"
            },
            "OrderId": "OD8B0P1M",
            "OrderNo": "OD8B0P1M",
            "OrderDate": "2024-12-24T00:00:00",
            "OrderStatus": {
                "Id": "E9C4E62B-164B-4796-BC51-A13D5AEF85FB",
                "Code": "11",
                "Name": "ตรวจสอบข้อมูลคำสั่งซื้อ"
            },
            "Campaign": "24/12/2024",
            "Customer": null,
            "Recipient": null,
            "Logistics": {
                "Id": "FA63D864E16E439D988AEB99A7CEE06F",
                "Name": "DHL Express"
            },
            "TrackingNo": "SPXTH04943701319C",
            "AllQty": 5,
            "PayAmount": 0.0,
            "Discount": 0.0,
            "ShippFree": 0.0,
            "PaymentId": null,
            "Remark": null,
            "Tag": null,
            "UpdateDate": null,
            "CreateDate": "2025-01-03T14:34:16.1202561",
            "OrderSkus": [
                {
                    "SkuId": "8FC1F6E7-DD2F-425A-BCEA-1787AD2269D8",
                    "SkuCode": "5689851",
                    "SkuDesc1": "Pynotica ",
                    "SkuDesc2": null,
                    "Qty": 4,
                    "Unit": {
                        "Id": "",
                        "Name": "ชิ้น"
                    },
                    "UnitPrice": 0.0,
                    "Discount": null
                },
                {
                    "SkuId": "CD2BCD3F-F90E-4C3E-990E-D68B7B5BA2A7",
                    "SkuCode": "5689859",
                    "SkuDesc1": "แผ่นพับ pynotica ",
                    "SkuDesc2": null,
                    "Qty": 1,
                    "Unit": {
                        "Id": "",
                        "Name": "ชิ้น"
                    },
                    "UnitPrice": 0.0,
                    "Discount": null
                }
            ]
        }
    ]
}