curl -X POST https://app.fire.rest/api/v1/external/orders \
-H "x-api-key: $FIRE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"orderId": "ORD-000123",
"orderCode": "ORD-000123",
"accountId": 11,
"account": "",
"createdAt": "2026-10-29 14:57:41",
"selectedShippingMethod": "pickup",
"client": { "uid": "customer-0001", "name": "CONSUMIDOR", "lastName": "FINAL" },
"store": { "id": "11.6.1350.50", "code": "K000", "vendorId": "11.6.1350" },
"channel": { "uid": "c784d4ba-23c7-4929-b2f0-1a1960d9cdc2", "code": "KIOSK" },
"service": { "uid": "726c4892-48b9-45da-b066-2a8e83d2cb78", "code": "Dine-In" },
"order": {
"products": [{
"productId": "7abdd4e5-d685-43ff-ba79-5e8b2f700b5b",
"product": "12 Tiras de Frango",
"quantity": 1,
"price": {
"unitPrice": { "currencyCode": "BRL", "subtotalWithoutTaxes": 64.9, "taxValue": 0, "total": 64.9 },
"totalPrice": { "currencyCode": "BRL", "subtotalWithoutTaxes": 64.9, "taxValue": 0, "total": 64.9 }
},
"modifierGroups": []
}]
},
"payments": {
"totals": [{ "currencyCode": "BRL", "total": 64.9 }],
"paymentMethods": [{ "processor": "CREDIT", "currencyCode": "BRL", "transactionStatus": "APPROVED", "totalBill": 64.9 }]
}
}'
{
"success": true,
"data": {
"id": "6f1c2b9e-3a1d-4c55-9b7e-0d2f6a7c8e10",
"external_order_id": "ORD-000123",
"status": "COMPLETED",
"payment_status": "SUCCEEDED",
"business_day_date": "2026-10-29",
"created_at": "2026-10-29T14:57:44.330Z"
}
}
{
"success": false,
"error": "VALIDATION_ERROR",
"message": "orderCode is required and must be a non-empty string"
}
{
"success": false,
"error": "CONFLICT",
"code": "DUPLICATE_ORDER",
"message": "Order with external id ORD-000123 already exists for this vendor.",
"data": { "id": "6f1c2b9e-3a1d-4c55-9b7e-0d2f6a7c8e10", "externalOrderId": "ORD-000123", "status": "COMPLETED" }
}
API
Criar pedido (v1)
Cria um pedido no Fire enviando-o no formato Fire. Para a estrutura de PDV, quiosque e agregadores, use a versão 2.
POST
/
api
/
v1
/
external
/
orders
curl -X POST https://app.fire.rest/api/v1/external/orders \
-H "x-api-key: $FIRE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"orderId": "ORD-000123",
"orderCode": "ORD-000123",
"accountId": 11,
"account": "",
"createdAt": "2026-10-29 14:57:41",
"selectedShippingMethod": "pickup",
"client": { "uid": "customer-0001", "name": "CONSUMIDOR", "lastName": "FINAL" },
"store": { "id": "11.6.1350.50", "code": "K000", "vendorId": "11.6.1350" },
"channel": { "uid": "c784d4ba-23c7-4929-b2f0-1a1960d9cdc2", "code": "KIOSK" },
"service": { "uid": "726c4892-48b9-45da-b066-2a8e83d2cb78", "code": "Dine-In" },
"order": {
"products": [{
"productId": "7abdd4e5-d685-43ff-ba79-5e8b2f700b5b",
"product": "12 Tiras de Frango",
"quantity": 1,
"price": {
"unitPrice": { "currencyCode": "BRL", "subtotalWithoutTaxes": 64.9, "taxValue": 0, "total": 64.9 },
"totalPrice": { "currencyCode": "BRL", "subtotalWithoutTaxes": 64.9, "taxValue": 0, "total": 64.9 }
},
"modifierGroups": []
}]
},
"payments": {
"totals": [{ "currencyCode": "BRL", "total": 64.9 }],
"paymentMethods": [{ "processor": "CREDIT", "currencyCode": "BRL", "transactionStatus": "APPROVED", "totalBill": 64.9 }]
}
}'
{
"success": true,
"data": {
"id": "6f1c2b9e-3a1d-4c55-9b7e-0d2f6a7c8e10",
"external_order_id": "ORD-000123",
"status": "COMPLETED",
"payment_status": "SUCCEEDED",
"business_day_date": "2026-10-29",
"created_at": "2026-10-29T14:57:44.330Z"
}
}
{
"success": false,
"error": "VALIDATION_ERROR",
"message": "orderCode is required and must be a non-empty string"
}
{
"success": false,
"error": "CONFLICT",
"code": "DUPLICATE_ORDER",
"message": "Order with external id ORD-000123 already exists for this vendor.",
"data": { "id": "6f1c2b9e-3a1d-4c55-9b7e-0d2f6a7c8e10", "externalOrderId": "ORD-000123", "status": "COMPLETED" }
}
Cria um pedido no Fire com o corpo no formato Fire: o mesmo de
Injetar pedido, sem mudanças. O Fire não o traduz: valida e cria o
pedido diretamente.
Esta é a versão 1. Se o seu sistema envia os pedidos com a estrutura de PDV e quiosque ou com a
de agregadores, use Criar pedido (v2). As duas versões estão
vigentes e terminam no mesmo lugar: mesmas validações, mesma resposta.
Depois de criado, o pedido segue o mesmo ciclo de qualquer pedido do Fire: impostos, dia de
negócio, documento fiscal e eventos.
Autenticação
string
obrigatório
Sua API key do Fire com escopo
orders:write. Também é aceito Authorization: Bearer <api_key>.
A key deve estar associada à sua conta e a um vendor. Não é preciso enviar o header account.Corpo
O corpo é o de Injetar pedido, no formato Fire (camelCase, com preços e totais). Os campos mínimos são:string
obrigatório
Identificador do pedido no seu sistema.
string
obrigatório
Código único do pedido. Se já existir um pedido com esse código para o seu vendor, a resposta é
409.number
obrigatório
Conta do pedido.
string
obrigatório
Data da venda.
string
obrigatório
delivery ou pickup.object
obrigatório
Cliente:
uid, name, lastName.object
obrigatório
Loja:
id, code, vendorId.object
obrigatório
products[] com pelo menos um produto.object
obrigatório
totals[] e paymentMethods[], com pelo menos um item cada. O transactionStatus dos pagamentos
decide se o pedido fica fechado (APPROVED) ou aberto, pendente de cobrança (PENDING).Resposta
boolean
true quando o pedido foi criado.object
Erros
| HTTP | error / code | Quando |
|---|---|---|
400 | VALIDATION_ERROR | Falta orderCode ou o corpo não está no formato Fire |
400 | BUSINESS_ERROR | Loja inativa, dia de negócio fechado, ou o pedido não cumpre uma regra de validação ativada para o seu vendor (ORDER_INVARIANT_VIOLATION) |
404 | NOT_FOUND | A loja não existe |
401 | UNAUTHORIZED | API key inválida, vencida ou revogada |
403 | FORBIDDEN | API key sem escopo orders:write ou não associada à sua conta |
409 | CONFLICT / DUPLICATE_ORDER | O pedido já existia para o seu vendor. data traz id, externalOrderId e status do existente |
Toda requisição fica registrada no Fire com o corpo e o motivo da rejeição, inclusive as
rejeitadas. Se você reenviar um pedido que já foi criado, a resposta é
409 e ele não é duplicado.curl -X POST https://app.fire.rest/api/v1/external/orders \
-H "x-api-key: $FIRE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"orderId": "ORD-000123",
"orderCode": "ORD-000123",
"accountId": 11,
"account": "",
"createdAt": "2026-10-29 14:57:41",
"selectedShippingMethod": "pickup",
"client": { "uid": "customer-0001", "name": "CONSUMIDOR", "lastName": "FINAL" },
"store": { "id": "11.6.1350.50", "code": "K000", "vendorId": "11.6.1350" },
"channel": { "uid": "c784d4ba-23c7-4929-b2f0-1a1960d9cdc2", "code": "KIOSK" },
"service": { "uid": "726c4892-48b9-45da-b066-2a8e83d2cb78", "code": "Dine-In" },
"order": {
"products": [{
"productId": "7abdd4e5-d685-43ff-ba79-5e8b2f700b5b",
"product": "12 Tiras de Frango",
"quantity": 1,
"price": {
"unitPrice": { "currencyCode": "BRL", "subtotalWithoutTaxes": 64.9, "taxValue": 0, "total": 64.9 },
"totalPrice": { "currencyCode": "BRL", "subtotalWithoutTaxes": 64.9, "taxValue": 0, "total": 64.9 }
},
"modifierGroups": []
}]
},
"payments": {
"totals": [{ "currencyCode": "BRL", "total": 64.9 }],
"paymentMethods": [{ "processor": "CREDIT", "currencyCode": "BRL", "transactionStatus": "APPROVED", "totalBill": 64.9 }]
}
}'
{
"success": true,
"data": {
"id": "6f1c2b9e-3a1d-4c55-9b7e-0d2f6a7c8e10",
"external_order_id": "ORD-000123",
"status": "COMPLETED",
"payment_status": "SUCCEEDED",
"business_day_date": "2026-10-29",
"created_at": "2026-10-29T14:57:44.330Z"
}
}
{
"success": false,
"error": "VALIDATION_ERROR",
"message": "orderCode is required and must be a non-empty string"
}
{
"success": false,
"error": "CONFLICT",
"code": "DUPLICATE_ORDER",
"message": "Order with external id ORD-000123 already exists for this vendor.",
"data": { "id": "6f1c2b9e-3a1d-4c55-9b7e-0d2f6a7c8e10", "externalOrderId": "ORD-000123", "status": "COMPLETED" }
}