Passar para o conteúdo principal

[GCL] API de Logística - Rastreamento

Juliana Maciel Maruri da Cunha avatar
Escrito por Juliana Maciel Maruri da Cunha
Atualizado essa semana

Obtenha detalhes de rastreamento de um pacote e o status atual.

Retorne o shortUid do pedido e os pontos de verificação que indicam o status atual e as atualizações do pacote.

GET /v1/tracking/{trackingNumber}

Exemplo de solicitação

/v1/tracking/EXMPL0001234TRCKNUM

Exemplo de resposta de sucesso

{  "shortUid": "EXMPL0001234",  "trackingNumber": "EXMPL0001234TRCKNUM",  "trackingUrl": "https://mydhl.express.dhl/no/en/tracking.html#/results?id=EXMPL0001234TRCKNUM",  "shipmentMethodUid": "dhl_express_worldwide",  "shipmentMethodName": "DHL Express Worldwide",  "carrierUid": "dhl_express",  "carrierName": "DHL Express",  "weightInGrams": "460",  "checkpoints": [    {      "status": 6,      "message": "Delivered",      "description": "Delivered",      "location": "LONDON-GBR, United Kingdom",      "createdAt": "2024-07-29T18:16:06Z",      "expectedDeliveryDate": "",      "statusUid": "delivered",      "signedBy": "aftership"    },    {      "status": 2,      "message": "Shipment is out with courier for delivery",      "description": "Out for Delivery",      "location": "LONDON-GBR, United Kingdom",      "createdAt": "2024-07-29T08:58:40Z",      "expectedDeliveryDate": "",      "statusUid": "out_for_delivery",      "signedBy": "aftership"    },    {      "status": 1,      "message": "Arrived at DHL Sort Facility LONDON-HEATHROW-GBR",      "description": "Arrival scan",      "location": "LONDON-HEATHROW-GBR, United Kingdom",      "createdAt": "2024-07-29T00:35:29Z",      "expectedDeliveryDate": "",      "statusUid": "in_transit",      "signedBy": "aftership"    },    {      "status": 1,      "message": "Scheduled to depart on the next planned movement",      "description": "Departure Scan",      "location": "EAST MIDLANDS-GBR, United Kingdom",      "createdAt": "2024-07-28T12:02:21Z",      "expectedDeliveryDate": "2024-07-30",      "statusUid": "in_transit",      "signedBy": "aftership"    },    {      "status": 1,      "message": "Customs clearance status updated. Note - The Customs clearance process may start while the shipment is in transit to the destination.",      "description": "Customs clearance started",      "location": "EAST MIDLANDS-GBR, United Kingdom",      "createdAt": "2024-07-26T13:00:23Z",      "expectedDeliveryDate": "2024-07-30",      "statusUid": "in_transit",      "signedBy": "aftership"    },    {      "status": 1,      "message": "Shipment has departed from a DHL facility ULM-DEU",      "description": "Departure Scan",      "location": "ULM-DEU, Germany",      "createdAt": "2024-07-25T16:41:58Z",      "expectedDeliveryDate": "2024-07-30",      "statusUid": "in_transit",      "signedBy": "aftership"    },    {      "status": 1,      "message": "Shipment picked up",      "description": "Acceptance scan",      "location": "ULM-DEU, Germany",      "createdAt": "2024-07-25T14:21:55Z",      "expectedDeliveryDate": "2024-07-30",      "statusUid": "in_transit",      "signedBy": "aftership"    }  ]}

Exemplo de resposta de erro

{  "trackingNumber": "EXMPL0001234TRCKNUM",  "code": "TRACKING_DETAILS_NOT_FOUND",  "message": "Tracking details not found.",  "details": null}

Request

Parameter

Tipo

Descrição

trackingNumber (obrigatório)

string

O número de rastreamento do pacote fornecido pela transportadora

Resposta bem-sucedida

Parameter

Tipo

Descrição

shortUid (obrigatório)

string

Um identificador curto único para a resposta

trackingNumber (obrigatório)

string

O número de rastreamento do pacote

trackingUrl (opcional)

string

URL de rastreamento da transportadora para o pacote

shipmentMethodUid (opcional)

string

UID do método de envio usado para entregar o pacote

shipmentMethodName (opcional)

string

Nome do método de envio usado para entregar o pacote

carrierUid (opcional)

string

UID da transportadora usada para entregar o pacote

carrierName (opcional)

string

Nome da transportadora utilizada para entregar o pacote

weightInGrams (opcional)

string

Peso do pacote em gramas

checkpoints (opcional)

CheckPoint[]

Uma matriz de objetos CheckPoint (pode estar vazia)

CheckPoint

Parameter

Tipo

Descrição

status (obrigatório)

número

Número de ID do status

statusUid (obrigatório)

string

Status UID (ver StatusEnum)

message (obrigatório)

string

Mensagem de status

description (opcional)

string

Descrição do status

location (opcional)

string

Localização atual do pacote (endereço)

createdAt (obrigatório)

string

Status criado em (RFC3339)

expectedDeliveryDate (opcional)

string

Data prevista de entrega (YYYY-MM-DD). Exemplo: 2024-01-21

signedBy (obrigatório)

string

Qual Provedor/Serviço assinou

StatusEnum

Valor do Status

Descrição

registrado

Representa o status de registro

em_trânsito

Representa o status em trânsito

em_rota_de_entrega

Representa o status de saída para entrega

tentativa falha

Representa o status de tentativa falha

exceção de envio

Representa o status de exceção de envio

disponível para retirada

Representa o status disponível para retirada

entregue

Representa o status de entregue

enviado

Representa o status de despachado

devolvido

Representa o status de devolução

não retirado

Representa o status de não coletado

Resposta de erro

Parameter

Tipo

Descrição

número de rastreamento

string

O número de rastreamento do pacote

código

string

Código de erro

mensagem

string

Mensagem de erro

details (opcional)

Detalhes do Erro de Resposta

Detalhes adicionais do erro

Detalhes do Erro de Resposta

Parameter

Tipo

Descrição

código

string

Código de erro.

mensagem

string

Mensagem de erro

referência (opcional)

string

ID de referência.


📝 Não é o que você precisava?

Ajude-nos a melhorar este artigo, envie-nos um e-mail para [email protected] — por favor, inclua o título do artigo.

Respondeu à sua pergunta?