https://github.com/diegotl/pacotevicio-api-correios
API para rastreamento de encomendas dos Correios. Status de objetos postais com retorno em JSON.
https://github.com/diegotl/pacotevicio-api-correios
aliexpress api cainiao correios encomenda json pacote rastreamento rastreio rest
Last synced: about 1 month ago
JSON representation
API para rastreamento de encomendas dos Correios. Status de objetos postais com retorno em JSON.
- Host: GitHub
- URL: https://github.com/diegotl/pacotevicio-api-correios
- Owner: diegotl
- Created: 2025-05-27T10:44:57.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-05-28T22:51:19.000Z (5 months ago)
- Last Synced: 2025-06-06T12:06:33.984Z (4 months ago)
- Topics: aliexpress, api, cainiao, correios, encomenda, json, pacote, rastreamento, rastreio, rest
- Homepage: https://pacotevicio.dev
- Size: 12.7 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📦 API PacoteVício - Rastreamento de Encomendas Correios, AliExpress, Shopee Xpress, Anjun Express e Loggi
Documentação da API PacoteVício para rastreamento de objetos dos Correios do Brasil, pacotes do AliExpress, Shopee Xpress, Anjun Express e Loggi.
Veja mais informações na [página oficial da API PacoteVício](http://pacotevicio.dev).
## 🔗 Acesso à API
A API é fornecida através da plataforma RapidAPI.
Oferecemos um plano gratuito com até 1.000 requisições/mês, o que deve atender à maioria das necessidades.
- [Página no RapidAPI](https://rapidapi.com/pacotevicio-pacotevicio-default/api/correios-rastreamento-de-encomendas)
## 🛠️ Como Utilizar
### 1. Obter uma Chave de API
Para utilizar esta API, é necessário obter uma chave de API através do RapidAPI:
1. Acesse o [RapidAPI](https://rapidapi.com/pacotevicio-pacotevicio-default/api/correios-rastreamento-de-encomendas)
2. Escolha o plano desejado (para iniciar recomendamos o BASIC que é gratuito)
3. Crie uma conta caso seja necessário
4. Sua chave de API (X-RapidAPI-Key) estará disponível na [área de testes](https://rapidapi.com/pacotevicio-pacotevicio-default/api/correios-rastreamento-de-encomendas/playground/apiendpoint_19d15e2c-d3a9-422f-9da1-05881c97f70d)
## 💻 Endpoints Disponíveis
A API suporta múltiplos serviços de rastreamento, todos com a mesma estrutura de requisição. Basta alterar o endpoint conforme o serviço desejado:
| Serviço | Endpoint | Observações |
|-----------------|-------------------|---------------------------------------------|
| Correios | `/correios` | Rastreamento dos Correios do Brasil |
| AliExpress | `/aliexpress` | Rastreamento de pacotes AliExpress |
| Shopee Xpress | `/shopee` | Rastreamento de pacotes Shopee Xpress |
| Anjun Express | `/anjun` | Rastreamento de pacotes Anjun Express |
| Loggi | `/loggi` | Rastreamento de pacotes Loggi |
### Parâmetros Comuns
Todos os endpoints acima aceitam os mesmos parâmetros:
| Parâmetro | Tipo | Obrigatório | Descrição |
|-------------------|--------|-------------|---------------------------------------------------------------------------------------------|
| `tracking_code` | string | Sim | Código de rastreamento do pacote. Aceita diversos formatos internacionais. |
| `confidence_level`| string | Não | Nível de confiança para tentativas de rastreamento em caso de falha. Valores: `low`, `medium`, `high`. Padrão: `high`. |
| `language` | string | Não | Idioma da resposta. Valores: `pt-BR`, `en-US`, `fr-FR`, `zh-CN`. Padrão: `en-US`. |
> **Nota:** O parâmetro `language` só é aceito para AliExpress.
#### Sobre `confidence_level`
Este parâmetro define o nível de esforço da API para tentar obter uma resposta dos Correios em situações de instabilidade do mesmo.
- `low`: não haverá novas tentativas. Garante resposta no pior cenário que não ultrapassará ~10 segundos, ao custo de uma menor chance de sucesso.
- `medium`: serão feitas algumas tentativas. No pior cenário levará ~20 segundos e uma chance maior de sucesso.
- `high`: mais tentativas serão feitas. No pior cenário pode demorar até ~30 segundos, mas tem maior chance de retorno com sucesso.
Escolha e ajuste o timeout de seu cliente conforme a necessidade da sua aplicação. Se o parâmetro for omitido, o valor padrão será `high`.
### Exemplo de Requisição com cURL
```bash
curl -X GET "https://api.pacotevicio.dev/correios?tracking_code=AM101610575BR" \
--header "X-RapidAPI-Key: SUA_CHAVE_DE_API"
```
Troque `/correios` por `/aliexpress`, `/shopee`, `/anjun` ou `/loggi` conforme o serviço desejado.
---
## 📋 Resposta
Exemplo de resposta - Correios
```json
{
"codObjeto": "AM101610575BR",
"tipoPostal": {
"sigla": "AM",
"descricao": "ETIQUETA LOGICA PAC",
"categoria": "ENCOMENDA PAC",
"tipo": "N"
},
"dtPrevista": "20/03/2025",
"modalidade": "F",
"eventos": [
{
"codigo": "BDE",
"tipo": "01",
"dtHrCriado": {
"date": "2025-03-03 23:30:03.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"descricao": "Objeto entregue ao destinatário",
"unidade": {
"codSro": "50630977",
"tipo": "Unidade de Tratamento",
"endereco": {
"cidade": "Recife",
"uf": "PE"
}
},
"unidadeDestino": null,
"descricaoFrontEnd": "ENTREGUE",
"finalizador": "S",
"rota": "CONTEXTO",
"descricaoWeb": "ENTREGUE",
"detalhe": "Nossa entrega atendeu às suas expectativas? Conte pra gente: https://survey3.medallia.com/?correios-nps-sms-sro&obj=AM101610575BR",
},
{
"codigo": "PO",
"tipo": "09",
"dtHrCriado": {
"date": "2025-02-24 15:51:29.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"descricao": "Objeto postado após o horário limite da unidade",
"unidade": {
"codSro": "65995970",
"tipo": "Agência dos Correios",
"endereco": {
"cidade": "Feira Nova do Maranhao",
"uf": "MA",
}
},
"unidadeDestino": null,
"descricaoFrontEnd": "Postado depois do horário",
"finalizador": "N",
"rota": "NORMAL",
"descricaoWeb": "POSTAGEM",
"detalhe": "Sujeito a encaminhamento no próximo dia útil",
}
],
"situacao": "E",
"autoDeclaracao": false,
"encargoImportacao": false,
"percorridaCarteiro": false,
"bloqueioObjeto": false,
"arEletronico": false,
"atrasado": false
}
```
Exemplo de resposta - AliExpress
```json
{
"mailNo": "LP00123456789CN",
"originCountry": "Mainland China",
"destCountry": "Brazil",
"status": "CLEAR_CUSTOMS",
"statusDesc": "In customs ",
"mailNoSource": "AE",
"globalEtaInfo": {
"etaDesc": "Estimated delivery by",
"deliveryMinTime": 1749006268984,
"deliveryMaxTime": 1750475068984
},
"detailList": [
{
"time": 1748410407000,
"timeStr": "2025-05-28 13:33:27",
"desc": "",
"standerdDesc": "Import customs clearance complete",
"descTitle": "Carrier note:",
"timeZone": "GMT-3",
"actionCode": "CC_IM_SUCCESS"
},
{
"time": 1747839077000,
"timeStr": "2025-05-21 22:51:17",
"desc": "",
"standerdDesc": "[Shatian Town] Processing at sorting center",
"descTitle": "Carrier note:",
"timeZone": "GMT+8",
"actionCode": "SC_INBOUND_SUCCESS"
},
{
"time": 1747805584000,
"timeStr": "2025-05-21 13:33:04",
"desc": "",
"standerdDesc": "Received by logistics company",
"descTitle": "Carrier note:",
"timeZone": "GMT+8",
"actionCode": "PU_PICKUP_SUCCESS"
}
],
"daysNumber": "8\tday(s)"
}
```
Exemplo de resposta - Shopee
```json
{
"sls_tracking_number": "BR2561249217932",
"need_translate": 0,
"delivery_type": "SHOPEE_CREDIT",
"recipient_name": "",
"phone": "",
"current_status": "Delivered",
"tracking_list": [
{
"timestamp": 1749140169,
"status": "Delivered",
"message": "[LM Hub_MG_Uberlândia] Your parcel has been delivered [Fulano da Silva] [ Receptionist]"
},
{
"timestamp": 1749122864,
"status": "Delivering",
"message": "[LM Hub_MG_Uberlândia] Your parcel is being delivered by courier"
},
{
"timestamp": 1749089703,
"status": "LMHub_Received",
"message": "[LM Hub_MG_Uberlândia] Your parcel has been received by delivery hub"
},
{
"timestamp": 1749034791,
"status": "SOC_LHTransporting",
"message": "Parcel [TO202506041ZAJ7] transporting to [LM Hub_MG_Uberlândia]"
},
{
"timestamp": 1748937958,
"status": "SOC_Received",
"message": "[SoC_SP_Santana] Your parcel has been received by sorting center"
},
{
"timestamp": 1748906285,
"status": "SOC_Pickup_Done",
"message": "[SoC_SP_Santana] Your parcel has been picked up"
},
{
"timestamp": 1748904099,
"status": "DOP_Received",
"message": "Your parcel has been received by drop off point"
},
{
"timestamp": 1748893392,
"status": "Created",
"message": "Order has been created"
}
],
"status_list": [
{
"timestamp": 1748893392,
"code": 1,
"text": "Created",
"state_ls": "Created",
"icon": "Order Created"
},
{
"timestamp": 1748937958,
"code": 1,
"text": "Pending_Receive",
"state_ls": "Pending_Receive",
"icon": "Picked Up"
},
{
"timestamp": 1749089703,
"code": 1,
"text": "Pending",
"state_ls": "Pending",
"icon": "Sorting"
},
{
"timestamp": 1749122864,
"code": 1,
"text": "Assigned",
"state_ls": "Assigned",
"icon": "Courier Delivery"
},
{
"timestamp": 1749140169,
"code": 1,
"text": "Delivered",
"state_ls": "Delivered",
"icon": "Delivered"
}
]
}
```
Exemplo de resposta - Anjun
```json
{
"clCollectOrder": {
"scan_time": null,
"bag_sealing_time": null,
"signer_time": null
},
"movementInTheSorter": null,
"shippingCompany": [
{
"date": "2025-01-21T12:22:13.000Z",
"status": "O pacote foi assinado para",
"signTypeName": "Objeto entregue pelo próprio",
"signType": 0,
"address": "Sorocaba / SP",
"remark": "",
"limiteDate": ""
},
{
"date": "2025-01-14T08:56:55.000Z",
"status": "Objeto saiu para entrega ao destinatário",
"signTypeName": null,
"signType": null,
"address": "Sorocaba / SP",
"remark": "",
"limiteDate": ""
},
{
"date": "2025-01-13T17:00:16.000Z",
"status": "Objeto saiu para entrega ao destinatário",
"signTypeName": null,
"signType": null,
"address": "Sorocaba / SP",
"remark": "",
"limiteDate": ""
},
{
"date": "2025-01-13T11:24:46.000Z",
"status": "Objeto saiu para entrega ao destinatário",
"signTypeName": null,
"signType": null,
"address": "Sorocaba / SP",
"remark": "",
"limiteDate": ""
},
{
"date": "2025-01-13T11:23:22.000Z",
"status": "Objeto saiu para entrega ao destinatário",
"signTypeName": null,
"signType": null,
"address": "Sorocaba / SP",
"remark": "",
"limiteDate": ""
},
{
"date": "2025-01-10T17:25:10.000Z",
"status": "Objeto chegou ao ponto de entrega",
"signTypeName": null,
"signType": null,
"address": "Sorocaba / SP",
"remark": "",
"limiteDate": ""
},
{
"date": "2025-01-10T11:37:05.000Z",
"status": "Objeto saiu do CD",
"signTypeName": null,
"signType": null,
"address": "São Paulo / SP",
"remark": "",
"limiteDate": ""
},
{
"date": "2025-01-10T08:56:52.000Z",
"status": "O pacote unitizada está finalizada",
"signTypeName": null,
"signType": null,
"address": "São Paulo / SP",
"remark": "",
"limiteDate": ""
},
{
"date": "2025-01-10T08:47:09.000Z",
"status": "Transferência e armazenagem",
"signTypeName": null,
"signType": null,
"address": "São Paulo / SP",
"remark": "",
"limiteDate": ""
}
]
}
```
Exemplo de resposta - Loggi
```json
{
"packages": [
{
"loggiKey": "M5UDCZLG3JCXIN5HUTNVTWQVD5",
"trackingCode": "ME251TCU021BR",
"companyId": 1712416,
"promisedDate": "2025-05-29T02:00:00Z",
"slo": 4,
"serviceType": "Unknown",
"labelled": true,
"packaged": true,
"status": {
"statusCode": 2,
"label": "Entregue"
},
"recipient": {
"name": "João",
"document": "999.***.***-99",
"phone": "99*****99",
"address": {
"street": "Avenida ****",
"number": "999",
"complement": "1B",
"neighborhood": "In**********",
"city": "São Pa***",
"state": "SP",
"postalCode": "*****-999"
}
},
"sender": {
"name": "ABC",
"address": {
"postalCode": "*****-999"
}
},
"deviation": {},
"pickup": {
"pickupType": "PICKUP_TYPE_DEDICATED"
},
"history": {
"history": [
{
"statusCode": 2,
"label": "Entregue",
"updateTime": "2025-05-26T15:50:31Z"
},
{
"statusCode": 3,
"label": "Retirado",
"location": "Base São Paulo - Mooca, São Paulo - SP",
"updateTime": "2025-05-26T08:24:42.296641Z"
},
{
"statusCode": 89,
"label": "Transferência finalizada",
"location": "Base São Paulo - Mooca, São Paulo - SP",
"updateTime": "2025-05-26T08:24:02.702001Z"
},
{
"statusCode": 88,
"label": "Transferência iniciada",
"location": "Base Cajamar 2, Cajamar - SP",
"updateTime": "2025-05-24T03:22:40.415135Z"
},
{
"statusCode": 83,
"label": "Volumetrizado",
"updateTime": "2025-05-24T02:05:03.218700Z"
},
{
"statusCode": 89,
"label": "Transferência finalizada",
"location": "Base Cajamar 2, Cajamar - SP",
"updateTime": "2025-05-24T01:12:05.900500Z"
},
{
"statusCode": 88,
"label": "Transferência iniciada",
"location": "Base XD - Brasília, Brasília - DF",
"updateTime": "2025-05-23T06:23:49.198770Z"
},
{
"statusCode": 89,
"label": "Transferência finalizada",
"updateTime": "2025-05-23T05:08:13.608395Z"
},
{
"statusCode": 88,
"label": "Transferência iniciada",
"location": "Base Goiania - Aparecida de Goiania, Aparecida de Goiânia - GO",
"updateTime": "2025-05-22T07:23:05.786885Z"
},
{
"statusCode": 84,
"label": "Conferido",
"updateTime": "2025-05-22T07:17:31.444388Z"
},
{
"statusCode": 91,
"label": "Arquivo integrado",
"location": "Base Goiania - Aparecida de Goiania, Aparecida de Goiânia - GO",
"updateTime": "2025-05-21T20:47:43.681629Z"
}
]
},
"deliveryDirection": {
"code": 1,
"text": "Em direção de entrega"
},
"associatedService": {
"name": "Loggi Nacional",
"description": "Envio com Coleta fixa dedicada e Entrega na Porta do destinatário.",
"externalServiceId": "DLVR-DEDI-DOOR-STAN-01",
"serviceSpecificationCategory": "PARCEL_DELIVERY",
"mileComponentsFirstMile": "PICKUP_TYPE_DEDICATED",
"mileComponentsMiddleMile": "PROCESSING_TYPE_STANDARD",
"mileComponentsLastMile": "DELIVERY_TYPE_CUSTOMER_DOOR"
}
}
],
"proofOfDeliveryDetails": {
"loggiKey": "M5UDCZLG3JCXIN5HUTNVTWQVD6",
"trackingCode": "ME251TCU021BR",
"deliveryDate": "2025-05-26T15:50:31Z",
"deliveryLocation": {
"street": "Avenida J****",
"number": "999",
"complement": "1B",
"neighborhood": "Ba**********",
"city": "São Pa***",
"state": "SP",
"postalCode": "*****-011"
},
"deliveryInfo": "Na portaria",
"receivedBy": {
"name": "João",
"document": "99.***.***-9x"
},
"receiptUrl": "https://dnni6puux43rok3alyymdo3dw40hifgi.lambda-url.us-east-1.on.aws/?secret-id=380ac47d2e&tracking-key=ME251TCU021BR",
"deliveryDriver": {
"info": "Entregador individual"
},
"recipient": {
"name": "José"
},
"sender": {
"name": "ABC"
},
"sourceApp": "Loggi para entregar"
}
}
```