GET https://api.fire.rest/api/v1/fire/external/orders/7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f?fields=id,orderCode,status,orderLines,totals
x-api-key: <sua_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
Obter pedido
Leia um pedido por qualquer uma de suas referências, com projeção de campos. O pedido deve pertencer ao account e vendor da sua 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: <sua_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"
}
Retorna um pedido projetado conforme
fields. Se o pedido não existe — ou pertence a outro tenant —
a resposta é 404 (a existência nunca é vazada entre tenants).
Autenticação
string
obrigatório
Sua API key do Fire com scope
orders:read. A key deve ser vendor-scoped — keys sem vendorId
são rejeitadas com 403.Path params
string
obrigatório
Qualquer uma das três referências públicas do pedido:
Não precisa traduzir: use o id que você já conhece.
| referência | o que é |
|---|---|
orders.id | o UUID interno do Fire |
order_external | o id que você atribuiu ao criar o pedido |
metadata.order_id | cópia do id externo dentro do pedido |
É o mesmo conjunto de referências aceito por Cancelar pedido, então
o id com que você criou o pedido também serve para lê-lo.
Query params
string
Projeção — veja Projeção de campos. Omita para
retornar todos os campos.
Requisição
GET https://api.fire.rest/api/v1/fire/external/orders/7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f?fields=id,orderCode,status,orderLines,totals
x-api-key: <sua_api_key>
Resposta
Um objeto pedido, projetado conformefields. Veja a lista completa de campos em
Projeção de campos.
Para acompanhar um pedido que está sendo cobrado em partes, peça settlement (quanto já entrou) e
payments (com o quê) — veja
Progresso da cobrança.
{
"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 pedidos
Lista todos os pedidos do seu account e vendor.
Listar pedidos da loja
Lista os pedidos de uma loja específica.