Skip to main content
GET
List orders

Query Parameters

states
string

States to list, comma separated, out of: pending-payment, pending-delivery, rolling-back, completed, rolled-back, expired, payment-returned, rejected. Omit it for every state.

Pattern: ^(pending-payment|pending-delivery|rolling-back|completed|rolled-back|expired|payment-returned|rejected)(,(pending-payment|pending-delivery|rolling-back|completed|rolled-back|expired|payment-returned|rejected))*$
Example:

"pending-payment,pending-delivery"

date
string<date>

Day the orders reached their state, in America/Sao_Paulo: the day they were created while pending, the day they completed once completed, and the day of their last state change otherwise. Omit it for any day.

Example:

"2026-10-09"

cursor
string

The next-cursor of the previous page. Omit it for the first page.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?Z_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"2026-10-09T13:04:16.344Z_01a120c1-cf85-70e7-b319-f6194a8061c4"

limit
integer<int32>

Orders per page, from 1 to 100. Defaults to 50.

Example:

50

Response

Orders retrieved successfully

orders
object[]
required
next-cursor
string | null
required

Pass as cursor to get the next page. Null on the last page.