Skip to main content
Use this endpoint to retrieve a paginated list of orders for your account or, for company integrators, for a specific merchant. You can narrow results by order type, status, payment method, date range, or a free-text search query.

Authentication

Query parameters

integer
Page number to retrieve. Default: 1.
integer
Number of results per page. Default: 50.
string
Filter by order type. Accepted values: Deliver, Return, Exchange, or All.
string
Filter by a specific order status string (e.g. new, inProgress).
string
Filter by status category group.
string
Filter by payment method. Accepted values: COD, CD, NA, or All.
string
Start of the date range filter. ISO 8601 date format: YYYY-MM-DD.
string
End of the date range filter. ISO 8601 date format: YYYY-MM-DD.
Full-text search across order number, customer name, customer phone, and product description.

Request

Filtering examples

Filter by date range and order type:
Search by customer phone:

Response

200 — Orders list

array
Array of order summary objects. Each object contains the same fields as the create response.
object

Error responses