Skip to main content
POST
Cancel an order

Autorizaciones

Authorization
string
header
requerido

Public API key presented as Authorization: Bearer rq_live_….

Parámetros de ruta

id
string<uuid>
requerido
Ejemplo:

"0b2e9f5a-1c3d-4e6f-8a9b-0c1d2e3f4a5b"

Respuesta

The updated order.

id
string
requerido

Order UUID. Stable primary key; use it for lookups.

number
integer
requerido

Per-organization sequential order number (shown as #123).

Ejemplo:

1042

status
enum<string>
requerido

Lifecycle status: PLACED or CANCELLED.

Opciones disponibles:
PLACED,
CANCELLED
paymentStatus
enum<string>
requerido

Payment state: UNPAID, PARTIALLY_PAID, PAID, or ERROR.

Opciones disponibles:
UNPAID,
PARTIALLY_PAID,
PAID,
ERROR
source
enum<string>
requerido

Channel the order came from (currently always STOREFRONT).

Opciones disponibles:
STOREFRONT,
PURCHASE_ORDER
createdAt
string
requerido

When the order record was created.

Ejemplo:

"2026-06-30T14:12:00Z"

updatedAt
string
requerido

When the order was last modified. Use as the watermark for incremental sync.

Ejemplo:

"2026-06-30T14:12:00Z"

placedAt
string | null
requerido

When the customer placed the order. Null until placed.

Ejemplo:

"2026-06-30T14:12:00Z"

cancelledAt
string | null
requerido

When the order was cancelled. Null unless status is CANCELLED.

Ejemplo:

"2026-06-30T14:12:00Z"

cancelReason
string | null
requerido

Reason code for cancellation. Null unless cancelled.

customerId
string | null
requerido

Registered customer UUID. Null for guest checkouts.

buyerFirstName
string
requerido

First name the buyer provided at checkout.

buyerLastName
string
requerido

Last name the buyer provided at checkout.

buyerEmail
string | null
requerido

Buyer email, if provided.

buyerPhone
string | null
requerido

Buyer phone in E.164 format (e.g. +51999100001), if provided.

documentType
string | null
requerido

Personal ID document type (e.g. DNI). Null if not collected.

documentNumber
string | null
requerido

Personal ID document number. Null if not collected.

fiscalDocumentType
string | null
requerido

Invoice document type requested by the buyer. Null if no invoice.

fiscalDocumentNumber
string | null
requerido

Tax ID for the invoice (e.g. RUC). Null if no invoice.

Legal name for the invoice. Null if no invoice.

fiscalAddressLine
string | null
requerido

Fiscal address for the invoice. Null if no invoice.

shippingType
enum<string> | null
requerido

DELIVERY (ship to address) or PICKUP (collect at a location).

Opciones disponibles:
DELIVERY,
PICKUP,
null
shippingMethodLabel
string | null
requerido

Shipping method name chosen at checkout, snapshotted.

deliveryAddressLine1
string | null
requerido

Primary delivery street address. Set for DELIVERY orders.

deliveryAddressLine2
string | null
requerido

Secondary address line (apartment, reference). Optional.

deliveryGeoLevel1
string | null
requerido

Broadest administrative division of the delivery address (e.g. departamento in Peru). Set for DELIVERY orders.

deliveryGeoLevel2
string | null
requerido

Second administrative division (e.g. provincia in Peru). Null when the country uses fewer levels.

deliveryGeoLevel3
string | null
requerido

Third administrative division (e.g. distrito in Peru). Null when the country uses fewer levels.

deliveryGeoLevel4
string | null
requerido

Fourth administrative division. Null when the country uses fewer levels.

deliveryAddressId
string | null
requerido

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.

deliveryCoordinates
object | null
requerido

Confirmed drop-off point for the delivery. Null when the buyer didn't pin one.

recipientName
string | null
requerido

Person receiving the delivery, if different from the buyer.

recipientPhone
string | null
requerido

Recipient phone in E.164 format, if provided.

deliveryInstructions
string | null
requerido

Free-text delivery notes from the buyer.

pickupLocationName
string | null
requerido

Resolved pickup location name. Set for PICKUP orders.

fulfillmentStatus
enum<string>
requerido

Preparation state, forward-only: UNFULFILLEDIN_PROGRESSFULFILLEDDELIVERED.

Opciones disponibles:
UNFULFILLED,
IN_PROGRESS,
FULFILLED,
DELIVERED
shippingCarrier
string | null
requerido

Carrier handling the shipment. Delivery orders only.

trackingNumber
string | null
requerido

Carrier tracking/guide number. Delivery orders only.

trackingUrl
string | null
requerido

URL to track the shipment. Delivery orders only.

preparingAt
string | null
requerido

When the order entered IN_PROGRESS. Null until preparation starts.

Ejemplo:

"2026-06-30T14:12:00Z"

fulfilledAt
string | null
requerido

When the order reached FULFILLED (dispatched). Null until then.

Ejemplo:

"2026-06-30T14:12:00Z"

deliveredAt
string | null
requerido

When the order reached DELIVERED. Null until delivered.

Ejemplo:

"2026-06-30T14:12:00Z"

paymentMethod
string | null
requerido

Payment method label chosen at checkout.

paymentReference
string | null
requerido

Buyer-supplied reconciliation reference (transfer/voucher id).

paidAt
string | null
requerido

When payment was recorded. Null while unpaid.

Ejemplo:

"2026-06-30T14:12:00Z"

amountPaid
string
requerido

Amount recorded as paid so far.

Ejemplo:

"1234.56"

currencyCode
string
requerido

ISO 4217 currency code for all money fields.

Ejemplo:

"USD"

subtotal
string
requerido

Net of everything (goods + shipping), post-discount. Equals total − taxTotal. subtotal + taxTotal = total in both tax modes.

Ejemplo:

"1234.56"

taxTotal
string
requerido

Aggregate of all taxes on the order.

Ejemplo:

"1234.56"

shippingTotal
string
requerido

Shipping charge as the buyer saw it. Informational — already reflected in subtotal/total; not an addend.

Ejemplo:

"1234.56"

discountTotal
string
requerido

Goods + order discount as the buyer saw it. Informational; not an addend. Shipping discounts surface as a reduced shippingTotal plus a SHIPPING promotion.

Ejemplo:

"1234.56"

total
string
requerido

Amount owed: subtotal + taxTotal.

Ejemplo:

"1234.56"

promotions
object[]
requerido

Applied promotions on the order, including SHIPPING-class ones.

items
object[]
requerido

Line items in the order, in stable display order. Array position is the line's order — there is no separate position field.