Correios
Credenciais dos Correios do seller, emissão de pré-postagens e etiquetas, rastreio e caixas de embalagem.
Os Correios são a maior transportadora do Brasil. Quando a loja usa a integração Correios 2.0, cada seller (lojista) tem o seu próprio contrato (cartão de postagem), sem herdar o da loja. O pedido é dividido em volumes (pacotes físicos), e cada volume ganha uma pré-postagem: um registro no sistema dos Correios que gera o código de rastreio e a etiqueta (PDF) para colar na caixa. A pré-postagem vale por poucos dias; se vence sem a caixa ser postada, é preciso renová-la. Estas rotas fazem tudo isso pela API.
Como funciona
- Cadastre as credenciais
PUT /configcom o cartão de postagem, login e senha da API; teste comPOST /test. - Cadastre caixas (opcional)Para o empacotamento usar suas caixas reais.
- Receba o pedidoO checkout cria os volumes com o serviço escolhido.
- Emita
POST /volumes/{volumeId}/prepostingdevolve o rastreio. - Baixe a etiqueta
GET /postings/{postingId}/documents/label, ou um lote com vários volumes. - Acompanhe
GET /orders/{orderId}/tracking-eventse, se preciso,POST /volumes/{volumeId}/tracking/refresh.
Estados da emissão
lifecycle_state | Significado |
|---|---|
creating | Pedido enviado aos Correios, resposta ainda não confirmada. |
uncertain | Não sabemos se os Correios criaram. Consulte antes de emitir outra. |
active | Pré-postagem válida, com rastreio. |
pdf_pending | Criada, mas o PDF da etiqueta ainda não chegou. |
posted | O objeto foi postado: não pode mais ser reemitido. |
expired | Venceu sem postagem. Pode ser renovada. |
canceled | Cancelada. Reemitir exige confirmação humana (renovar). |
replaced | Substituída por uma emissão mais nova do mesmo volume. |
error | A criação falhou antes de chegar aos Correios. Pode emitir de novo. |
Conceitos-chave
Volume, emissão e rastreio
Um volume é um pacote físico. Um pedido grande vira vários volumes, dimensionados com as caixas de embalagem cadastradas. Cada volume tem uma emissão atual e um histórico de emissões anteriores. O rastreio (eventos do SRO, o sistema de rastreamento dos Correios) é puxado automaticamente e pode ser atualizado à mão uma vez por minuto.
Privilégios
Credenciais e caixas: leitura com vendor_settings (ou um dos privilégios de leitura de configurações); gravação com vendor_settings. Emitir, renovar, cancelar, baixar documentos e atualizar rastreio: vendor_orders, vendor_manage_orders ou vendor_manage_fulfillments. Consultas de volumes, operação e rastreio: qualquer privilégio de pedidos. O dono da conta sempre passa.
Endpoints
Erros comuns
- Esquecer as credenciais. Sem cartão de postagem do seller, o checkout não oferece Correios e a emissão falha.
- Emitir duas vezes. Se o volume já tem emissão, a resposta é
409 O volume já possui uma emissão. Use consultar ou renovar. - Renovar o que já foi postado. Objeto
postednão pode ser reemitido. - Cancelar e emitir de novo sem renovar. Após cancelar, só renovar (ação humana explícita) destrava.
- Atualizar o rastreio mais de uma vez por minuto.
429comRetry-After. - Mandar
rate_calculationRsem código de serviço. Veja Formas de envio. - Contar com a etiqueta para sempre. A pré-postagem vence: confira
validity_expires_at.