Get_all_orders
Retrieve orders filtered by search, status, payment, shipment, order type, date range, with pagination and sorting options.
Instructions
An API for getting a list of orders by condition
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| search | No | For searching the 'customer name' or 'order number' that partial match the given keyword | |
| page | No | For pagination, page is the page number to query the list of orders | |
| perPage | No | For pagination, per page is the number of showing orders on a page | |
| sortBy | No | For sorting of results by specific field | |
| orderBy | No | To define whether results are sorted in ascending or descending order | |
| orderStatus | No | Filtered by multiple values of order status | |
| paymentStatus | No | Filtered by multiple values of payment status | |
| paymentMethod | No | Filtered by multiple values of payment method | |
| shipmentStatus | No | Filtered by multiple values of shipment status | |
| orderType | No | Filtered by multiple values of order type | |
| startAt | No | Filtered by starting point of updated time. Example value is '2022-01-01T09:30:00Z' | |
| endAt | No | Filtered by ending point of updated time. Example value is '2022-01-01T09:30:00Z' |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| currentPage | No | Current page number | |
| data | No | ||
| perPage | No | Number of showing orders per page | |
| totalPage | No | Total page numbers of the result | |
| totalRow | No | Total number of orders |