Rastreio de cartão

O evento de rastreio de cartões dispara uma mensagem sempre que há atualizações sobre o status de entrega do cartão.

Como esses eventos chegam ao recebedor via webhook, é preciso realizar previamente a sua configuração.

Contexto e nome do evento

Nos eventos de rastreio de cartões, o campo context sempre informará “Card”, e o campo name trará o valor a seguir:

EntityId

O campo entityId é o identificador da entidade emissora do evento e seu valor depende do contexto de sua emissão.

No contexto de cartão, o entityId é o proxy do cartão.

Exemplo do evento

{
  "entityId": "24906A3D54FC",
  "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
  "companyKey": "companyKey",
  "context": "Card",
  "name": "TRACKING_STATUS_CHANGED",
  "timestamp": "2021-10-06T13:07:25.3853601Z",
  "correlationId": "7a1bfc3f-50e6-458c-aa9b-d42a22ddb84d",
  "metadata": {
    "created": "2021-11-10T20:40:24.282+00:00",
    "modified": "2021-11-18T20:40:24.282+00:00"
  },
  "data": {
    "card": {
      "proxy": "2229141009436273825",
      "alias": "Peter Parker"
    },
    "name": "Peter Parker",
    "externalTracking": {
      "code": "111",
      "parnter": "CORREIOS"
    },
    "estimatedDeliveryDate": "2021-11-25T23:59:59.282+00:00",
    "status": {
      "type": "Delivered",
      "reason": "Object delivered"
    },
    "finalized": {
      "recipient": {
        "name": "Mary Parker",
        "kinship": "Mãe",
        "document": {
          "type": "RG",
          "number": "10854042"
        }
      },
      "attempts": 1
    }
  }
}

Objeto data no evento de rastreio de cartões

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, este objeto trará os seguintes campos:

• estimatedDeliveryDate: data de entrega estimada;
• card: informações sobre o cartão;
• status: histórico dos status desde a criação do cartão até a entrega ao destinatário;
• finalized: uma vez entregue o cartão, o campo finalized é preenchido com informações de quando o cartão foi recebido e por quem;
  • kinship: o campo mostra o relacionamento do portador do cartão com a pessoa que o recebeu. Exemplo: porteiro, mãe, portador etc.
• externalTracking: ao receber um status com o motivo Sended to correios, o código de rastreamento utilizado pelos Correios é adicionado dentro do campo.

Para saber mais sobre os tipos de status e consultar mais informações sobre o rastreio, verifique a documentação sobre rastreio de cartões.