GET
/
api
/
v2
/
orders
/

Authorizations

Authorization
string
headerrequired

Token-based authentication with required prefix "Token"

Query Parameters

email
string

Only retrieve orders associated with this email address.

first_name
string

Only retrieve orders associated with this first name.

last_name
string

Only retrieve orders associated with this last name.

phone
string

Only retrieve orders associated with this phone number.

status
enum<string>

Only retrieve orders that have this status.

Available options:
canceled,
completed,
in_progress,
pending
created_before
string

Only retrieve orders created on or before this date. Format: YYYY-MM-DD

created_after
string

Only retrieve orders created on or after this date. Format: YYYY-MM-DD

updated_before
string

Only retrieve orders updated on or before this date. Format: YYYY-MM-DD

updated_after
string

Only retrieve orders updated on or after this date. Format: YYYY-MM-DD

results
integer

Number of results to return. Must be in range 1-100. Default is 10.

Required range: 1 < x < 100
offset
integer

The initial index from which to return the results.

Required range: x > 0

Response

200 - application/json
order_id
string

The order's unique ID.

status
enum<string>
Available options:
pending,
in_progress,
completed,
canceled
recipient
object
created
string

The date and time the order was created.

updated
string

The date and time the order was last updated.

Create orderGet order by ID