Saltar para o conteúdo principal
Contrato atual (v1). order.cancelled carrega o mesmo snapshot v1 que order.completed — descontos de pedido/produto, impostos granulares, enum itemType, deliveryConfirmationCode — mais o bloco de auditoria cancellation.
order.cancelled dispara quando um pedido previamente injetado é cancelado — pela UI do backoffice do Fire, um adaptador externo ou uma chamada à API de cancelamento. Não retrai um order.completed anterior do mesmo pedido; ambos os eventos são emitidos independentes.

​
Condição de disparo

O Fire emite order.cancelled uma vez quando o status de um pedido transiciona para CANCELLED, independente do estado de pagamento anterior. O cancelamento é registrado com contexto completo de auditoria (quem, quando, por quê, fonte).
CoberturaGlobal (todos os países, todos os canais)
Chave de idempotênciaevent.id
Dispara mais de uma vezNão, salvo em retentativas
OrdemNão garantida contra order.completed para o mesmo pedido — ordene por timestamps se precisar
RetentativasAté 5 tentativas com backoff exponencial (quando retryOnFailure está habilitado)
Contexto fiscal brasileiroInclui dados fiscais originais em cancellation.metadata.fiscal se o pedido tinha sido fiscalmente autorizado

​
O que tem em trigger.data

Mesmo snapshot V4 que order.completed — todos os campos documentados lá estão presentes aqui, com três diferenças:
  1. status é "CANCELLED" (não "COMPLETED").
  2. paymentStatus permanece igual a quando o pedido foi completado (tipicamente "SUCCEEDED" se o pedido tinha sido pago antes do cancelamento).
  3. Um novo bloco top-level cancellation carrega a metadata de auditoria.

​
Exemplo — payload real de produção (BR, sanitizado)

{
  "event": {
    "id": "abcf3781-c327-4df1-84ef-5efbacc1d387",
    "type": "order.cancelled",
    "createdAt": "2026-05-05T23:06:08.883Z"
  },
  "data": {
    "orderId": "e98f5725-0d1e-4f93-ac18-40f1068cae89",
    "orderCode": "OC-br-001",
    "businessDayDate": "2026-03-31",
    "externalOrderId": "ac331b68-66fb-48ee-b110-a40181bfb379",
    "status": "CANCELLED",
    "paymentStatus": "SUCCEEDED",
    "redeemPoints": false,
    "accumulatePoints": false,
    "discount": false,
    "createdAt": "2026-05-05T23:05:00.438Z",
    "orderComment": "Comentário de teste do pedido",
    "marketing": null,
    "store": { /* igual a order.completed — veja /pt/events/order-completed */ },
    "device": { /* ... */ },
    "channel": { /* ... */ },
    "operator": { /* ... */ },
    "client": { /* ... */ },
    "payments": { /* ... */ },
    "kds": { /* ... */ },
    "metadata": {},
    "orderLines": [ /* ... */ ],
    "fulfillment": { /* ... */ },

    "cancellation": {
      "cancellationId": "abcf3781-c327-4df1-84ef-5efbacc1d387",
      "cancelledAt": "2026-05-05T23:06:08.883Z",
      "cancelledBy": "00000000-0000-0000-0000-000000000000",
      "cancellationReason": "Cliente solicitou cancelamento",
      "cancellationSource": "backoffice",
      "metadata": {
        "fiscal": {
          "serie": null,
          "numero": "1000013",
          "pdfUrl":   "https://api.fiscal-provider.example/nfce/<docId>/pdf",
          "xmlUrl":   "https://api.fiscal-provider.example/nfce/<docId>/xml",
          "protocolo": "141200000956123",
          "docSubtype": "nfce",
          "chaveAcesso": "41201008187168000160558050010000131609769080",
          "providerDocId": "69fa77aa2a48c20329be4604",
          "dataAutorizacao": "2026-05-05T23:05:15.590Z"
        }
      }
    }
  },
  "_meta": { "executionId": "...", "flowId": "...", "attempt": "1" }
}

​
Referência de data.cancellation

​
cancellation
object
Bloco de auditoria que descreve como, quando e por quem o pedido foi cancelado.

