Schema dos eventos de serviços (tipo task e service)

CampoTipoDescrição
currentObjectTodas as informações recebidas neste tipo de requisição estarão dentro do objeto current
current._idStringID do evento
current.entityObjetoObjeto contendo as informações do evento
current.entity.typeStringO tipo de entidade realizando o evnto ("job" - rota, "task" ou "service" - serviço)
current.entity.statusStringStatus do evento transmitido[2]
current.createdStringData em que o evento foi gravado no banco de dados [1]
current.dateStringData em que o evento realizado pelo operador [1]
current.actionStringAção executada (start/check_in/start_service/complete)
current.hashStringHash único de identificação desta ação
current.trackingHashStringHash de rastreamento do pedido
current.trackingStringURL de monitoramento para o cliente final
current.statusStringStatus da execução deste serviço [2]
current.valuesObjectCampo de metadata [3]
current.servicesArrayArray com os dados dos clientes (dados enviados previamente no delivery group)
current.services.codeStringCódigo do cliente
current.services.nameStringNome do cliente
current.services.invoice_numberStringNúmero da nota fiscal
current.services.order_numberStringNúmero do pedido
current.services.shipment_numberStringNúmero da remessa
current.jobObjectContém os dados de contato do operador e informações da rota
current.job.idStringId do Job
current.job.due_dateStringData final de entrega
current.job.routingStringId da rota
current.job.routeObjectContém dados da rota
current.job.route.idStringId da rota
current.job.route.nameStringNome da rota
current.job.operadorObjectDados do operador
current.job.operador.displayNameStringNome do operador
current.job.operador.documentNumberStringDocumento do operador
current.job.operador.license_plateStringPlaca do veículo do operador
current.job.operador.phoneArrayTelefone(s) o do operador

[1]: Não necessariamente a data em que o evento foi criado é a mesma em que o evento foi enviado. O evento pode ser criado pelo operador às 12:06, mas não enviado por falta de sinal. Ao retomar o sinal, às 12:22 por exemplo, o evento será disparado e o horário armazenado no campo created.

Status dos serviços

Assim como os eventos de serviço, os status dos serviços podem ser:

CampoDescrição
on_transitEm trânsito para o cliente (Rota iniciada)
on_routeEm trânsito para o cliente (Próximo atendimento)
arrivedNo local da execução do serviço
servicingServiço em execução
completedServiço finalizado

Informações que podem ser comunicadas em cada evento

Diversas informações podem ser enviadas junto com os eventos comunicados pelo motorista. Essas informações serão apresentados no objeto {values} e possuem as propriedades: key, value, label e type.

occurrence_codeCódigo da ocorrência. Dentro deste objeto estarão as informações a respeito da ocorrência que foi registrada pelo operador
completion_typeAqui podemos ver se o evento de “completed” foi completo com sucesso ou não. Os valores são success ou failure
descriptionDescrição da ocorrência
commentsComentários do operador ao finalizar o serviço
nameNome do cliente que atendeu o operador
documentDocumento do cliente que atendeu o operador
file_signatureArquivo de assinatura digital. O value deste campo é um array que pode receber múltiplas imagens (em base 64)
file_photoArquivo de foto coletada pelo operador. O value deste campo e um array que pode receber múltiplas imagens (em base 64)
latLatitude do momento do disparo do evento
lngLongitude do momento do disparo do evento
deviceID do dispositivo usado pelo operador