Consulta de rastreio
Utilize esta API para consultar o status de envio e entrega de um cartão físico após sua emissão.
Essa consulta permite obter informações atualizadas sobre o estágio do processo logístico do cartão.
Quando utilizar
A consulta de rastreio deve ser utilizada para:
- Obter o status atual de entrega do cartão
- Apresentar o progresso de envio ao portador
- Complementar o uso de webhooks no acompanhamento do rastreio
Resposta da consulta
| Campo | Tipo | Descrição |
|---|---|---|
| cardId | int | Identificador do cartão |
| deliveryStatus | string | Status atual do processo de entrega |
| deliveryTracking | object | Informações detalhadas do rastreio |
| expectedDeliveryDate | date | Data estimada de entrega |
| postingDeliveryDate | date | Data de envio do cartão |
| collectionDeliveryDate | date | Data de coleta pelo operador logístico |
Campos adicionais
| Campo | Tipo | Descrição |
|---|---|---|
| embossingStart | boolean | Indica se o processo de fabricação foi iniciado |
| embossingFinish | boolean | Indica se o processo de fabricação foi finalizado |
| embosserName | string | Nome da embossadora responsável |
| embossingCounter | int | Quantidade de vezes que o cartão foi reemitido |
| address | object | Endereço de entrega do cartão |
Status de entrega
O campo deliveryStatus indica em qual etapa o cartão se encontra no processo logístico.
| Status | Descrição |
|---|---|
| SOLICITADO | Cartão criado e aguardando fabricação |
| EMBOSSING GERADO | Cartão produzido com sucesso |
| COLETADO | Processo logístico iniciado |
| POSTADO | Cartão despachado para entrega |
| ENTREGA EM ANDAMENTO | Entrega em progresso |
| ENTREGUE | Cartão entregue ao destinatário |
| DEVOLVIDO | Entrega recusada |
| EXTRAVIADO | Cartão extraviado durante o transporte |
| DESTRUIDO | Cartão danificado |
Considerações importantes
- Essa API deve ser utilizada como fonte de verdade para o rastreio do cartão
- O rastreio é aplicável apenas para cartões físicos
- Recomenda-se utilizar essa API em conjunto com webhooks para atualização de status
- Nem todos os campos estarão disponíveis em todos os estágios do processo
Updated 20 days ago