Crear orden (v2) - Fire Docs

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   # mismo cuerpo que en "Inyectar orden"

{
  "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" }]
}

POST

api

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   # mismo cuerpo que en "Inyectar orden"

{
  "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" }]
}

Crea una orden en Fire. Lo usan la caja, el kiosco y los integradores de agregadores para enviar sus ventas directamente a Fire, sin cambiar el cuerpo que ya arman hoy: solo cambian la URL, la credencial y la forma de leer la respuesta. Esta es la versión 2: recibe la estructura de órdenes de caja y kiosco y la de agregadores. Si tu sistema ya envía las órdenes en formato Fire, usa Crear orden (v1). Las dos versiones están vigentes y terminan en el mismo lugar: mismas validaciones, misma respuesta. Fire reconoce de qué tipo de orden se trata por el channel.uid del cuerpo:

Si el canal es de un agregador (iFood, 99Food, Keeta, Rappi), el cuerpo es el de Inyectar orden (camelCase, con precios y totales).
Cualquier otro canal (caja, kiosco) usa la estructura de caja y kiosco que se describe abajo (snake_case, solo con el precio unitario: Fire calcula los totales).

Una vez creada, la orden sigue el mismo ciclo que cualquier orden de Fire: impuestos, día de negocio, documento fiscal y eventos.

Autenticación

string

requerido

Tu API key de Fire con scope orders:write. También se acepta Authorization: Bearer <api_key>. La key debe estar asociada a un vendor: la cuenta de la orden sale de ese vendor. Una key sin vendor se rechaza con 403. No hace falta enviar el header account; si llega, se ignora.

Identidad del cliente (caja y kiosco)

Envía exactamente uno de estos dos headers. Si no envías ninguno, o envías los dos, la orden se rechaza con 400 VALIDATION_ERROR. Las órdenes de agregadores no los usan.

string

Identificador de la sesión anónima del equipo (caja o kiosco). Es el caso habitual.

string

Identificador de un cliente registrado.

Cuerpo — caja y kiosco

string

requerido

Código único de la orden en tu sistema. Si ya existe una orden con ese código para tu vendor, la respuesta es 409.

string

requerido

Vendor de la orden (p. ej. 11.6.1350).

string

requerido

Catálogo del canal de venta.

string

COMPLETED si la venta ya está cerrada; OPEN si queda pendiente de cobro. Una orden que no llega COMPLETED + SUCCEEDED queda pendiente de pago.

string

SUCCEEDED si ya está cobrada.

object

requerido

Canal de venta. Su uid decide cómo se interpreta el cuerpo.

Mostrar channel

string

requerido

UID del canal en Fire.

string

requerido

Código del canal (p. ej. POS, KIOSK).

object

requerido

Servicio de la venta.

Mostrar service

string

requerido

UID del servicio en Fire.

string

requerido

Código del servicio (p. ej. Dine-In, Takeaway).

object

requerido

Tienda de la venta.

Mostrar store

string

requerido

UID de la tienda.

string

requerido

Código de la tienda.

string

requerido

Nombre de la tienda.

string

requerido

Vendor de la tienda.

string

requerido

Nombre del vendor.

object

requerido

Forma de entrega y catálogo.

Mostrar fulfillment

string

requerido

POS o KIOSK.

string

requerido

Catálogo. Debe estar habilitado para tu cuenta.

object

Datos de la entrega, p. ej. buzzer_name (nombre para llamar al cliente).

object

Equipo que registró la venta: uid, name, metadata.

object

Cajero u operador: uid, name, session (uid, start_timestamp, end_timestamp). null en el kiosco.

object

Datos del cliente: uid, name, last_name, phone (obligatorios si envías el objeto), email, gov_id_type, gov_id_number.

object

Datos de facturación: gov_id_type, gov_id_number, business_name.

object

Datos adicionales de la venta, p. ej. display_code (número para llamar la orden) y los datos del kiosco o de la caja.

object[]

requerido

Productos de la orden.

Mostrar order_lines[]

string

requerido

Identificador de la línea dentro de la orden.

string

requerido

UID del producto en el catálogo.

string

requerido

Nombre del producto.

string

requerido

Tipo de ítem (p. ej. PRODUCT).

string

requerido

Cantidad, como texto ("1").

string

requerido

Moneda (p. ej. BRL).

string

requerido

Vendor.

string

requerido

Tienda.

object

requerido

method y catalog_uid, como en la orden.

object

requerido

Solo el precio unitario: unit_price[] con currency_code, gross_price, net_price, taxes, taxes_value, discount_value, subtotal_before_taxes y discounts. Los montos van como texto ("14.9"). Fire calcula el total de la línea y de la orden.

object[]

requerido

Grupos de modificadores (uid, description, selected_modifiers[]). Cada modificador tiene la misma forma que una línea. [] si no hay.

object

Códigos del producto, p. ej. code, external_code, ncm.

object[]

requerido

Pagos de la orden.

Mostrar payment_methods[]

string

requerido

UID del medio de pago.

string

requerido

Medio de pago (p. ej. CASH, CREDIT, DEBIT).

string

requerido

Moneda.

string

requerido

Monto pagado, como texto.

object

Detalle de la transacción: processor, transaction_status (APPROVED, PENDING), transaction_type, transaction_id, tid, authorization_code, total_bill, customer_cash_amount, change_amount, card, acquirer, transaction_date. Un pago PENDING deja la orden abierta, pendiente de cobro.

object

Datos del autorizador del pago.

Cuerpo — agregadores

El mismo cuerpo de Inyectar orden, sin cambios. Fire lo identifica como orden de agregador por channel.uid y la registra cerrada y pagada.

Respuesta

boolean

true cuando la orden se creó.

object

Mostrar data

string

ID de la orden en Fire. Úsalo para consultarla, actualizarla o anularla.

string

El order_code que enviaste.

string

COMPLETED u OPEN.

string

SUCCEEDED o PENDING.

string

Día de negocio de la tienda, YYYY-MM-DD.

string

Fecha de creación en Fire (ISO 8601).

Errores

HTTP	`error` / `code`	Cuándo
`400`	`VALIDATION_ERROR`	Falta el código de la orden, el cuerpo no se puede leer (caja y kiosco: `details[]` detalla cada problema; agregadores: el mensaje dice qué falta), los headers de cliente faltan o vienen los dos, o el canal no está habilitado para tu vendor
`400`	`BUSINESS_ERROR`	Tienda inactiva, día de negocio cerrado, o la orden no cumple una regla de validación activada para tu vendor (`ORDER_INVARIANT_VIOLATION`)
`404`	`NOT_FOUND`	La tienda no existe
`401`	`UNAUTHORIZED`	API key inválida, vencida o revocada
`403`	`FORBIDDEN`	API key sin scope `orders:write` o no asociada a un vendor
`409`	`CONFLICT` / `DUPLICATE_ORDER`	La orden ya existía para tu vendor. `data` trae `id`, `externalOrderId` y `status` de la existente

Toda petición queda registrada en Fire con su cuerpo y el motivo del rechazo, también las rechazadas. Si reintentas una orden que ya se creó, la respuesta es 409 y no se duplica.

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   # mismo cuerpo que en "Inyectar orden"

{
  "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" }]
}

​Autenticación

​Identidad del cliente (caja y kiosco)

​Cuerpo — caja y kiosco

​Cuerpo — agregadores

​Respuesta

​Errores

Autenticación

Identidad del cliente (caja y kiosco)

Cuerpo — caja y kiosco

Cuerpo — agregadores

Respuesta

Errores