Atualização de Tracking
Este endpoint é chamado automaticamente quando ocorrem eventos de tracking (rastreamento) relacionados a um pedido. A API deve responder com um código HTTP 2XX (200, 201, etc.) em no máximo 10 segundos. Códigos de redirecionamento (3XX) não serão seguidos e serão considerados como falha.
TOKEN_NAME e o TOKEN_VALUE são parâmetros para garantir a segurança das informações, podem ser definidos quais são os valores utilizados. Após, esses dados devem ser encaminhados para a configuração pela Frenet para sempre serem enviados estes campos com os valor definidos nas chamadas de webhook.
Também vale ressaltar que esses dois parâmetros são opcionais, é apenas um fator de segurança a mais e que os webhooks funcionam mesmo sem enviar estes dados.
Exemplo de utilização:
TOKEN_NAME = FRENET_INTEGRATION
TOKEN_VALUE = 99A29DC8105FD2FA39D8CDC04733938D
Especificações Técnicas
Método HTTPPOSTHeaders Content-Type: application/json [TOKEN_NAME]: [TOKEN_VALUE] (Substitua [TOKEN_NAME] e [TOKEN_VALUE] pelas credenciais de autenticação).
Body (Exemplo)
{
"OrderId": "PLAT-ORDER-ID",
"ShipmentId": 21255,
"TrackingUrl": "https://rastreio-h01.frenet.dev/COR/TE123456785AA",
"TrackingNumber": "TE123456785AA",
"ServiceDescrition": "TESTE (OBJETO PARA TREINAMENTO)",
"TrackingEvents": [
{
"EventDateTime": "10/02/2017 16:48",
"EventDescription": "Objeto entregue ao destinatário",
"EventLocation": "Boa Nova-BA",
"EventType": "9"
}
]
}
Detalhes dos Campos
OrderId
Descrição: Identificador único do pedido na plataforma.
Tipo: String.
ShipmentId Descrição: Identificador único do envio. Tipo: Número inteiro.
TrackingUrl Descrição: URL para rastreamento do pedido. Tipo: String.
TrackingNumber Descrição: Número de rastreamento do pedido. Tipo: String.
TrackingEvents Descrição: Lista de eventos de tracking. Apenas o último evento é enviado. Campos: EventDateTime: Data e hora do evento (formato: dd/MM/yyyy HH:mm). EventDescription: Descrição do evento. EventLocation: Local onde o evento ocorreu. EventType: Código do tipo de evento (veja a lista de códigos abaixo).
Tipos de Eventos (EventType)
Código | Descrição |
---|---|
18 | Cliente entregou ao ponto de postagem e está aguardando coleta |
0 | Postado |
1 | Em trânsito |
2 | Atraso |
3 | Objeto Devolvido |
4 | Extravio |
9 | Objeto Entregue |
Updated 10 days ago