Skip to main content
GET
List orders

Authorizations

Authorization
string
header
required

Authorization: Bearer

Query Parameters

status
string

Comma-separated status ids, as status.id is returned on an order, for example 5,7. Matches the status shown on each row, which is the status the single order read shows. At most 50 ids. A non-numeric value answers 422 invalid_parameter.

payment_type
enum<string>

Only orders paid this way.

Available options:
cod,
card
created_from
string<date-time>

ISO 8601 datetime; orders created at or after this instant.

created_to
string<date-time>

ISO 8601 datetime; orders created strictly before this instant, so consecutive windows never overlap.

updated_since
string<date-time>

ISO 8601 datetime; orders last modified at or after this instant (updated_at). With order=asc this is the way to follow changes.

order
enum<string>
default:desc

Sort by creation time, with the order's creation sequence breaking a tie, so a page boundary never repeats or skips a row.

Available options:
desc,
asc
page
integer
default:1
Required range: x >= 1
limit
integer
default:50

Default 50, maximum 100.

Required range: 1 <= x <= 100

Response

One page of your own orders, newest first by default. An empty result is a normal 200 with orders: [].

status
enum<string>
required
Available options:
success
status_code
integer
required
Example:

200

message
string
required
Example:

"OK"

data
object
required

One key named after the resource (products / product / states / categories / attributes / order / validation).

meta
object
required
error
object | null
required