Buscar Hash

Schema da Response

Para realizar a consulta de um serviço é necessário possuir em mãos o {trackingHash} deste serviço. Para isso, deve-se habilitar o webhook de "Criação do Serviço" na plataforma do RoutEasy que irá enviar para o endpoint cadastrado as o {trackingHash} do pedido no RoutEasy. Ver a documentação disponível em Criação do serviço para o exemplo de Evento de Criação do serviço no RoutEasy.

CampoTipoDescrição
taskObjectTodas as informações referentes ao Serviço, incluindo o ETA
task._idStringID da task
task.locationObjetoObjeto contendo as informações do cliente
task.location.typeStringTipo da task (service, break, depot), para este caso será sempre service
task.location.loadsArray de numbersArray contendo as dimensões do serviço
task.location.service_typeStringTipo de serviço a ser executado (service, delivery, pickup)
task.location._idStringID da location
task.location.codeStringCódigo do cliente
task.location.nameStringNome do cliente
task.location.addressObjetoObjeto contendo as informações de endereço do cliente
task.location.address.routeStringLogradouro
task.location.address.street_numberStringNúmero
task.location.address.additional_infoStringComplemento
task.location.address.neighborhoodStringBairro
task.location.address.cityStringCidade
task.location.address.stateStringEstado
task.location.address.postal_codeStringCEP
task.location.address.countryStringContém dados da rota
task.location.address.formatted_addressStringEndereço completo
task.location.address.geocodeObjetoObjeto contendo as informações de latitude e longitude
task.location.address.geocode.latStringLatitude
task.location.address.geocode.latStringLongitude
task.location.invoice_numberStringNota Fiscal
task.location.order_numberStringNúmero do Pedido
task.location.service_timeFloatTempo de Serviço
task.location.emailStringE-mail
task.location.phoneStringTelefone
task.location.additional_infoStringObservações
task.location.additional_info_1StringObservações 2
task.location.additional_info_2StringObservações 3
task.location.siteStringID da filial
task.typeStringTipo da task (service, break, depot), para este caso será sempre service
task.orderNumberOrdem do serviço na rota
task.servicesArray de objetosCaso seja um serviço consolidado, irá conter os serviços presentes dentro do consolidado
task.hashStringHash única do serviço
task.visibilityUrlStringLink de acompanhamento do cliente final
task.currentStatusStringStatus atual do serviço. Maiores detalhes dos possíveis status: Eventos de serviços consolidados
task.planned_arrival_timeDateData planejada de chegada
task.planned_departure_timeDateData planejada de partida
task.estimated_arrival_timeDateData estimada de chegada
task.estimated_departure_timeDateData estimada de partida
Language
Authorization
Header
Click Try It! to start a request and see the response here!