curl -X POST https://app.fire.rest/api/v2/external/orders \
-H "x-api-key: $FIRE_API_KEY" \
-H "anonymous_customer_uid: device-session-0001" \
-H "Content-Type: application/json" \
-d '{
"order_code": "BR-K000-05-1793063248",
"vendor_uid": "11.6.1350",
"catalog_uid": "5",
"status": "COMPLETED",
"payment_status": "SUCCEEDED",
"channel": { "uid": "c784d4ba-23c7-4929-b2f0-1a1960d9cdc2", "code": "KIOSK" },
"service": { "uid": "726c4892-48b9-45da-b066-2a8e83d2cb78", "code": "Dine-In" },
"store": { "uid": "11.6.1350.50", "code": "K000", "name": "Tienda demo", "vendor_uid": "11.6.1350", "vendor_name": "Vendor demo" },
"fulfillment": { "method": "KIOSK", "catalog_uid": "5", "details": { "buzzer_name": "Cliente" } },
"customer": { "uid": "device-session-0001", "name": "CONSUMIDOR", "last_name": "FINAL", "phone": "" },
"metadata": { "display_code": "48K" },
"order_lines": [{
"hash": "hash_0",
"item_id": "7abdd4e5-d685-43ff-ba79-5e8b2f700b5b",
"item_description": "12 Tiras de Frango",
"item_type": "PRODUCT",
"quantity": "1",
"selected_currency": "BRL",
"vendor_uid": "11.6.1350",
"store_uid": "11.6.1350.50",
"fulfillment": { "method": "KIOSK", "catalog_uid": "5" },
"price": { "unit_price": [{ "currency_code": "BRL", "gross_price": "64.9", "net_price": "64.9", "taxes": [], "taxes_value": "0", "discount_value": "0", "subtotal_before_taxes": "64.9", "discounts": [] }] },
"modifier_groups": []
}],
"payment_methods": [{
"uid": "80242d0c-3bdd-4e8a-8ec2-eb250230b4e9",
"method": "CREDIT",
"currency_code": "BRL",
"total": "64.9",
"details": { "processor": "Tarjeta", "transaction_status": "APPROVED", "transaction_type": "CREDIT", "transaction_id": "BR-K000-05-1793063248", "tid": "TF000000", "authorization_code": "0000000000000", "total_bill": "64.9", "currency_code": "BRL", "exact_payment": false, "customer_cash_amount": "0", "mid": "", "voucher": "", "reference_number": "", "card": null, "acquirer": null, "transaction_date": { "date": "2026-10-26T22:08:00-03:00", "time_zone_name": "America/Sao_Paulo", "time_zone_type": "3" } }
}]
}'
curl -X POST https://app.fire.rest/api/v2/external/orders \
-H "x-api-key: $FIRE_API_KEY" \
-H "Content-Type: application/json" \
-d @ifood-order.json # mesmo corpo de "Injetar pedido"
{
"success": true,
"data": {
"id": "6f1c2b9e-3a1d-4c55-9b7e-0d2f6a7c8e10",
"external_order_id": "BR-K000-05-1793063248",
"status": "COMPLETED",
"payment_status": "SUCCEEDED",
"business_day_date": "2026-10-26",
"created_at": "2026-10-27T01:08:00.405Z"
}
}
{
"success": false,
"error": "CONFLICT",
"code": "DUPLICATE_ORDER",
"message": "Order with external id BR-K000-05-1793063248 already exists for this vendor.",
"data": { "id": "6f1c2b9e-3a1d-4c55-9b7e-0d2f6a7c8e10", "externalOrderId": "BR-K000-05-1793063248", "status": "COMPLETED" }
}
{
"success": false,
"error": "VALIDATION_ERROR",
"message": "Datos de entrada inválidos",
"details": [{ "code": "custom", "path": [], "message": "customer_uid or anonymous_customer_uid is required" }]
}
API
Criar pedido (v2)
Cria um pedido no Fire a partir do PDV, do quiosque ou de um integrador de agregadores, com a mesma estrutura de pedido que já enviam hoje.
POST
/
api
/
v2
/
external
/
orders
curl -X POST https://app.fire.rest/api/v2/external/orders \
-H "x-api-key: $FIRE_API_KEY" \
-H "anonymous_customer_uid: device-session-0001" \
-H "Content-Type: application/json" \
-d '{
"order_code": "BR-K000-05-1793063248",
"vendor_uid": "11.6.1350",
"catalog_uid": "5",
"status": "COMPLETED",
"payment_status": "SUCCEEDED",
"channel": { "uid": "c784d4ba-23c7-4929-b2f0-1a1960d9cdc2", "code": "KIOSK" },
"service": { "uid": "726c4892-48b9-45da-b066-2a8e83d2cb78", "code": "Dine-In" },
"store": { "uid": "11.6.1350.50", "code": "K000", "name": "Tienda demo", "vendor_uid": "11.6.1350", "vendor_name": "Vendor demo" },
"fulfillment": { "method": "KIOSK", "catalog_uid": "5", "details": { "buzzer_name": "Cliente" } },
"customer": { "uid": "device-session-0001", "name": "CONSUMIDOR", "last_name": "FINAL", "phone": "" },
"metadata": { "display_code": "48K" },
"order_lines": [{
"hash": "hash_0",
"item_id": "7abdd4e5-d685-43ff-ba79-5e8b2f700b5b",
"item_description": "12 Tiras de Frango",
"item_type": "PRODUCT",
"quantity": "1",
"selected_currency": "BRL",
"vendor_uid": "11.6.1350",
"store_uid": "11.6.1350.50",
"fulfillment": { "method": "KIOSK", "catalog_uid": "5" },
"price": { "unit_price": [{ "currency_code": "BRL", "gross_price": "64.9", "net_price": "64.9", "taxes": [], "taxes_value": "0", "discount_value": "0", "subtotal_before_taxes": "64.9", "discounts": [] }] },
"modifier_groups": []
}],
"payment_methods": [{
"uid": "80242d0c-3bdd-4e8a-8ec2-eb250230b4e9",
"method": "CREDIT",
"currency_code": "BRL",
"total": "64.9",
"details": { "processor": "Tarjeta", "transaction_status": "APPROVED", "transaction_type": "CREDIT", "transaction_id": "BR-K000-05-1793063248", "tid": "TF000000", "authorization_code": "0000000000000", "total_bill": "64.9", "currency_code": "BRL", "exact_payment": false, "customer_cash_amount": "0", "mid": "", "voucher": "", "reference_number": "", "card": null, "acquirer": null, "transaction_date": { "date": "2026-10-26T22:08:00-03:00", "time_zone_name": "America/Sao_Paulo", "time_zone_type": "3" } }
}]
}'
curl -X POST https://app.fire.rest/api/v2/external/orders \
-H "x-api-key: $FIRE_API_KEY" \
-H "Content-Type: application/json" \
-d @ifood-order.json # mesmo corpo de "Injetar pedido"
{
"success": true,
"data": {
"id": "6f1c2b9e-3a1d-4c55-9b7e-0d2f6a7c8e10",
"external_order_id": "BR-K000-05-1793063248",
"status": "COMPLETED",
"payment_status": "SUCCEEDED",
"business_day_date": "2026-10-26",
"created_at": "2026-10-27T01:08:00.405Z"
}
}
{
"success": false,
"error": "CONFLICT",
"code": "DUPLICATE_ORDER",
"message": "Order with external id BR-K000-05-1793063248 already exists for this vendor.",
"data": { "id": "6f1c2b9e-3a1d-4c55-9b7e-0d2f6a7c8e10", "externalOrderId": "BR-K000-05-1793063248", "status": "COMPLETED" }
}
{
"success": false,
"error": "VALIDATION_ERROR",
"message": "Datos de entrada inválidos",
"details": [{ "code": "custom", "path": [], "message": "customer_uid or anonymous_customer_uid is required" }]
}
Cria um pedido no Fire. O PDV, o quiosque e os integradores de agregadores o usam para
enviar suas vendas diretamente ao Fire, sem mudar o corpo que já montam hoje: mudam apenas a URL,
a credencial e a forma de ler a resposta.
Esta é a versão 2: recebe a estrutura de pedidos de PDV e quiosque e a de agregadores. Se o seu
sistema já envia os pedidos no formato Fire, use Criar pedido (v1).
As duas versões estão vigentes e terminam no mesmo lugar: mesmas validações, mesma resposta.
O Fire reconhece o tipo de pedido pelo
channel.uid do corpo:
- Se o canal é de um agregador (iFood, 99Food, Keeta, Rappi), o corpo é o de Injetar pedido (camelCase, com preços e totais).
- Qualquer outro canal (PDV, quiosque) usa a estrutura de PDV e quiosque descrita abaixo (snake_case, só com o preço unitário: o Fire calcula os totais).
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 a um vendor: a conta do pedido vem desse vendor. Uma key sem vendor
é rejeitada com 403. Não é preciso enviar o header account; se chegar, é ignorado.Identidade do cliente (PDV e quiosque)
Envie exatamente um destes dois headers. Se não enviar nenhum, ou enviar os dois, o pedido é rejeitado com400 VALIDATION_ERROR. Pedidos de agregadores não os usam.
string
Identificador da sessão anônima do equipamento (PDV ou quiosque). É o caso habitual.
string
Identificador de um cliente registrado.
Corpo — PDV e quiosque
string
obrigatório
Código único do pedido no seu sistema. Se já existir um pedido com esse código para o seu vendor,
a resposta é
409.string
obrigatório
Vendor do pedido (ex.:
11.6.1350).string
obrigatório
Catálogo do canal de venda.
string
COMPLETED se a venda já está fechada; OPEN se ainda aguarda cobrança. Um pedido que não chega
COMPLETED + SUCCEEDED fica pendente de pagamento.string
SUCCEEDED se já foi cobrado.object
obrigatório
object
obrigatório
object
obrigatório
object
obrigatório
object
Equipamento que registrou a venda:
uid, name, metadata.object
Caixa ou operador:
uid, name, session (uid, start_timestamp, end_timestamp).
null no quiosque.object
Dados do cliente:
uid, name, last_name, phone (obrigatórios se você enviar o objeto),
email, gov_id_type, gov_id_number.object
Dados de faturamento:
gov_id_type, gov_id_number, business_name.object
Dados adicionais da venda, ex.:
display_code (número para chamar o pedido) e os dados do
quiosque ou do PDV.object[]
obrigatório
Produtos do pedido.
Mostrar order_lines[]
Mostrar order_lines[]
string
obrigatório
Identificador da linha dentro do pedido.
string
obrigatório
UID do produto no catálogo.
string
obrigatório
Nome do produto.
string
obrigatório
Tipo de item (ex.:
PRODUCT).string
obrigatório
Quantidade, como texto (
"1").string
obrigatório
Moeda (ex.:
BRL).string
obrigatório
Vendor.
string
obrigatório
Loja.
object
obrigatório
method e catalog_uid, como no pedido.object
obrigatório
Só o preço unitário:
unit_price[] com currency_code, gross_price, net_price, taxes,
taxes_value, discount_value, subtotal_before_taxes e discounts. Os valores vão como
texto ("14.9"). O Fire calcula o total da linha e do pedido.object[]
obrigatório
Grupos de modificadores (
uid, description, selected_modifiers[]). Cada modificador tem a
mesma forma de uma linha. [] se não houver.object
Códigos do produto, ex.:
code, external_code, ncm.object[]
obrigatório
Pagamentos do pedido.
Mostrar payment_methods[]
Mostrar payment_methods[]
string
obrigatório
UID do meio de pagamento.
string
obrigatório
Meio de pagamento (ex.:
CASH, CREDIT, DEBIT).string
obrigatório
Moeda.
string
obrigatório
Valor pago, como texto.
object
Detalhe da transação:
processor, transaction_status (APPROVED, PENDING),
transaction_type, transaction_id, tid, authorization_code, total_bill,
customer_cash_amount, change_amount, card, acquirer, transaction_date. Um pagamento
PENDING deixa o pedido aberto, aguardando cobrança.object
Dados do autorizador do pagamento.
Corpo — agregadores
O mesmo corpo de Injetar pedido, sem mudanças. O Fire o identifica como pedido de agregador pelochannel.uid e o registra fechado e pago.
Resposta
boolean
true quando o pedido foi criado.object
Erros
| HTTP | error / code | Quando |
|---|---|---|
400 | VALIDATION_ERROR | Falta o código do pedido, o corpo não pode ser lido (PDV e quiosque: details[] detalha cada problema; agregadores: a mensagem diz o que falta), os headers de cliente faltam ou vieram os dois, ou o canal não está habilitado para o seu vendor |
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 a um vendor |
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/v2/external/orders \
-H "x-api-key: $FIRE_API_KEY" \
-H "anonymous_customer_uid: device-session-0001" \
-H "Content-Type: application/json" \
-d '{
"order_code": "BR-K000-05-1793063248",
"vendor_uid": "11.6.1350",
"catalog_uid": "5",
"status": "COMPLETED",
"payment_status": "SUCCEEDED",
"channel": { "uid": "c784d4ba-23c7-4929-b2f0-1a1960d9cdc2", "code": "KIOSK" },
"service": { "uid": "726c4892-48b9-45da-b066-2a8e83d2cb78", "code": "Dine-In" },
"store": { "uid": "11.6.1350.50", "code": "K000", "name": "Tienda demo", "vendor_uid": "11.6.1350", "vendor_name": "Vendor demo" },
"fulfillment": { "method": "KIOSK", "catalog_uid": "5", "details": { "buzzer_name": "Cliente" } },
"customer": { "uid": "device-session-0001", "name": "CONSUMIDOR", "last_name": "FINAL", "phone": "" },
"metadata": { "display_code": "48K" },
"order_lines": [{
"hash": "hash_0",
"item_id": "7abdd4e5-d685-43ff-ba79-5e8b2f700b5b",
"item_description": "12 Tiras de Frango",
"item_type": "PRODUCT",
"quantity": "1",
"selected_currency": "BRL",
"vendor_uid": "11.6.1350",
"store_uid": "11.6.1350.50",
"fulfillment": { "method": "KIOSK", "catalog_uid": "5" },
"price": { "unit_price": [{ "currency_code": "BRL", "gross_price": "64.9", "net_price": "64.9", "taxes": [], "taxes_value": "0", "discount_value": "0", "subtotal_before_taxes": "64.9", "discounts": [] }] },
"modifier_groups": []
}],
"payment_methods": [{
"uid": "80242d0c-3bdd-4e8a-8ec2-eb250230b4e9",
"method": "CREDIT",
"currency_code": "BRL",
"total": "64.9",
"details": { "processor": "Tarjeta", "transaction_status": "APPROVED", "transaction_type": "CREDIT", "transaction_id": "BR-K000-05-1793063248", "tid": "TF000000", "authorization_code": "0000000000000", "total_bill": "64.9", "currency_code": "BRL", "exact_payment": false, "customer_cash_amount": "0", "mid": "", "voucher": "", "reference_number": "", "card": null, "acquirer": null, "transaction_date": { "date": "2026-10-26T22:08:00-03:00", "time_zone_name": "America/Sao_Paulo", "time_zone_type": "3" } }
}]
}'
curl -X POST https://app.fire.rest/api/v2/external/orders \
-H "x-api-key: $FIRE_API_KEY" \
-H "Content-Type: application/json" \
-d @ifood-order.json # mesmo corpo de "Injetar pedido"
{
"success": true,
"data": {
"id": "6f1c2b9e-3a1d-4c55-9b7e-0d2f6a7c8e10",
"external_order_id": "BR-K000-05-1793063248",
"status": "COMPLETED",
"payment_status": "SUCCEEDED",
"business_day_date": "2026-10-26",
"created_at": "2026-10-27T01:08:00.405Z"
}
}
{
"success": false,
"error": "CONFLICT",
"code": "DUPLICATE_ORDER",
"message": "Order with external id BR-K000-05-1793063248 already exists for this vendor.",
"data": { "id": "6f1c2b9e-3a1d-4c55-9b7e-0d2f6a7c8e10", "externalOrderId": "BR-K000-05-1793063248", "status": "COMPLETED" }
}
{
"success": false,
"error": "VALIDATION_ERROR",
"message": "Datos de entrada inválidos",
"details": [{ "code": "custom", "path": [], "message": "customer_uid or anonymous_customer_uid is required" }]
}