Snippets
Para realizar o rastreio serão necessários 3 endpoints diferentes. O ponto de partida é sempre o código do pedido, disponível após fechá-lo através da nossa plataforma (https://cargobr.com). Ele deve ser utilizado no lugar de <user_id> (sem utilizar <>).
Consultar datas de entrega
Para consultar as datas de previsão e/ou execução da entrega, é necessário utilizar o endpoint abaixo:
GET https://homolog-api.cargobr.com/v3/orders/tracking/?order_id=<order_id>
Exemplo de resposta:
[
{
"id": 1476140,
"order_id": "6Y8SZJ",
"real_date_delivered": "2019-09-30",
"date_delivered_marked": "2019-09-30T19:05:19Z",
"adjust_date_delivered": null
}
]
date_delivered_marked = Previsão de entrega inicial
adjust_date_delivered = Previsão de entrega ajustada
real_date_delivered = Data em que foi entregue
Consultar ocorrências de entrega
Para consultar as ocorrências de entrega, é necessário utilizar o endpoint abaixo:
GET https://homolog-api.cargobr.com/v2/edi/ocoren/?order_id=<order_id>
Exemplo de resposta:
{
"count": 3,
"next": null,
"previous": null,
"results": [
{
"id": 331094,
"occurred_at": "2019-12-05T18:07:00Z",
"created_at": "2019-12-05T18:33:23.829496Z",
"delivery_occurrence_code": "13009",
"description": "ENTREGUE - INFORMADA ATRAVES DA CHAVE 35191213206664000153570010004412",
...
},
{
"id": 330851,
"occurred_at": "2019-12-05T10:48:00Z",
"created_at": "2019-12-05T11:03:30.685371Z",
"delivery_occurrence_code": "13008",
"description": "Saida para entrega na cidade FRANCO DA ROCHA.",
...
},
{
"id": 330640,
"occurred_at": "2019-12-05T02:59:00Z",
"created_at": "2019-12-05T03:07:27.555889Z",
"delivery_occurrence_code": "13005",
"description": "CT-e autorizado com 1 volume e 37 Kg. Destino: SP/FRANCO DA ROCHA. Pre",
...
}
]
}
Cada item dentro do results representa uma ocorrência deste pedido. Cada ocorrência possui uma quantidade bem grande de campos, mas os únicos que são necessários para a sua integração são:
occurred_at = data e hora da ocorrência
delivery_occurrence_code = código da ocorrência
description = descrição extra da ocorrência (nem sempre é preenchido pela transportadora)
Consultar códigos de ocorrência
Por fim, para obter o significado de cada código de ocorrência existe um último endpoint, que segue abaixo. Esta lista de códigos raramente é atualizada (menos de uma vez por mês), portanto é melhor consultar uma vez para pegar os resultados, deixá-los armazenados no seu sistema e atualizar uma vez por mês.
GET https://homolog-api.cargobr.com/v2/edi/ocoren/schema/
Exemplo de retorno:
{
"constants": {
"delivery_occurrence_code": {
"00043": "Feriado local/nacional",
"07004": "Pedido Cancelado",
"05171": "Cte Complementar",
...
}
}
}
Comments (0)
You can clone a snippet to your computer for local editing. Learn more.