Embarcador (LOG)Frota Própria (GO)TransportadoraTMSTrackingAPI ReferenceChangelog
Pedidos (Orders)

Confirmar pincode de coleta

Valida o PIN reverso digitado pelo operador, solicita à transportadora a liberação do motorista e transita a entrega para COLLECTED.

No guia

Fluxo completo do PIN reverso: Pickup pincode — fluxo motorista para filial.

Header obrigatório. Toda chamada exige o header x-abbiamo-seller-group-key. Preencha-o no canto superior direito desta página ou veja como obter a sua chave.

Rate limit: 300 requisições por minuto por chave. Acima disso a API retorna HTTP 429.

Equivalente via API ao passo em que o operador digita o PIN no dashboard (passo 5 do guia). Em uma única chamada, a Abbiamo:

  1. Valida o PIN localmente contra o código gerado na criação do pedido.
  2. Solicita à transportadora que libere o motorista — chamada síncrona do webhook de Validação do pin de coleta, com timeout de 5 segundos.
  3. Transita a entrega para COLLECTED e retorna sucesso.

Antes de chamar, use Verificações do pedido para saber se o pedido exige o PIN.

  • PIN incorreto retorna HTTP 400 INVALID_PICKUP_PIN — a transportadora não é chamada e o status não muda.
  • Transportadora indisponível (4xx/5xx ou timeout no webhook) retorna erro — o operador pode tentar novamente (a chamada é idempotente: confirmar um pedido já coletado retorna COLLECTED).
  • Só se aplica ao fluxo PIN reverso (pincode_owner = abbiamo); em entregas fora desse modelo retorna PICKUP_PINCODE_NOT_OWNED_BY_ABBIAMO.
POST
/seller-group/v1/orders/{order_id}/verification/pickup/confirm

Authorization

sellerGroupKey
x-abbiamo-seller-group-key<token>

In: header

Path Parameters

order_id*string

Identificador único do pedido (order_id retornado na criação)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/seller-group/v1/orders/string/verification/pickup/confirm" \  -H "Content-Type: application/json" \  -d '{    "pincode": "8745"  }'
{
  "delivery_id": "851dc274-e090-4881-8f3c-5b660cecf059",
  "status": "COLLECTED",
  "confirmed_at": "2026-07-03T14:34:18.014Z"
}

{
  "code": "INVALID_PICKUP_PIN",
  "message": "Invalid pickup pincode",
  "status": 400,
  "params": {}
}

{
  "message": "Unauthorized"
}
{
  "code": "INVOICE_NOT_FOUND_OR_NOT_IN_SELLER_GROUP",
  "message": "Invoice not found or not belongs to seller group",
  "status": 404,
  "params": {}
}
{
  "code": "DELIVERY_NOT_PICKUP_ELIGIBLE",
  "message": "Delivery is not eligible for pickup pincode validation",
  "status": 409,
  "params": {}
}

Verificações do pedido (coleta e retorno) GET

Informa as verificações do pedido — coleta, entrega e retorno — cobrindo os dois modelos de pincode, e retorna o código quando ele deve ser exibido ao operador.

Atualizar status manualmente PUT

Atualiza manualmente o status de entrega de um pedido para registrar eventos fora do fluxo automático da transportadora.