Get an order by id
A single order by its UUID. Requires the orders:read scope.
Autorizaciones
Public API key presented as Authorization: Bearer rq_live_….
Parámetros de ruta
Order UUID.
"0b2e9f5a-1c3d-4e6f-8a9b-0c1d2e3f4a5b"
Respuesta
The order.
Order UUID. Stable primary key; use it for lookups.
Per-organization sequential order number (shown as #123).
1042
Lifecycle status: PLACED or CANCELLED.
PLACED, CANCELLED Payment state: UNPAID, PARTIALLY_PAID, PAID, or ERROR.
UNPAID, PARTIALLY_PAID, PAID, ERROR Channel the order came from (currently always STOREFRONT).
STOREFRONT, PURCHASE_ORDER When the order record was created.
"2026-06-30T14:12:00Z"
When the order was last modified. Use as the watermark for incremental sync.
"2026-06-30T14:12:00Z"
When the customer placed the order. Null until placed.
"2026-06-30T14:12:00Z"
When the order was cancelled. Null unless status is CANCELLED.
"2026-06-30T14:12:00Z"
Reason code for cancellation. Null unless cancelled.
Registered customer UUID. Null for guest checkouts.
First name the buyer provided at checkout.
Last name the buyer provided at checkout.
Buyer email, if provided.
Buyer phone in E.164 format (e.g. +51999100001), if provided.
Personal ID document type (e.g. DNI). Null if not collected.
Personal ID document number. Null if not collected.
Invoice document type requested by the buyer. Null if no invoice.
Tax ID for the invoice (e.g. RUC). Null if no invoice.
Legal name for the invoice. Null if no invoice.
Fiscal address for the invoice. Null if no invoice.
DELIVERY (ship to address) or PICKUP (collect at a location).
DELIVERY, PICKUP, null Shipping method name chosen at checkout, snapshotted.
Primary delivery street address. Set for DELIVERY orders.
Secondary address line (apartment, reference). Optional.
Broadest administrative division of the delivery address (e.g. departamento in Peru). Set for DELIVERY orders.
Second administrative division (e.g. provincia in Peru). Null when the country uses fewer levels.
Third administrative division (e.g. distrito in Peru). Null when the country uses fewer levels.
Fourth administrative division. Null when the country uses fewer levels.
UUID of the customer's saved address this delivery snapshot was copied from. Null for guest or one-off addresses. The snapshot fields stay frozen even if that address later changes.
Confirmed drop-off point for the delivery. Null when the buyer didn't pin one.
Person receiving the delivery, if different from the buyer.
Recipient phone in E.164 format, if provided.
Free-text delivery notes from the buyer.
Resolved pickup location name. Set for PICKUP orders.
Preparation state, forward-only: UNFULFILLED → IN_PROGRESS → FULFILLED → DELIVERED.
UNFULFILLED, IN_PROGRESS, FULFILLED, DELIVERED Carrier handling the shipment. Delivery orders only.
Carrier tracking/guide number. Delivery orders only.
URL to track the shipment. Delivery orders only.
When the order entered IN_PROGRESS. Null until preparation starts.
"2026-06-30T14:12:00Z"
When the order reached FULFILLED (dispatched). Null until then.
"2026-06-30T14:12:00Z"
When the order reached DELIVERED. Null until delivered.
"2026-06-30T14:12:00Z"
Payment method label chosen at checkout.
Buyer-supplied reconciliation reference (transfer/voucher id).
When payment was recorded. Null while unpaid.
"2026-06-30T14:12:00Z"
Amount recorded as paid so far.
"1234.56"
ISO 4217 currency code for all money fields.
"USD"
Net of everything (goods + shipping), post-discount. Equals total − taxTotal. subtotal + taxTotal = total in both tax modes.
"1234.56"
Aggregate of all taxes on the order.
"1234.56"
Shipping charge as the buyer saw it. Informational — already reflected in subtotal/total; not an addend.
"1234.56"
Goods + order discount as the buyer saw it. Informational; not an addend. Shipping discounts surface as a reduced shippingTotal plus a SHIPPING promotion.
"1234.56"
Amount owed: subtotal + taxTotal.
"1234.56"
Applied promotions on the order, including SHIPPING-class ones.
Line items in the order, in stable display order. Array position is the line's order — there is no separate position field.