List orders

Lists all orders that the distributor has generated, sorted descending by the order creation date.

List orders

get
/orders
Query parameters
page_sizeinteger · min: 1 · max: 100Optional

Number of items per page. Default value is 10, maximum value is 100.

Default: 10Example: 5
pageinteger · min: 1Optional

Number of the page to retrieve. Used in combination with the page_size parameter to define the page size.

Default: 1Example: 1
start_datestring · dateOptional

First day for which to return list of orders (default: 30 days before the current date).

Example: 2021-01-05Pattern: YYYY-MM-DD
end_datestring · dateOptional

Last day for which to return list of orders. (default: the current date).

Example: 2021-02-05Pattern: YYYY-MM-DD
Header parameters
AuthorizationstringRequired

Token <Your_API_Key>.

Default: Token <Partner_API_key>.
Responses
200

Successful operation.

application/json
get
/orders

Last updated

Was this helpful?