​
Lifecycle relativo a outros eventos

Para um pedido brasileiro fiscal-enabled que é cancelado, espere esta sequência:
  • order.cancelled é emitido imediatamente quando o cancelamento acontece, antes de contatar qualquer autoridade fiscal externa.
  • order.reversed é emitido depois — uma vez que a SEFAZ confirma via seu provedor fiscal. Pode chegar segundos ou minutos após order.cancelled, dependendo do tempo de resposta da SEFAZ.
  • Para pedidos não brasileiros ou lojas sem emissão fiscal, apenas order.cancelled dispara.

​
Variações por país

order.cancelled é global — dispara para todos os países e todos os canais quando um pedido é cancelado (Argentina, Brasil, Chile, Colômbia, Equador, Venezuela e qualquer outro país com Integration Flows ativos). O bloco de auditoria de cancelamento (cancellation.{cancellationId, cancelledAt, cancelledBy, cancellationReason, cancellationSource}) é idêntico em todos os países. O único campo específico por país é cancellation.metadata.fiscal, que é populado apenas para lojas brasileiras que tinham um documento fiscal previamente autorizado (ou seja, um order.invoiced foi emitido para este pedido antes). Para todos os demais países — e para pedidos BR cancelados antes da autorização fiscal — cancellation.metadata.fiscal é null e nenhum evento order.reversed seguirá. Para lojas não-BR (Argentina, Chile, Colômbia, Equador, Venezuela, outras), o bloco cancellation fica assim:
Cancelamento não-BR
{
  "cancellation": {
    "cancellationId": "abcf3781-c327-4df1-84ef-5efbacc1d387",
    "cancelledAt": "2026-05-05T23:06:08.883Z",
    "cancelledBy": "00000000-0000-0000-0000-000000000000",
    "cancellationReason": "Cliente solicitou cancelamento",
    "cancellationSource": "backoffice",
    "metadata": { "fiscal": null }
  }
}
Os identificadores a nível de loja em data.store variam por país — veja order.completed → Variações por país para country.code, currencyCode e storeFiscalConfig.govIdType (CNPJ / CUIT / RUT / NIT / RUC / RIF) por país.

​
Handler de exemplo

async function onOrderCancelled(data) {
  const { orderId, store, cancellation } = data;

  // 1. Marque o pedido como cancelado no seu sistema (idempotente)
  await db.orders.update({
    where: { fireOrderId: orderId },
    data: {
      status: "CANCELLED",
      cancelledAt: new Date(cancellation.cancelledAt),
      cancellationReason: cancellation.cancellationReason,
      cancellationSource: cancellation.cancellationSource,
    },
  });

  // 2. Se a loja tem fiscal habilitado e havia um doc fiscal,
  //    abra um ticket de reconciliação — o cancelamento SEFAZ
  //    seguirá em order.reversed.
  if (cancellation.metadata?.fiscal) {
    await reconciliation.open({
      orderId,
      country: store.locationInfo.country.code,
      originalDoc: cancellation.metadata.fiscal,
      pendingSefazCancel: true,
    });
  }

  // 3. Reverta side-effects downstream (libera estoque, refund, etc.)
  await downstream.rollback(orderId);
}

​
Erros comuns

  • status === "CANCELLED", não paymentStatus. Pedidos pagos cancelados mantêm paymentStatus === "SUCCEEDED"; o cancelamento vive no campo status mais o bloco cancellation.
  • order.cancelled ≠ refund. O Fire reporta o cancelamento; o refund (se houver) é iniciado pelo canal/processador e não está neste payload.
  • Não assuma que order.completed chegou primeiro. Entrega fora de ordem é possível — seu handler deveria tolerar receber order.cancelled para um orderId que ainda não conhece (ex.: log + cria um placeholder; reconcilia quando order.completed chegar).
  • cancellation.metadata.fiscal é o doc original, não o resultado do cancelamento. Para a confirmação SEFAZ, escute order.reversed.

​
Eventos relacionados

order.completed

O evento que você verá para o mesmo pedido antes do cancelamento.

order.reversed

Apenas Brasil — dispara quando a SEFAZ confirma o cancelamento.