Skip to main content
GET
List orders

Autorizaciones

Authorization
string
header
requerido

Public API key presented as Authorization: Bearer rq_live_….

Parámetros de consulta

limit
integer

Max items to return, 1–100. Defaults to 20.

Rango requerido: x <= 100
Ejemplo:

20

startingAfter
string

Cursor from the previous page's nextCursor. Omit for the first page.

status
enum<string>

Filter by order status.

Opciones disponibles:
PLACED,
CANCELLED
paymentStatus
enum<string>

Filter by payment status.

Opciones disponibles:
UNPAID,
PARTIALLY_PAID,
PAID,
ERROR
fulfillmentStatus
enum<string>

Filter by fulfillment status.

Opciones disponibles:
UNFULFILLED,
IN_PROGRESS,
FULFILLED,
DELIVERED
source
enum<string>

Filter by the channel the order came from.

Opciones disponibles:
STOREFRONT,
PURCHASE_ORDER
customerId
string<uuid>

Filter to one customer (UUID). Guest orders are excluded when set.

number
string

Filter by order number. Accepts a plain integer or the #123 form.

Pattern: ^#?\d+$
Ejemplo:

"#1042"

createdAfter
string<date-time>

Only orders created at or after this instant (ISO-8601 with timezone).

createdBefore
string<date-time>

Only orders created before this instant (ISO-8601 with timezone).

updatedAfter
string<date-time>

Only orders updated at or after this instant. Pair with sort=updatedAt for incremental sync.

updatedBefore
string<date-time>

Only orders updated before this instant (ISO-8601 with timezone).

sort
enum<string>
predeterminado:createdAt

Field to sort by. Use updatedAt for incremental sync.

Opciones disponibles:
createdAt,
updatedAt
order
enum<string>
predeterminado:desc

Sort direction.

Opciones disponibles:
asc,
desc

Respuesta

A page of orders.

data
object[]
requerido
hasMore
boolean
requerido
nextCursor
string | null
requerido