Retrieve an order list

GET {{base_url}}/api/1.0/orders?limit=100&from_created_date=1991-03-12T03:51:25.311Z

Retrieve all the orders that you’ve created. You can also use the query parameters for:

  • Filtering
  • Pagination

The response contains an array of simplified Order objects.

Full documentation: Merchant API - Retrieve an order list

Request Params

KeyDatatypeRequiredDescription
limitnumberThe maximum number of orders returned per page. Used for pagination.
created_beforestringRetrieve orders with a created_date < created_before. Used for pagination. Use the created_date of the last order returned in the previous response to get to the next page.

The default value is the current date and time you are calling the endpoint. | | from_created_date | string | | Retrieve all orders with a created_datefrom_created_date. Used for filtering.

Use the ISO date format : yyyy-MM-ddTHH:mm:ss[.SSSSSS]Z. For example, 2021-02-10T16:59:50.886826Z. | | to_created_date | string | | Retrieve all orders with a created_dateto_created_date. Used for filtering.

Use the ISO date format : yyyy-MM-ddTHH:mm:ss[.SSSSSS]Z. For example, 2021-02-10T16:59:50.886826Z. | | email | null | | Retrieve all orders that have this email associated to them. Used for filtering.

This parameter is case sensitive. | | merchant_order_ext_ref | null | | Merchant order ID for external reference. Use this field to filter and retrieve all the orders that have this ID. Used for filtering.

This parameter is case sensitive. | | state | string | | Retrieve all orders with specific states. You can pass several states. Used for filtering.

If multiple states are selected, for example AUTHORISED and COMPLETED, orders with either of the selected values are returned.

The parameter is case sensitive. |