Skip to main content
GET
/
v2
/
orders
Error
A valid request URL is required to generate request examples
[
  {
    "order_id": "<string>",
    "order_url": "<string>",
    "order_date": "2023-11-07T05:31:56Z",
    "boarding_complete": true,
    "state": "new",
    "language": "<string>",
    "states_history": [
      {
        "order_id": "12345654",
        "state": "new",
        "datetime": "2018-08-02T09:24:02.142Z",
        "location": "Berlin"
      }
    ],
    "order_tags": {
      "tag1": "value1",
      "tag2": "value2"
    },
    "promised_delivery_date": "2023-11-07T05:31:56Z",
    "tracking_page_url": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

We use JWT Tokens for the authorization. Please add an 'Authorization' header for a request. Generate a valid JWT token using user credentials. See Auth - Token section. The value should contain the following:
'Bearer GENERATED_TOKEN'

Query Parameters

​
order_id
string
​
order_url
string
​
boarding_complete
boolean
​
state
string
​
language
string
​
order_date[before]
string

Date filter, example: 2025-04-09T11:47:19+02:00

​
order_date[after]
string

Date filter, example: 2025-04-09T11:47:19+02:00

​
promised_delivery_date[before]
string

Date filter, example: 2025-04-09T11:47:19+02:00

​
promised_delivery_date[after]
string

Date filter, example: 2025-04-09T11:47:19+02:00

​
page
integer

The collection page number

​
itemsPerPage
integer

The number of items per page (maximum of 100 records can be fetched with one call.)

Response

Order collection response

​
order_id
string
required

The unique shop order ID. Used as ID for the resource

​
order_url
string

The shop URL (a domain from which the order was created.)

​
order_date
string<date-time>
​
boarding_complete
boolean

A flag shows whether all order shipments are created

​
state
string
Example:

"new"

​
language
string
​
states_history
string[]
Example:
[
  {
    "order_id": "12345654",
    "state": "new",
    "datetime": "2018-08-02T09:24:02.142Z",
    "location": "Berlin"
  }
]
​
order_tags
string[]
Example:
{ "tag1": "value1", "tag2": "value2" }
​
promised_delivery_date
string<date-time>
​
tracking_page_url
string