Skip to main content
GET
List orders

Authorizations

Authorization
string
header
required

API token created in the dashboard under Integrations > API. Tokens start with gci_.

Query Parameters

accountIdentifier
string

Exact delivery identifier, case-insensitive. Requires orders:buyer:read.

couponCode
string

Orders that used this coupon code.

email
string

Buyer e-mail, compared case-insensitively. Requires orders:buyer:read.

from
string<date-time>

Created at or after this instant (ISO-8601, UTC).

Example:

"2022-03-10T16:15:50.000Z"

gatewayType
enum<string>[]

Gateways to include. Repeat the parameter for several.

Available options:
PAYPAL,
STRIPE,
MERCADO_PAGO,
PIX,
MANUAL,
CUSTOM,
FREE
page
integer<int32>
default:0

Zero-based page.

productId
integer<int64>

Orders containing this product.

q
string

Free search over buyer name, e-mail, identifier and order number. Requires orders:buyer:read.

size
integer<int32>
default:20

Items per page, 1 to 100.

status
enum<string>[]

Payment statuses to include. Repeat the parameter for several.

Available options:
PENDING,
APPROVED,
REJECTED,
CANCELLED,
REFUNDED,
DISPUTE
to
string<date-time>

Created before this instant (ISO-8601, UTC). Exclusive.

Example:

"2022-03-10T16:15:50.000Z"

Response

A page of orders.

currentPage
integer<int32>
items
object[]
pageSize
integer<int32>
totalItems
integer<int64>
totalPages
integer<int32>