Pular para o conteúdo principal

API ConectEnvios V1

Referência Completa

Base URL: https://app.conectenvios.com.br/api/v1/ Staging: https://staging.conectenvios.com.br/api/v1/ Autenticação: Bearer Token


Autenticação

Todas as requisições devem incluir o header de autorização:

Authorization: Bearer {seu_token_aqui}
Accept: application/json

CEP

Validar e Consultar CEP

Retorna informações completas de um CEP incluindo IDs internos do sistema.

GET /cep/address/?cep={cep}

Parâmetros:

NomeTipoObrigatórioDescrição
cepstringSimCEP com 8 dígitos (sem hífen)

Exemplo de Requisição:

curl -X GET "https://app.conectenvios.com.br/api/v1/cep/address/?cep=72345000" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json"

Response (200 OK):

{
"error": false,
"message": [],
"data": {
"address": "QR 219",
"cep": "72345-000",
"city_id": 5564,
"city_title": "Brasília",
"complement": null,
"neighborhood": "Samambaia Norte (Samambaia)",
"state_abbreviation": "DF",
"state_id": 7,
"state_title": "Distrito Federal"
}
}

Cotação de Frete

Calcular Cotação Multi-Transportadora

Retorna cotações de todas as transportadoras disponíveis para a rota especificada.

POST /package/shipping
Content-Type: multipart/form-data

Parâmetros (form-data):

NomeTipoObrigatórioDescrição
typestringSimbox ou letter
weightintegerSimPeso em gramas
heightintegerPara boxAltura em cm
widthintegerPara boxLargura em cm
lengthintegerPara boxComprimento em cm
addr_from_cepstringSimCEP origem (8 dígitos)
addr_to_cepstringSimCEP destino (8 dígitos)
declared_valuedecimalNãoValor declarado em R$

Exemplo de Requisição:

curl -X POST "https://app.conectenvios.com.br/api/v1/package/shipping" \
-H "Authorization: Bearer {token}" \
-F "type=box" \
-F "weight=2000" \
-F "height=10" \
-F "width=20" \
-F "length=30" \
-F "addr_from_cep=70000000" \
-F "addr_to_cep=01310100"

Response (200 OK):

{
"error": false,
"data": [
{
"postal_company_id": 2,
"company_name": "Jadlog",
"company_code": "jadlog",
"name": "PICKUP",
"code": "11",
"price": 13.26,
"price_discounted": 13.26,
"price_formatted": "R$ 13,26",
"price_discounted_formatted": "R$ 13,26",
"deadline": 5,
"deadline_api": true,
"extra": 0,
"club": null
},
{
"postal_company_id": 1,
"company_name": "Correios",
"company_code": "correios",
"name": "PAC",
"code": "04510",
"price": 32.43,
"price_discounted": 31.79,
"price_formatted": "R$ 32,43",
"price_discounted_formatted": "R$ 31,79",
"deadline": 5,
"deadline_api": true,
"extra": 0,
"club": null
},
{
"postal_company_id": 1,
"company_name": "Correios",
"company_code": "correios",
"name": "SEDEX",
"code": "04014",
"price": 71.46,
"price_discounted": 70.04,
"price_formatted": "R$ 71,46",
"price_discounted_formatted": "R$ 70,04",
"deadline": 1,
"deadline_api": true,
"extra": 0,
"club": null
}
]
}

Rastreamento

Rastrear Envio por ID

Retorna histórico de eventos de rastreamento ordenado do mais recente ao mais antigo.

GET /package/track/:id

Parâmetros:

NomeTipoObrigatórioDescrição
idintegerSimID do pacote no sistema

Exemplo de Requisição:

curl -X GET "https://app.conectenvios.com.br/api/v1/package/track/12345" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json"

Response (200 OK):

{
"error": false,
"data": [
{
"city_id": 5270,
"city": "São Paulo",
"state_id": 26,
"state": "SP",
"correios_date": "2026-01-05T14:30:00.000000Z",
"correios_type": "RO",
"correios_status": null,
"description": "Objeto em trânsito - por favor aguarde",
"error_message": null
},
{
"city_id": 5564,
"city": "Brasília",
"state_id": 7,
"state": "DF",
"correios_date": "2026-01-04T10:00:00.000000Z",
"correios_type": "PO",
"correios_status": null,
"description": "Objeto postado",
"error_message": null
}
]
}

Tipos de Evento (correios_type):

CódigoDescrição
POPostagem
ROEm trânsito
DOEm distribuição
OECSaiu para entrega
BDEEntregue

Transportadoras

Listar Transportadoras

GET /postal_company

Response:

IDNomeCódigo
1Correioscorreios
2Jadlogjadlog
3AzulCargoazulcargo
4Loggiloggi
5JTExpressjtexpress

Serviços por Transportadora

GET /service?postal_company_id={id}

Correios (ID: 1):

  • MINI
  • PAC
  • SEDEX

Jadlog (ID: 2):

  • PACKAGE
  • .COM
  • PICKUP
  • RODOVIÁRIO

AzulCargo (ID: 3):

  • ECOMM
  • STANDARD

Loggi (ID: 4):

  • ECONOMIC
  • EXPRESS

JTExpress (ID: 5):

  • EZ

City

Listar Cidades

GET /city
GET /city?title={nome}
GET /city/:id

Response:

{
"error": false,
"data": [
{
"id": 5564,
"title": "Brasília",
"state_id": 7
}
]
}

User

Consultar Saldo

GET /user/balance

Response:

{
"error": false,
"data": {
"balance": 1500.00,
"currency": "BRL"
}
}

Códigos de Erro

Código HTTPDescrição
200Sucesso
400Requisição inválida
401Não autorizado
404Recurso não encontrado
422Erro de validação
429Rate limit excedido
500Erro interno

Formato de Erro:

{
"error": true,
"message": ["Descrição do erro"]
}

Formatos de Dados

TipoFormatoExemplo
Data/HoraISO 8601 UTC+02026-01-05T14:30:00.000000Z
CEP8 dígitos ou com hífen70000000 ou 70000-000
Telefone+55 (XX) XXXXX-XXXX+55 (61) 99999-9999
MoedaBRL com vírgulaR$ 45,90
PesoGramas (inteiro)2000 (= 2kg)
DimensõesCentímetros20 (= 20cm)

Rate Limiting

  • Limite: 60 requisições por período
  • Header de Resposta: X-RateLimit-Remaining


Contratos de API | Modelo de Dados →