VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

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.

Pontos principais
  • Tudo exige o módulo correios-shipping ligado na loja (403 module_disabled se não).
  • Cada seller guarda as próprias credenciais. Sem credenciais, não há opções Correios no checkout desse seller.
  • O volume nasce no checkout, quando o cliente escolhe um serviço Correios. A pré-postagem, não: é emitida por você (ou automaticamente, se a loja configurou).
  • A emissão pode estar active, posted, expired, canceled... Antes de agir, veja o lifecycle_state e o decision devolvido pelas rotas de emissão.
  • Baixar a etiqueta é uma ação auditada: cada download guarda quem baixou e quando.
  • A atualização de rastreio manual é limitada a uma por minuto por volume.
Idioma das mensagens

As mensagens de erro e alguns textos de pendência vêm do servidor em português ou em inglês, conforme a rota, e os exemplos desta seção as mostram exatamente como são devolvidas. Para lógica no seu código, use o status HTTP e os códigos (error, reason, code), nunca o texto.

Como funciona

  1. Cadastre as credenciais
    PUT /config com o cartão de postagem, login e senha da API; teste com POST /test.
  2. Cadastre caixas (opcional)
    Para o empacotamento usar suas caixas reais.
  3. Receba o pedido
    O checkout cria os volumes com o serviço escolhido.
  4. Emita
    POST /volumes/{volumeId}/preposting devolve o rastreio.
  5. Baixe a etiqueta
    GET /postings/{postingId}/documents/label, ou um lote com vários volumes.
  6. Acompanhe
    GET /orders/{orderId}/tracking-events e, se preciso, POST /volumes/{volumeId}/tracking/refresh.

Estados da emissão

creating→active→posted
lifecycle_stateSignificado
creatingPedido enviado aos Correios, resposta ainda não confirmada.
uncertainNão sabemos se os Correios criaram. Consulte antes de emitir outra.
activePré-postagem válida, com rastreio.
pdf_pendingCriada, mas o PDF da etiqueta ainda não chegou.
postedO objeto foi postado: não pode mais ser reemitido.
expiredVenceu sem postagem. Pode ser renovada.
canceledCancelada. Reemitir exige confirmação humana (renovar).
replacedSubstituída por uma emissão mais nova do mesmo volume.
errorA 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

MétodoCaminhoPara que serveAutenticação
GET/api/v1/vendor/shipping/correios/configLê as credenciais Correios do seller.vendor
PUT/api/v1/vendor/shipping/correios/configGrava as credenciais.vendor
POST/api/v1/vendor/shipping/correios/testTesta a conexão com os Correios.vendor
GET/api/v1/vendor/shipping/correios/orders/{orderId}/volumesLista os volumes de um pedido.vendor
POST/api/v1/vendor/shipping/correios/volumes/{volumeId}/prepostingEmite a pré-postagem de um volume.vendor
POST/api/v1/vendor/shipping/correios/postings/{postingId}/reconcileConsulta o estado nos Correios.vendor
POST/api/v1/vendor/shipping/correios/postings/{postingId}/renewRenova uma emissão vencida ou cancelada.vendor
POST/api/v1/vendor/shipping/correios/postings/{postingId}/cancelCancela uma emissão.vendor
GET/api/v1/vendor/shipping/correios/postings/{postingId}/documents/{documentType}Baixa etiqueta, declaração ou AR (PDF).vendor
POST/api/v1/vendor/shipping/correios/postings/{postingId}/documents/{documentType}/recoverRecupera um documento que faltou.vendor
POST/api/v1/vendor/shipping/correios/document-batchesCria um lote de documentos.vendor
GET/api/v1/vendor/shipping/correios/document-batches/{batchId}Consulta um lote.vendor
GET/api/v1/vendor/shipping/correios/document-batches/{batchId}/archiveBaixa o ZIP do lote.vendor
GET/api/v1/vendor/shipping/correios/operationsLista a operação de etiquetas, com filtros.vendor
GET/api/v1/vendor/shipping/correios/operations/export.csvExporta a operação em CSV.vendor
GET/api/v1/vendor/shipping/correios/orders/summaryResume o Correios de vários pedidos.vendor
GET/api/v1/vendor/shipping/correios/orders/{orderId}/tracking-eventsLinha do tempo de rastreio de um pedido.vendor
POST/api/v1/vendor/shipping/correios/volumes/{volumeId}/tracking/refreshAtualiza o rastreio de um volume.vendor
GET/api/v1/vendor/shipping/packaging-boxesLista as caixas de embalagem.vendor
POST/api/v1/vendor/shipping/packaging-boxesCria uma caixa.vendor
PUT/api/v1/vendor/shipping/packaging-boxes/{id}Altera uma caixa.vendor
DELETE/api/v1/vendor/shipping/packaging-boxes/{id}Apaga uma caixa.vendor

Erros comuns

  1. Esquecer as credenciais. Sem cartão de postagem do seller, o checkout não oferece Correios e a emissão falha.
  2. Emitir duas vezes. Se o volume já tem emissão, a resposta é 409 O volume já possui uma emissão. Use consultar ou renovar.
  3. Renovar o que já foi postado. Objeto posted não pode ser reemitido.
  4. Cancelar e emitir de novo sem renovar. Após cancelar, só renovar (ação humana explícita) destrava.
  5. Atualizar o rastreio mais de uma vez por minuto. 429 com Retry-After.
  6. Mandar rate_calculation R sem código de serviço. Veja Formas de envio.
  7. Contar com a etiqueta para sempre. A pré-postagem vence: confira validity_expires_at.

Próximos passos

Credenciais
Cartão de postagem e teste.
Volumes e emissão
Emitir a pré-postagem.
Documentos
Baixar a etiqueta.
Caixas de embalagem
Dimensionar os volumes.
Anterior
Transportadoras da loja
Próxima
Credenciais dos Correios
Nesta página
  • Como funciona
  • Estados da emissão
  • Conceitos-chave
  • Volume, emissão e rastreio
  • Privilégios
  • Endpoints
  • Erros comuns
  • Próximos passos