--- title: "Encomendas Correios" description: "API Encomendas Correios - Rastreio em tempo real que reduz custos e chamadas no suporte" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/934dc874-871d-4b01-91bd-9784c1767236 markdown: https://doc.apibrasil.io/apis/creditos/934dc874-871d-4b01-91bd-9784c1767236.md source: apibrasil-documentation --- # Encomendas Correios > API Encomendas Correios - Rastreio em tempo real que reduz custos e chamadas no suporte - **Categoria:** Serviços Digitais - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 0,04 por consulta - **Limite:** 999.000 por mês - **Cadastro:** CPF ou CNPJ - **Versão:** v2 - **Publicada por:** APIBrasil - **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/934dc874-871d-4b01-91bd-9784c1767236/openapi.json ## Como chamar **Endereço base:** `https://gateway.apibrasil.io/api/v2` Autenticação: cabeçalho `Authorization: Bearer `. Nada além disso. Com `homolog: true` no corpo, o gateway responde de uma base fixa, com a forma real da resposta, e não cobra. O CPF 00000000000 é dessa base e não é de ninguém: use-o nos testes, nunca em produção. ## Endpoints (1 endpoint) ### 1. POST /consulta/rastreio/credits API Encomendas Correios - Rastreio rápido e confiável de objetos Com o endpoint de rastreio via POST (action consulta/rastreio/credits), sua aplicação passa a acompanhar encomendas dos Correios em tempo real com integração rápida e simples. Em poucos minutos você conecta seu sistema, envia os códigos de rastreio e recebe de volta status atual, histórico de movimentações e previsões de entrega em formato estruturado, pronto para uso imediato. Essa API reduz chamadas manuais ao site dos Correios, melhora a experiência do cliente com informações atualizadas e ajuda sua equipe a tomar decisões mais ágeis em logística e atendimento. Use os retornos para alimentar painéis de tracking, disparar notificações automáticas, atualizar pedidos em e-commerces ou integrar com ERPs e CRMs, otimizando todo o fluxo de pós-venda. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/rastreio/credits` - **Versão da rota:** v2 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "rastreio", "code": "AN 100 867 266 BR", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/rastreio/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"rastreio","code":"AN 100 867 266 BR","homolog":true}' ``` Este endpoint aceita `homolog: true` no corpo: a resposta volta com dados válidos, `api_limit_for` igual a `homolog` e sem tarifação. **Resposta de exemplo, do catálogo** ```json { "user": { "first_name": "[omitido]", "email": "[omitido]", "cellphone": "[omitido]", "notification": "yes" }, "balance": "105,660", "balance_before": "105,660", "tax": "0,000", "status_code": 200, "error": false, "message": "Dados validos em homologacao! Voce nao foi tarifado e a requisicao nao foi contabilizada.", "valor_consulta": 0, "api_limit_for": "homolog", "homolog": true, "data": { "ambiente": "homologacao", "objetos": [ { "bloqueioObjeto": false, "codObjeto": "MOCK000000000XX", "dtPrevista": "2099-12-31T23:59:59", "eventos": [ { "codigo": "HMG", "descricao": "Evento ficticio de homologacao", "detalhe": "SIMULACAO: nenhum evento real foi consultado", "dtHrCriado": "2099-12-30T14:10:00", "icone": "/public-resources/img/eventos/caixa-visto-stroke.svg", "tipo": "00", "unidade": { "endereco": { "cidade": "CIDADE-NULA", "uf": "ZZ" }, "latitudeAproximada": "0.0000000", "longitudeAproximada": "0.0000000", "mostraMapa": true, "tipo": "CENTRO FICTICIO" }, "urlIcone": "https://homolog.local/images/mock.png" }, { "codigo": "SIM", "descricao": "Objeto em simulacao controlada", "detalhe": "SIMULACAO: dados irreais", "dtHrCriado": "2099-12-30T09:40:00", "icone": "/public-resources/img/eventos/caminhao-correndo-stroke.svg", "tipo": "00", "unidade": { "endereco": { "bairro": "BAIRRO-FANTASMA", "cep": "00000-000", "cidade": "CIDADE-NULA", "logradouro": "AVENIDA-IMAGINARIA", "numero": "000", "uf": "ZZ" }, "mostraMapa": false, "tipo": "CENTRO FICTICIO" }, "urlIcone": "https://homolog.local/images/mock.png" }, { "codigo": "FIC", "descricao": "Objeto em transferencia simulada", "dtHrCriado": "2099-12-29T16:05:00", "icone": "/public-resources/img/eventos/caminhao-correndo-stroke.svg", "tipo": "00", "unidade": { "endereco": { "cidade": "CIDADE-VOID", "uf": "YY" }, "mostraMapa": false, "tipo": "UNIDADE SIMULADA" }, "unidadeDestino": { "endereco": { "cidade": "CIDADE-NULA", "uf": "ZZ" }, "mostraMapa": false, "tipo": "CENTRO FICTICIO" }, "urlIcone": "https://homolog.local/images/mock.png" }, { "codigo": "H00", "descricao": "Postagem simulada em ambiente de homologacao", "detalhe": "SIMULACAO: nao existe movimentacao real", "dtHrCriado": "2099-12-29T08:20:00", "icone": "/public-resources/img/eventos/agencia-relogio-stroke.svg", "tipo": "00", "unidade": { "endereco": { "cidade": "CIDADE-VOID", "uf": "YY" }, "mostraMapa": false, "tipo": "AGENCIA SIMULADA" }, "urlIcone": "https://homolog.local/images/mock.png" }, { "codigo": "FAK", "comentario": "Evento automatico simulado", "descricao": "Etiqueta ficticia emitida", "detalhe": "SIMULACAO: etiqueta inexistente", "dtHrCriado": "2099-12-28T07:25:00", "icone": "/public-resources/img/eventos/etiqueta-visto-stroke.svg", "tipo": "00", "unidade": { "endereco": { "uf": "ZZ" }, "mostraMapa": false, "tipo": "INTERFACE DO SISTEMA" }, "urlIcone": "https://homolog.local/images/mock.png" } ], "habilitaAutoDeclaracao": false, "habilitaCrowdshipping": false, "habilitaLocker": false, "habilitaPercorridaCarteiro": false, "permiteEncargoImportacao": false, "possuiLocker": false, "temServicoAr": false, "tipoPostal": { "categoria": "ENCOMENDA FICTICIA", "descricao": "ETIQUETA LOGICA SIMULADA", "sigla": "XX" } } ], "quantidade": 1, "resultado": "HOMOLOGACAO", "versao": "0.0.0-homolog" } } ``` Nos exemplos de resposta, os campos da conta que gerou o exemplo (`user.first_name`, `user.email`, `user.cellphone`) saem como `[omitido]`. O resto é o que o catálogo publica. ## Armadilhas: o que uma integração erra sem avisar Apuradas nas respostas que o próprio catálogo publica. Em todas elas o código funciona no caminho feliz e falha em silêncio no resto: 1. **O erro chega no CORPO, com HTTP 200.** A resposta traz um campo `error` booleano e uma `message`. Checar só `response.ok` ou o status HTTP deixa passar falha como sucesso. Confira SEMPRE `error === false` antes de ler `data`. 2. **`balance`, `tax` e `extra_charges.total` são STRING em formato brasileiro — e o formato varia entre APIs.** Valores observados no catálogo: `"154,380"`, `"497,84"`, `"0,000"` e `"0.19"`. Vírgula em umas, ponto em outra; três casas decimais em umas, duas em outra. Em JavaScript, `parseFloat("154,380")` devolve `154` e perde os centavos sem erro nenhum, e `Number("154,380")` devolve `NaN`. Escreva um conversor que trate os dois separadores, e nunca use esses campos numa decisão financeira sem convertê-los. 3. **Cada chamada custa dinheiro.** Retry cego multiplica a conta. Nunca repita automaticamente um 4xx: parâmetro errado repetido continua errado e continua cobrando. Repita só tempo esgotado e 5xx, com recuo exponencial e um teto pequeno de tentativas. 4. **HTTP 402 é saldo insuficiente, e repetir não resolve.** É o único status que exige ação humana — recarregar. Trate-o como erro terminal, com mensagem própria, e não o jogue no mesmo balde dos 4xx genéricos. 5. **`extra_charges` cobra à parte do preço da consulta.** Quando o corpo pede serviços adicionais, a resposta traz cada um com o preço e um `total` que NÃO está incluso no valor base. Se você mostra custo a quem usa, some os dois. ## Ver também - Especificação OpenAPI: https://doc.apibrasil.io/apis/creditos/934dc874-871d-4b01-91bd-9784c1767236/openapi.json - Catálogo de APIs: [Catálogo de APIs](https://doc.apibrasil.io/apis.md) - SDKs oficiais: [SDKs oficiais](https://doc.apibrasil.io/sdks.md) - Índice da documentação: https://doc.apibrasil.io/llms.txt - Versão HTML desta página: https://doc.apibrasil.io/apis/creditos/934dc874-871d-4b01-91bd-9784c1767236