GET
Get order list

Authorizations

x-api-key
string
header
required

Query Parameters

page
integer
default:0

Zero-based page number.

per_page
integer
default:10

Number of orders per page. Maximum 100.

Required range: x <= 100
external_order_number
string

Return only orders whose external order number is exactly this value.

Minimum string length: 1
initial_creation_date
string<date-time>

Return only orders created at or after this date-time (ISO 8601, creation_date >= value).

final_creation_date
string<date-time>

Return only orders created at or before this date-time (ISO 8601, creation_date <= value).

sell_order_state_codes
integer[]

Return only orders in any of these state codes (see Sell order states). Send it as a JSON array (sell_order_state_codes=[3,28]), as a repeated parameter (sell_order_state_codes=3&sell_order_state_codes=28) or as a single code (sell_order_state_codes=3).

sort_field
enum<string>
default:creation_date

Field to sort by. Only creation_date is supported.

Available options:
creation_date
sort_order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc

Response

A page of sell orders.

data
object[]

Orders in this page.

meta_data
object