Skip to main content
GET
List Orders

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
number
default:10

Items per page

Example:

10

page
number
default:1

Page number

Example:

1

amount
string

Amount range

Example:

">=10;<=50"

status
enum<string>

Order status

Available options:
PENDING,
PAID,
PAYMENT_FAILED,
CANCELED
Example:

"PENDING"

type
enum<string>

Order type

Available options:
ONLINE,
POS,
DRIVER_APP
Example:

"ONLINE"

filter
string

Generic filter that matches against

  • code
  • customer.name
  • customer.email
Example:

"ORD-123"

soldById
string<uuid>

Seller user identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d"

createdAt
string

Created at range

Example:

">=2024-01-01;<=2024-12-31"

sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt,
amount
Example:

"createdAt"

sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc
Example:

"desc"

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

List orders

data
object[]
required
meta
object
required