GET https://api.fire.rest/api/v1/fire/external/orders/7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f?fields=id,orderCode,status,orderLines,totals
x-api-key: <tu_api_key>
{
"id": "7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
"orderCode": "OC-1024",
"status": "COMPLETED",
"orderLines": [
{ "productId": "p1", "quantity": 2 }
],
"totals": [
{ "currencyCode": "USD", "total": 125000 }
]
}
{
"orderCode": "OC-1024",
"status": "OPEN",
"settlement": {
"status": "recorded",
"origin": "ledger",
"paidSoFar": "200000",
"total": "359000",
"currencyCode": "BRL",
"tenderCount": 1,
"declinedCount": 0,
"amountMismatch": true
},
"payments": [
{
"status": "approved",
"amount": "200000",
"currencyCode": "BRL",
"method": "CASH",
"transactionId": "POS-0001",
"occurredAt": "2026-07-30T16:20:04.000Z"
}
]
}
{
"success": false,
"error": "CONFLICT",
"message": "External order id ORD-77 matches 2 orders across vendors; cannot disambiguate"
}
{
"success": false,
"error": "NOT_FOUND",
"message": "Order not found with ID 7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f"
}
API
Obtener orden
Lee una orden puntual por cualquiera de sus referencias, con projection de campos. La orden debe pertenecer al account y vendor de tu API key.
GET
/
api
/
v1
/
fire
/
external
/
orders
/
{orderId}
GET https://api.fire.rest/api/v1/fire/external/orders/7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f?fields=id,orderCode,status,orderLines,totals
x-api-key: <tu_api_key>
{
"id": "7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
"orderCode": "OC-1024",
"status": "COMPLETED",
"orderLines": [
{ "productId": "p1", "quantity": 2 }
],
"totals": [
{ "currencyCode": "USD", "total": 125000 }
]
}
{
"orderCode": "OC-1024",
"status": "OPEN",
"settlement": {
"status": "recorded",
"origin": "ledger",
"paidSoFar": "200000",
"total": "359000",
"currencyCode": "BRL",
"tenderCount": 1,
"declinedCount": 0,
"amountMismatch": true
},
"payments": [
{
"status": "approved",
"amount": "200000",
"currencyCode": "BRL",
"method": "CASH",
"transactionId": "POS-0001",
"occurredAt": "2026-07-30T16:20:04.000Z"
}
]
}
{
"success": false,
"error": "CONFLICT",
"message": "External order id ORD-77 matches 2 orders across vendors; cannot disambiguate"
}
{
"success": false,
"error": "NOT_FOUND",
"message": "Order not found with ID 7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f"
}
Devuelve una orden proyectada según
fields. Si la orden no existe — o pertenece a otro tenant — la
respuesta es 404 (nunca se filtra la existencia entre tenants).
Autenticación
string
requerido
Tu API key de Fire con scope
orders:read. La key debe ser vendor-scoped — las keys sin
vendorId se rechazan con 403.Path params
string
requerido
Cualquiera de las tres referencias públicas de la orden:
No hace falta traducir: usa el id que ya conoces.
| referencia | qué es |
|---|---|
orders.id | el UUID interno de Fire |
order_external | el id que asignaste al crear la orden |
metadata.order_id | copia del id externo dentro de la orden |
Es el mismo conjunto de referencias que acepta Cancelar orden, así
que el id con el que creaste la orden te sirve también para leerla.
Query params
string
Projection — ver Projection de campos. Omitir
para devolver todos los campos.
Petición
GET https://api.fire.rest/api/v1/fire/external/orders/7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f?fields=id,orderCode,status,orderLines,totals
x-api-key: <tu_api_key>
Respuesta
Un objeto orden, proyectado segúnfields. Ver la lista completa de campos en
Projection de campos.
Para seguir una orden que se está cobrando por partes, pedí settlement (cuánto se cobró) y
payments (con qué) — ver
Progreso del cobro.
{
"id": "7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
"orderCode": "OC-1024",
"status": "COMPLETED",
"orderLines": [
{ "productId": "p1", "quantity": 2 }
],
"totals": [
{ "currencyCode": "USD", "total": 125000 }
]
}
{
"orderCode": "OC-1024",
"status": "OPEN",
"settlement": {
"status": "recorded",
"origin": "ledger",
"paidSoFar": "200000",
"total": "359000",
"currencyCode": "BRL",
"tenderCount": 1,
"declinedCount": 0,
"amountMismatch": true
},
"payments": [
{
"status": "approved",
"amount": "200000",
"currencyCode": "BRL",
"method": "CASH",
"transactionId": "POS-0001",
"occurredAt": "2026-07-30T16:20:04.000Z"
}
]
}
{
"success": false,
"error": "CONFLICT",
"message": "External order id ORD-77 matches 2 orders across vendors; cannot disambiguate"
}
{
"success": false,
"error": "NOT_FOUND",
"message": "Order not found with ID 7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f"
}
Relacionado
Listar órdenes
Lista todas las órdenes de tu account y vendor.
Listar órdenes de tienda
Lista las órdenes de una tienda específica.