List orders

Definition

This endpoint will allow you to retrieve your order data.

Query parameters

Filtering

The field state supports filtering. By default, we return new orders (orders in state CREATED).

Filter valuesDefinition
CREATEDNew order
ACCEPTEDAccepted
FULFILLEDHandled/shipped
NOT_FULFILLEDCancelled/refunded

Pagination

We return 100 orders by default and you can retrieve up to 1000 orders per page by using pagination parameters.

ParameterDefault valueRequired
limit100No
page1No

You may combine pagination and filtering.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Filter orders by state

Show Details
CREATEDNew order, to be handled
ACCEPTEDAccepted; must be fulfilled and delivered within the given delivery time
FULFILLEDHandled; the item has been shipped. Terminal state.
NOT_FULFILLEDCancelled; the customer has been refunded. Terminal state.
Allowed:
integer
1 to 1000
Defaults to 100

Number of orders to return (max 1000)

integer
≥ 1
Defaults to 1

Page number for pagination

Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json