Atualizar etiqueta da entrega

A transportadora envia o PDF da etiqueta de envio (etiqueta de postagem) associada à entrega.

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

Use este endpoint para enviar à Abbiamo o PDF da etiqueta de envio de uma entrega específica. Você informa o delivery_id da entrega e o conteúdo da etiqueta (base64); opcionalmente, envie um external_id para referência cruzada com o seu sistema.

Como enviar a etiqueta

  • O campo base64 deve conter o PDF da etiqueta codificado em base64. O prefixo data URI (data:application/pdf;base64,) é opcional.
  • O arquivo é validado: precisa ser um PDF íntegro, com header %PDF e trailer %%EOF. Conteúdo que não for um PDF válido é recusado.
  • A entrega precisa pertencer à sua transportadora e não pode estar cancelada ou já finalizada com falha.

Reenviar a etiqueta para a mesma entrega substitui o PDF anterior. Sempre envie a versão mais atual.

POST
/v1/delivery/mail-label

Authorization

carrierKey
x-abbiamo-carrier-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/delivery/mail-label" \  -H "Content-Type: application/json" \  -d '{    "delivery_id": "string",    "base64": "string"  }'
{}

{
  "code": "UNAUTHORIZED",
  "message": "Arquivo não é um PDF válido (header inválido).",
  "level": "WARNING",
  "status": 400
}

{
  "code": "DELIVERY_NOT_FOUND",
  "message": "Delivery 6060e377-d5cd-4acf-b4fe-0fcde5884626 not found",
  "level": "WARNING",
  "status": 404,
  "params": {
    "delivery_id": "6060e377-d5cd-4acf-b4fe-0fcde5884626"
  }
}

Nesta página