Skip to main content
GET
Get order by ID

Autorizaciones

X-API-Key
string
header
requerido

Merchant API key for authentication

Parámetros de ruta

order_id
integer
requerido

Unique order identifier

Respuesta

Successful Response

id
integer
requerido

Unique order identifier

order_date
string<date-time>
requerido

Date and time when the order was placed (merchant's local timezone)

payment_method
string
requerido

Payment method used

Ejemplo:

"credit_card"

currency
enum<string>
requerido

Currency code (ISO 4217)

Opciones disponibles:
MXN,
PEN,
COP,
CLP,
ARS,
BRL,
VES,
BOB,
USD,
PYG,
UYU,
CRC,
EUR,
GTQ
Ejemplo:

"PEN"

total_amount
string
requerido

Total order amount including delivery fee

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Ejemplo:

139.7

customer
OrderCustomer · object
requerido

Customer information

address
OrderAddress · object | null
requerido

Delivery address (null when the goods were handed over in person, as in a store or phone sale)

items
OrderItem · object[]
requerido

Line items in the order. Empty while the order was recorded only from a payment receipt or a merchant's mark; it gains lines later under the same id.

status
enum<string> | null

Current order status

Opciones disponibles:
pending,
confirmed,
preparing,
ready_for_dispatch,
dispatched,
delivered,
completed,
rejected,
cancelled
Ejemplo:

"pending"

payment_terms
enum<string> | null

Payment terms for the order

Opciones disponibles:
pending,
partial,
paid,
paid_pending_review,
cash_on_delivery
Ejemplo:

"paid"

pending_amount
string | null

Amount still pending payment (null if fully paid)

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Ejemplo:

0

delivery_fee
string | null

Delivery fee charged to the customer

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Ejemplo:

10

payment_receipt_urls
string[]

URLs of payment receipt images uploaded by the customer (e.g. Yape, Plin vouchers)

summary_conversation
string | null

AI-generated summary of the sales conversation with product details and customer preferences