Skip to main content
POST
Resend delivery commands

Authorizations

Authorization
string
header
required

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

Path Parameters

orderId
string
required

Response

The updated order.

An order placed in the store. Fields that do not apply, or that the token has no scope to read, are omitted. List responses omit items, coupons, discounts, checkoutFields and buyer.billing; fetch the order by id to read them.

buyer
object

Buyer identity. Requires the orders:buyer:read scope; always present in webhooks.

cancelledAt
string<date-time>

When the order was cancelled.

Example:

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

checkoutFields
object[]
coupons
object[]
createdAt
string<date-time>

When the order was created.

Example:

"2026-09-25T13:04:12.000Z"

currency
string

ISO 4217 currency of every amount in the order.

Example:

"USD"

customGateway
object

Present only when gatewayType is CUSTOM.

deliveryStatus
enum<string>

Aggregated status of the order's delivery commands. NOT_APPLICABLE when the order has no commands.

Available options:
NOT_APPLICABLE,
PENDING,
PROCESSING,
EXECUTED,
FAILED,
UNCERTAIN
Example:

"EXECUTED"

discounts
object[]
externalPaymentId
string

Payment identifier at the provider.

Example:

"pi_3Q1x2y3z"

gatewayType
enum<string>

Payment gateway. MANUAL marks an order created by the seller in the dashboard; FREE marks a checkout with total 0; CUSTOM marks a custom gateway.

Available options:
PAYPAL,
STRIPE,
MERCADO_PAGO,
PIX,
MANUAL,
CUSTOM,
FREE
Example:

"STRIPE"

items
object[]
manualAdjustment
number

Manual adjustment the seller applied to a manual order total.

Example:

0

number
integer<int32>

Sequential order number shown to the seller in the dashboard. Informational only.

Example:

105

orderId
string

Order identifier. Use it in every order route.

Example:

"GC-7K9Q2X"

paidAt
string<date-time>

When the payment was approved.

Example:

"2026-09-25T13:05:00.000Z"

paymentStatus
enum<string>

Payment status.

Available options:
PENDING,
APPROVED,
REJECTED,
CANCELLED,
REFUNDED,
DISPUTE
Example:

"APPROVED"

publicOrderUrl
string

Public order page on the storefront.

Example:

"https://play.example.com/order/GC-7K9Q2X"

subtotal
number

Sum of the items before discounts.

Example:

20

total
number

Amount charged.

Example:

18

totalDiscount
number

Total discount from coupons and automatic discounts.

Example:

2