Pular para o conteúdo
Abbiamo Docs

Transportadora — Quick Guide - Código de Coleta

Quick Guide - Código de Coleta

Seção intitulada “Quick Guide - Código de Coleta”

Este guia explica especificamente quando informar collect_verification_code nos endpoints de status da API de transportadoras.

Quando informar o collect_verification_code

Seção intitulada “Quando informar o collect_verification_code”

Você pode enviar collect_verification_code nos endpoints de status:

Mas esse campo só deve ser enviado quando o webhook de entrega indicar que verificação por código está habilitada, isto é:

  • logistic_data.pickup_verification.pincode = true

Regra prática

Seção intitulada “Regra prática”
  1. Receba o webhook Delivery request.
  2. Leia logistic_data.pickup_verification.pincode.
  3. Se for true, inclua collect_verification_code nas chamadas de status permitidas.
  4. Se for false (ou ausente), não envie collect_verification_code.

Exemplo mínimo do webhook (campo relevante)

Seção intitulada “Exemplo mínimo do webhook (campo relevante)”

Este payload é uma simplificação apenas para destacar os campos necessários nesta regra. O payload completo possui mais campos na documentação oficial.

{
  "event_type": "DELIVERY_REQUEST",
  // ... outros campos
  "seller": {
    // ... outros campos
  },
  "carrier": {
    // ... outros campos
  },
  "deliveries": [
    {
      "delivery_id": "851dc274-e090-4881-8f3c-5b660cecf059"
      // ... outros campos da entrega
    }
  ],
  "logistic_data": {
    // ... outros campos de logística
    "pickup_verification": {
      "pincode": true
    }
  }
}

Exemplo de status com código (quando pincode = true)

Seção intitulada “Exemplo de status com código (quando pincode = true)”
{
  "delivery_id": "851dc274-e090-4881-8f3c-5b660cecf059",
  "event_at": "2026-03-13T15:10:00.000Z",
  "collect_verification_code": "123456"
}

Exemplo de status sem código (quando pincode = false)

Seção intitulada “Exemplo de status sem código (quando pincode = false)”
{
  "delivery_id": "851dc274-e090-4881-8f3c-5b660cecf059",
  "event_at": "2026-03-13T15:10:00.000Z"
}

Referências oficiais

Seção intitulada “Referências oficiais”