[{"_id":"project-settings","settings":{"translateMetaTags":true,"translateAriaLabels":true,"translateTitle":true,"showWidget":true,"customWidget":{"theme":"dark","font":"rgb(255,255,255)","header":"rgb(0,0,0)","background":"rgba(0,0,0,0.8)","position":"right","positionVertical":"bottom","border":"","borderRequired":false,"widgetCompact":true},"widgetLanguages":[],"activeLanguages":{"en":"English","pt-BR":"Português (Brasil)"},"enabledLanguages":["en","pt-BR"],"debugInfo":false,"displayBranding":true,"displayBrandingName":true,"localizeImages":false,"localizeImagesLimit":true,"localizeAudio":false,"localizeAudioLimit":true,"disabledPages":[],"regexPhrases":[],"blockedClasses":false,"blockedIds":false,"phraseDetection":true,"customDomainSettings":[],"seoSetting":[],"translateSource":false,"overage":false,"detectPhraseFromAllLanguage":false,"googleAnalytics":false,"mixpanel":false,"heap":false},"version":912},{"_id":"pt-BR","source":"pt-BR","pluralFn":"return n != 1 ? 1 : 0;","pluralForm":2,"dictionary":{},"version":912},{"_id":"outdated","outdated":{"#Grupo de Pedidos é o objeto que deve ser enviado no corpo da requisição POST. Basicamente, ele é um objeto que contém um array de deliveries e o nome da roteirização para rápida identificação dentro do sistema. Então para iniciar com esta modalidade de integração, deve-se montar primeiro o delivery ...":1,"#Next Page: Atualizar Grupo":1,"#Para criar um grupo, envie uma requisição do tipo [POST], com o objeto montado para <a ljsid-1=\"\">https://comapny.routeasy.com.br/company/groups</a>":1,"#Boleano que caracteriza o grupo com origem externa à routeasy":1,"#Lista dos membros do grupo":1,"#Objeto com lista de atribuições e filiais":1,"#Nome que descreve o grupo":1,"#Código único que identifica o grupo":1,"#Esse campo é um identificador da rota e é utilizado para edita-la em caso de alterações de pedidos por exemplo":1,"#Código da Rota":1,"#Para realizar as integrações com a SSW é necessário configurar a geração de token.":1,"#A tela do Relatório de Atividades mostra as atividades realizadas na plataforma, inclusive erros na configuração da geração de token":1,"#Após salvar, é possível saber se houve algum erro na configuração, acessando a tela de Relatório de Atividades (menu lateral -> clicar no nome da empresa -> Relatório de Atividades)":1,"#Senha: senha fornecida pela SSW":1,"#Nome de usuário: usuário fornecido pela SSW":1,"#Domínio: domínio fornecido pela SSW":1,"#CNPJ: mesmo CNPJ utilizado ao solicitar o cadastro ao programa EDI \"ssw2173 - Autoriza geracao do token via WebAPI\"":1,"#Na seção <strong ljsid-1=\"\">Integrações de exportação de eventos</strong> dentro da página de webhooks, clicar em \"Criar nova integração de exportação de eventos\" selecionar o tipo SSW, com as informações:":1,"#Previous Page: Configuração de Webhook ESL":1,"#Skip link to Importante":1,"#Para permitir a geração do token através deste processo, o cliente deve solicitar a transportadora o cadastro do programa EDI \"ssw2173 - Autoriza geracao do token via WebAPI\" com o mesmo cnpj que será passado nesta api, junto a SSW.":1,"#Importante":1,"#Previous Page: Grupos":1,"#Next Page: Rota única":1,"#Previous Page: Importação de Pedidos SSW":1,"#Horários planejados, estimados e realizados para esse pedido":1,"#Avaliação final do cliente para esse pedido (se houver)":1,"#Última ação/evento realizado para esse pedido":1,"#Atual status do pedido":1,"#Dentre as informações retornadas, as principais são:":1,"#A consulta por Hash tem por objetivo retornar as principais informações referentes a um pedido despachado para a Torre de Controle do RoutEasy.":1,"#Previous Page: Motoristas":1,"#Next Page: Criar grupo":1,"#Para listar seus grupos, basta fazer uma requisição GET para o endpoint <a ljsid-1=\"\">https://company.routeasy.com.br/company/groups</a>":1,"#Next Page: Membros":1,"#Skip link to Webhook de exportação da roteirização":1,"#Introdução":1,"#<strong ljsid-0=\"\">ESL</strong>: exportação no formato <a ljsid-2=\"\">ESL</a>":1,"#<strong ljsid-0=\"\">RoutEasy v3</strong>: exportação no formato padrão da RoutEasy (<a ljsid-2=\"\">Objeto Version</a>), com paradas desconsolidadas, ou seja, caso haja uma consolidação, os pedidos dentro do consolidado estarão presentes todos dentro de \"results.routes.delivery_order\"":1,"#<strong ljsid-0=\"\">RoutEasy</strong>: exportação no formato padrão da RoutEasy (<a ljsid-2=\"\">Objeto Version</a>), com paradas consolidadas, ou seja, caso haja uma consolidação, os pedidos dentro do consolidado serão representados por um pedido único dentro de \"results.routes.delivery_order\", o restante será apresentado em \"routing.data.services\".":1,"#Tipos de webhook de roteirização:":1,"#Para cadastrar um webhook, clicar em \"Criar novo Webhook\", escolher o tipo, preencher a URL, e, caso necessário, os headers como pares key value.":1,"#Webhook de exportação da roteirização":1,"#Next Page: Configuração de Webhook ESL":1,"#Previous Page: Buscar Hash":1,"#<strong ljsid-0=\"\">ESL</strong>: Formato utilizado para quem possui integração com a <a ljsid-2=\"\">ESL</a>.":1,"#<strong ljsid-0=\"\">SSW</strong>: Formato utilizado para quem possui integração com a SSW <strong ljsid-2=\"\">(necessário realizar a <a ljsid-2-1=\"\">configuração do token previamente</a> e solicitar o cadastro do programa EDI 'SSW2269 - WebAPI de Recepção de Ocorrências de Parceiro' junto a SSW)</strong>.":1,"#<strong ljsid-0=\"\">Intelipost</strong>: Formato utilizado para quem possui integração com a <a ljsid-2=\"\">Intelipost</a>.":1,"#<strong ljsid-0=\"\">Tivit</strong>: Formato utilizado para quem possui integração com a Tivit.":1,"#<strong ljsid-0=\"\">Magento</strong>: Formato utilizado para quem utiliza o Magento 2.":1,"#<strong ljsid-0=\"\">RoutEasy</strong>: formato padrão de integração RoutEasy para eventos de <a ljsid-2=\"\">Rota</a> e <a ljsid-4=\"\">Serviços</a>.":1,"#Tipos de webhook de eventos:":1,"#Assim como a exportação da roteirização, para cadastrar um webhook de evento, basta selecionar o tipo, preencher a URL, e, caso necessário, os headers como pares key value.":1,"#Webhook de eventos":1,"#Acesse a sua Company -> Filiais -> 3 pontos na linha da filial -> Configurações":1,"#Para enviar um conjunto de pedidos para serem roteirizados através do Gestão de Pedidos, você precisa enviar uma requisição HTTP do tipo POST para https://company.routeasy.com.br/orders/import passando a api_key Verifique se o plano contratado possui acesso ao módulo Gestão de Pedidos":1,"#Previous Page: Schema dos eventos de serviços (tipo task e service)":1,"#Next Page: Início de Rota":1,"#Previous Page: Envio de Rota a um operador":1,"#Um objeto com o status on_break é enviado quando o operador pausa uma rota.":1,"#Um objeto com o status accepted é enviado quando o operador aceita a rota a ele atribuída.":1,"#Next Page: Motoristas":1,"#Previous Page: Adição de novos pedidos":1,"#ID do job da qual se quer remover o pedido":1,"#Número do pedido a ser removido":1,"#Objeto contendo o número de pedido a ser removido":1,"#Tipo de serviço a ser removido. Pode ser \"pickup\" (coleta) ou \"dropoff\" (entrega)":1,"#É possível remover pedidos de um job, enviando o número da nota. Caso não seja enviado o tipo (\"pickup\" ou \"dropoff\") o sistema irá remover o dropoff por padrão.":1,"#Next Page: Aceite de Rota pelo operador":1,"#Previous Page: Vínculo de Rota a um operador":1,"#Previous Page: Remover Motorista utilizando seu Telefone":1,"#Um objeto com o status sent é enviado quando o analista envia a rota ao operador. Neste momento o operador já tem a rota em seu APP, mas ainda é necessário aceitar ou recusar.":1,"#Next Page: Envio de Rota a um operador":1,"#Next Page: Remoção de pedidos":1,"#Previous Page: Criação de Rota Única":1,"#ID do job em que será adicionado o pedido":1,"#Previous Page: Criação de Rota":1,"#Um objeto com o status \"assigned\" é enviado quando o analista atribui uma rota a um operador.":1,"#Um objeto com status <em ljsid-1=\"\">arrived</em> é enviado quando o operador realizar o check-in no cliente.":1,"#Next Page: Vínculo de Rota a um operador":1,"#Previous Page: Eventos de Rota (Torre de Controle)":1,"#Previous Page: O Objeto Version":1,"#Para cada Webhook cadastrado na plataforma do RoutEasy, um objeto será montado e comunicado com as informações essenciais deste evento.":1,"#Disparo dos Webhooks deste evento é então iniciado nos servidores do RoutEasy,":1,"#Os servidores do RoutEasy recebem e armazenam o evento (Exemplo: Iniciar Rota),":1,"#O motorista realiza o registro no aplicativo de um evento para um serviço,":1,"#A evolução das rotas apresentada no RoutEasy é baseada em eventos. Esses eventos são registrados pelo motorista no Aplicativo do Motorista e segue o seguinte fluxo geral:":1,"#Objeto com status on_route é enviado quando o operador iniciar o serviço.":1,"#Next Page: Eventos de Rota (Torre de Controle)":1,"#Next Page: Roteirização":1,"#Next":1,"#Previous Page: Torre de Controle":1,"#Next Page: Criação do serviço":1,"#Previous Page: Eventos de serviços consolidados":1,"#Nas finalizações de serviço individuais, o array de services conterá apenas um serviço, que é referente ao cliente que o operador está finalizando.":1,"#Serviço finalizado para todos os clientes deste endereço (tipo task)":1,"#Serviço finalizado individualmente para o terceiro cliente finalizado (tipo service)":1,"#Serviço finalizado individualmente para o segundo cliente finalizado (tipo service)":1,"#Serviço finalizado individualmente para o primeiro cliente finalizado (tipo service)":1,"#Em serviço para todos os serviços (tipo task)":1,"#Check-in no cliente para todos os serviços (tipo task)":1,"#Início de rota para todos os serviços (tipo task)":1,"#Se tratando de um serviço consolidado (por exemplo, 3 serviços em um mesmo endereço), a API irá disparar os eventos na seguinte ordem:":1,"#Os eventos de serviços consolidados ({current.entity.type: \"service\"}) são enviados quando há mais de um cliente em um mesmo endereço e configuração de consolidação de serviços está ativa.":1,"#O Módulo de Gestão de Entregas da RoutEasy é essencial para manter a operação logística 100% sob controle. E com a integração entre sistemas, fica ainda mais fluido o acompanhamento do trajeto das rotas planejadas, permitindo que o cliente possa saber os status de cada entrega a partir de seu próprio sistema.":1,"#Operador finalizou":1,"#Operador pausou":1,"#Operador no trajeto":1,"#Rota negada pelo operador":1,"#Rota enviada ao operador":1,"#Rota atribuída ao operador":1,"#Rota criada":1,"#Um objeto com o status completed é enviado quando o operador conclui uma rota, com sucesso ou não.":1,"#Os eventos de rota (job) são os eventos relacionados a todo o trajeto do motorista. Os eventos de rota são identificáveis através do campo: {current.entity.type: \"job\"}. No momento em que o operador aceita uma rota, por exemplo, é gerado um evento de rota. Dentro da rota, podemos ter diversos eventos:":1,"#Rota aceita pelo operador":1,"#Skip link to Roteirizando":1,"#Previous Page: Tipos de Integração":1,"#Para autenticar-se no sistema, basta enviar sua API Key via parâmetro da requisição. Por exemplo, para fazer uma listagem de veículos, envie um GET para <a ljsid-1=\"\">https://company.routeasy.com.br/vehicles?api_key=</a>&lt;API_KEY&gt;.":1,"#Roteirizando":1,"#Nome da região":1,"#Origem CTE":1,"#Nr Plano":1,"#Um objeto com o status on_route é enviado quando o operador inicia a rota a ele atribuída.":1,"#Previous Page: Membros da Company":1,"#Para obter uma API Key, entre em contato com William Kennedy <a ljsid-1=\"\">william.kennedy@routeasy.com.br</a>":1,"#Deixe seu sistema configurado para enviar o ?api_key=<API_KEY> a cada requisição que for feita no sistema.":1,"#Next Page: Adição de novos pedidos":1,"#Objeto contendo as informações da origem (possui o mesmo schema do start_location)":1,"#CEP da origem":1,"#Objeto contendo as informações de endereço da origem":1,"#Nome da origem":1,"#Objeto contendo as informações da origem":1,"#Valor do consumo de combustível do veículo":1,"#Unidade de consumo do veículo":1,"#Tipo de combustível utilizado pelo veículo²":1,"#Objeto contendo as informações de consumo do veículo":1,"#Tipo do veículo¹":1,"#Objeto contendo as informações do veículo utilizado da rota":1,"#Array com os IDs dos motoristas ou Array com numeros de telefone dos motoristas (username) no formato +5511987654321":1,"#Data em que de execução da rota":1,"#Nome da Rota":1,"#Schema do Job":1,"#Cria uma única rota e a associa a um operador. Para criação de uma roteirização ver <a ljsid-1=\"\">Criar Grupo de Pedidos</a> .":1,"#Endpoint utilizado para adicionar ou encontrar um Motorista, pelo seu número de telefone, na plataforma do RoutEasy e em seguida enviar uma rota a ele.":1,"#Um objeto com o status on_hold é enviado quando o analista cria uma rota.":1,"#Observações gerais da parada":1,"#Listagem para dimensões dos itens":1,"#Listagem de itens da parada":1,"#Data de término da Janela de Atendimento do cliente (ISO 8601)":1,"#Data de início da Janela de Atendimento do cliente (ISO 8601)":1,"#Janela Horário de atendimento do cliente":1,"#Restrições de operação do cliente":1,"#CEP do serviço":1,"#Tipo da parada, para stops é \"service\"":1,"#Objeto contendo as informações de endereço da nota":1,"#Número do telefone":1,"#Objeto contendo algumas informações do cliente":1,"#Número do envio":1,"#Número da nota":1,"#Objeto contendo os números de pedido, nota e envio":1,"#Tipo da nota, se é uma coleta (\"pickup\") ou uma entrega (\"dropoff\")":1,"#Objeto contendo as informações de endereço":1,"#Next Page: Atribuir Motorista a uma Rota com seu ID":1,"#Data para o qual a rota será atribuída. Valor padrão: dia atual.":1,"#Ao atribuir a rota a um operador, a API da RoutEasy irá enviar individualmente um evento informando que o serviço foi criado e está em espera (status on_hold).":1,"#Data":1,"#Previous Page: Atribuir Motorista a uma Rota com seu ID":1,"#Id da rota para o qual o motorista será atribuído":1,"#Next Page: Criação de Rota":1,"#Os webhooks são os endpoints de retorno de informações geradas no RoutEasy para plataformas externas. Os webhooks são configurados para cada filial, então, caso tenha mais de uma filial apontando para o mesmo webhook, este deverá ser configurado em todas as filiais que o utilizam.":1,"#config_filial.PNG":1,"#Response":1,"#Pode-se escolher, também, quais são os eventos que vão disparar envios de informações da gestão de entregas do RoutEasy para a sua plataforma.":1,"#Página de configuração dos webhooks.":1,"#Depois, vá em Webhook, e lá poderão ser incluídos os webhooks, tanto para o envio da version, quanto para o envio dos eventos da gestão de entregas.":1,"#Para acessar a configuração dos webhooks, no menu preto do lado esquerdo, clique no nome da sua Company, depois, vá em Filiais, e clique nos 3 pontos ao lado da filial para a qual deseja configurar o webhook.":1,"#Longitude da praça de pedágio":1,"#Latitude da praça de pedágio":1,"#Valor a ser pago pelo veículo nesta praça de pedágio (valor calculado considerando o tipo de veículo da rota)":1,"#Quilometro da rodovia na qual a praça de pedágio está localizada":1,"#Nome da rodovia em que a praça de pedágio está localizada":1,"#Estado em que a praça de pedágio está localizada":1,"#Nome da praça de pedágio":1,"#Nome da empresa que administra a praça de pedágio":1,"#Id da praça de pedágio na base de dados do Sem Parar®":1,"#Array de objetos que representam cada praça de pedágio":1,"#Para enviar um evento, basta deixar o botão ligado.":1,"#Contém dados da rota":1,"#Grupo de Pedidos é o objeto que deve ser enviado no corpo da requisição POST. Basicamente, ele é um objeto que contém um array de deliveries e o nome da roteirização para rápida identificação dentro do sistema. Então para iniciar com esta modalidade de integração, deve-se montar primeiro o delivery group em seu sistema.":1,"#Tipo de serviço (delivery | pickup)":1,"#Next Page: Torre de Controle":1,"#[1] As datas de chegada e partida planejada estão no formato \"1970-01-01T00:00.000Z\", pois a data 1970-01-01 serve de referência para o sistema saber em qual dia será feita a entrega, primeiro dia (1970-01-01), segundo dia (1970-01-02), e assim por diante. O horário está em UTC, indicado pelo \"Z\" ao final.":1,"#Os pedidos <span ljsid-1=\"\">órfãos</span> são os que por algum motivo operacional não foram atendidos":1,"#Hora estimada de saída [1]":1,"#Hora estimada de chegada [1]":1,"#Quantidade total de serviços <span ljsid-1=\"\">órfãos</span>":1,"#false":1,"#Número do pedido":1,"#tela_ate_integração.PNG":1,"#[1] O loads é um array de capacidades. O index[0] é o peso em quilo (kg) e o index[1] é o volume em metros cúbicos (m³). Os demais indexes são usados apenas em casos de multicapacidade.":1,"#Objeto de Endereço":1,"#Array de objetos de janela horária":1,"#Array de IDs de veículos proibidos":1,"#Prioridade na sequencia de atendimento do cliente ³":1,"#Prioridade para o atendimento do cliente ²":1,"#Objeto de Restrições":1,"#Telefone do Cliente":1,"#E-mail do Cliente":1,"#Capacidades ¹":1,"#Observações #2":1,"#Observações #1":1,"#Schema das deliveries:":1,"#pontos_mapa.PNG":1,"#modal_integração.PNG":1,"#Depois de escolher a Origem, ao clicar em Roteirizar, dá-se início ao processo de roteirização. Mas ao clicar em Editar, os pontos deste grupo de deliveries carregam no mapa, dando a oportunidade de fazer alterações importante antes de iniciar a roteirização <em ljsid-1=\"\">(é recomendado clicar em Editar para verificar suas deliveries antes de enviar para roteirização)</em>.":1,"#Com isso irá aparecer um modal que mostra quais são os grupos de deliveries que já foram enviados para o sistema com os seus respectivos nomes.":1,"#Após enviar o grupo de deliveries no corpo da requisição POST, ele já se torna disponível dentro do RoutEasy e para acessá-lo deve-se ir na tela de criação de roteirização (+ Nova Roteirização), depois nos 3 pontos ao lado de \"Importar Excel\", e em \"Integração de Sistemas.":1,"#Sobre os campos de endereço, você pode mandar ou só o objeto <em ljsid-1=\"\">address.geocode</em> preenchido ou os demais campos. Quando recebe <em ljsid-3=\"\">address.geocode</em> preenchido, o sistema pula a etapa de busca das coordenadas, caso não esteja, ele pega os dados do endereço e busca na API do Google. Ou seja, nenhum aí é obrigatório de verdade. Mas foi colocado tudo como \"Sim\" porque <strong ljsid-5=\"\">deve ser enviado um ou outro</strong>.":1,"#[3] O sequence define o nível de importância de um cliente em ser atendido antes dos demais clientes em uma mesma rota. Clientes com maior prioridade no sequenciamento serão programados pelo algoritmo para serem atendidos sempre antes de realizar o atendimento de clientes com menor prioridade, mesmo que seja necessário elevar a distância total da rota para respeitar essa restrição. Clientes que possuem a mesma sequence na rota terão a sua sequência de atendimento definida em razão de outras restrições e da busca pela redução da quilometragem total da rota.":1,"#[2] A priority define o nível de importância para o atendimento de um cliente em relação aos demais. Caso as restrições operacionais impeçam que o algoritmo atenda a totalidade dos clientes, os serviços que possuírem maior prioridade terão maiores chances de serem programados em rota do que clientes com baixa prioridade.":1,"#Tempo de Serviço":1,"#Após clicar em Editar, os pontos são puxados para o mapa, e pode-se fazer correções nas localizações, ou modificar os parâmetros de roteirização.":1,"#Modal de integração":1,"#No menu preto do lado esquerdo, ir em \"+ Nova Roteirização\", depois nos 3 pontos ao lado de \"Importar Excel\", e em \"Integração de Sistemas.":1,"#Telefone do motorista no formato e164 (Exemplo: “+13235550000”). O telefone é utilizado para buscar por esse motorista na base de dados do RoutEasy, sendo considerado seu identificador único de acesso à plataforma.":1,"#Schema do corpo da requisição":1,"#retorno_webhook.png":1,"#Tipo do veículo cadastrado para esse motorista (diferente do tipo de veículo usado na rota)":1,"#TRUE se o motorista for terceirizado":1,"#Documento do motorista":1,"#Nome da empresa que fará o transporte":1,"#Cód. da Transportadora":1,"#Objeto com dados da transportadora (quando há)":1,"#Array referente aos operadores (motoristas e ajudantes) que irão realizar as rotas":1,"#ID da route (rota) a qual este job faz referência":1,"#ID da routing a qual este job faz referência":1,"#Quando o usuário atribui um motorista a uma rota, o objeto de job é preenchido com as informações":1,"#Objeto com as informações do endereço deste cliente específico.":1,"#Informações do serviço.":1,"#Ponto final deste trecho.":1,"#Array de objetos que contém um maior nível de detalhe dos serviços. Ordem da rota segue a ordem do index":1,"#Informações de pedágio":1,"#Objeto contendo as informações":1,"#Ordem do cliente dentro da rota":1,"#Tempo estimado de percurso":1,"#Distância percorrida até este ponto":1,"#Tipo de serviço, pode ser depot (origem) ou service (cliente)":1,"#Objeto contendo informações do ponto do serviço, como endereço, cargas, etc.":1,"#Array dos pedidos em ordem":1,"#Tempo de percurso":1},"version":912}]