Documentos da emissão
Baixa a etiqueta, a declaração de conteúdo ou o aviso de recebimento de uma emissão, e recupera um documento que não chegou.
Baixar o documento
Devolve o arquivo (PDF) para imprimir. Para label, a plataforma consulta antes os Correios e confere se a pré-postagem ainda vale; se não vale, a resposta é 409 com o decision que explica o que fazer. Cada download é registrado (quem e quando), e aparece em label_downloaded_at e na operação.
/api/v1/vendor/shipping/correios/postings/{postingId}/documents/{documentType}SellerBaixa um documento de uma emissão (PDF)
Parâmetros de caminho
postingIduuidobrigatórioId da emissão.
documentTypestringobrigatóriolabeldeclarationarlabel (etiqueta), declaration (declaração de conteúdo) ou ar (aviso de recebimento).Exemplo de requisição: baixar
Resposta: baixar
200Arquivo
Erros: baixar
| Status | Quando | Corpo de exemplo |
|---|---|---|
| 409 | Não há documento utilizável: a pré-postagem venceu, foi cancelada, já foi postada, o tipo não existe ou a emissão não é sua. O corpo traz error e o decision. | {"error":"A pré-postagem venceu...","decision":{"action":"renew","message":"..."}} |
| 401 | Sem cabeçalho Authorization, ou token inválido ou expirado. | {"error":"invalid or expired token"} |
| 403 | O token não é de um usuário seller (por exemplo, é um token de administrador). | {"error":"insufficient permissions"} |
| 403 | O módulo correios-shipping está desligado na loja. | {"error":"module_disabled","module":"correios-shipping"} |
| 403 | O usuário não tem conta de seller. | {"error":"no vendor account associated with this user"} |
| 403 | O usuário não tem o privilégio necessário (vendor_orders, vendor_manage_orders, vendor_manage_fulfillments). | {"error":"insufficient vendor privileges","privilege_required_any":["..."]} |
Recuperar o documento
Quando a emissão está pdf_pending ou o PDF sumiu, pede aos Correios o documento da mesma pré-postagem, sem criar uma nova. Depois, baixe com GET.
/api/v1/vendor/shipping/correios/postings/{postingId}/documents/{documentType}/recoverSellerRecupera um documento que não chegou
Parâmetros de caminho
postingIduuidobrigatórioId da emissão.
documentTypestringobrigatóriolabeldeclarationarlabel (etiqueta), declaration (declaração de conteúdo) ou ar (aviso de recebimento).Exemplo de requisição: recuperar
Resposta: recuperar
200Recuperado
Campos da resposta
successbooleanSempre
true.Erros: recuperar
| Status | Quando | Corpo de exemplo |
|---|---|---|
| 409 | Não foi possível recuperar (emissão alheia, sem pré-postagem válida, falha dos Correios). | {"error":"failed to recover Correios document","detail":"..."} |
| 401 | Sem cabeçalho Authorization, ou token inválido ou expirado. | {"error":"invalid or expired token"} |
| 403 | O token não é de um usuário seller (por exemplo, é um token de administrador). | {"error":"insufficient permissions"} |
| 403 | O módulo correios-shipping está desligado na loja. | {"error":"module_disabled","module":"correios-shipping"} |
| 403 | O usuário não tem conta de seller. | {"error":"no vendor account associated with this user"} |
| 403 | O usuário não tem o privilégio necessário (vendor_orders, vendor_manage_orders, vendor_manage_fulfillments). | {"error":"insufficient vendor privileges","privilege_required_any":["..."]} |