API Docs – Order History (order-list)

API Development And
Integration Guide

Order History (order-list)

Overview

Use this endpoint to retrieve a paginated history of all past orders. It supports searching, sorting, and filtering to help you build order-tracking dashboards, audit logs, or admin tools.

Endpoint & Environment

https

POST {baseUrl}/api/order/list

Required Headers

https

x-api-key: YOUR_API_KEY  
Accept-Language: en-US  
Content-Type: application/json

Request Body Structure

Field	Type	Required	Description
page	int	Yes	Which page to return (min: 1)
pageSize	int	Yes	Results per page (max: 100)
orderColumn	String	No	Field used to sort results (e.g., "OrderName")
order	String	No	Sort direction: "ASC" or "DESC"
search	array	No	Filter array (see example)

Example: Filter by OrderName

json

{
  "page": 1,
  "pageSize": 20,
  "orderColumn": "OrderName",
  "order": "DESC",
  "search": [
    {
      "column": "OrderName",
      "operator": "Equals",
      "value": "A00000000000003"
    }
  ]
}

Sample Response

https

{
  "pageInfo": {
    "totalPage": 1,
    "totalCount": 1,
    "pageSize": 20,
    "currentPage": 1
  },
  "data": [
    {
      "id": 19,
      "orderName": "A00000000000002",
      "orderDate": "2023-12-28T00:00:00",
      "orderAmount": 100.00
    }
  ],
  "status": true
}

Response Field Breakdown

pageInfo.totalPage — Number of available pages
pageInfo.totalCount — Total number of records matching filters
pageInfo.pageSize — Results per page (as requested)
pageInfo.currentPage — The current page
data[] — Array of order entries, each containing:

id — Internal database ID
orderName — Public/Reference Order ID
orderDate — Timestamp of order creation
orderAmount — Total amount of the order
data[] — Array of order entries, each containing:

Response Field Breakdown

Always enable pagination to avoid large or slow responses.
Include at least one sorting key (like OrderDate or OrderName) to ensure stable pagination.
Use filters (e.g., search by ReferenceId or date range) to narrow results and improve performance.
Handle empty pages gracefully: if currentPage > totalPage, return an empty data array.