post https://company.routeasy.com.br/job-standalone
Cria uma única rota e a associa a um operador. Para criação de uma roteirização ver Criar Grupo de Pedidos .
Schema do Job
Campo | Tipo | Descrição | Obrigatório |
---|---|---|---|
code | String | Código da Rota | Não |
name | String | Nome da Rota | Sim |
site | String | ID do site | Sim |
due_date | Date | Data em que de execução da rota | Sim |
operators | Array de Strings | Array com os IDs dos motoristas ou Array com numeros de telefone dos motoristas (username) no formato +5511987654321 | Não |
vehicle | Objeto | Objeto contendo as informações do veículo utilizado da rota | Não |
vehicle.license_plate | String | Placa do veículo | Sim |
vehicle.type | String | Tipo do veículo¹ | Sim |
vehicle.consumption | Objeto | Objeto contendo as informações de consumo do veículo | Não |
vehicle.consumption.fuel | String | Tipo de combustível utilizado pelo veículo² | Não |
vehicle.consumption.unit | String | Unidade de consumo do veículo | Não |
vehicle.consumption.value | Number | Valor do consumo de combustível do veículo | Não |
start_location | Objeto | Objeto contendo as informações da origem | Não |
start_location.name | String | Nome da origem | Sim |
start_location.node | Objeto | Objeto contendo as informações de endereço da origem | Não |
start_location.node.type | String | Tipo da parada, para start e end location é "depot" | Sim |
start_location.node.address | Objeto | Objeto contendo as informações de endereço | Sim |
start_location.node.address.postal_code | String | CEP da origem | Não |
start_location.node.address.route | String | Logradouro | Sim |
start_location.node.address.street_number | String | Número | Não |
start_location.node.address.city | String | Cidade | Não |
start_location.node.address.state | String | Estado | Não |
start_location.node.address.country | String | País | Não |
start_location.node.address.formatted_address | String | Endereço completo | Não |
end_location | Objeto | Objeto contendo as informações da origem (possui o mesmo schema do start_location) | Não |
stops | Array de Objetos | Array de objetos das paradas | Sim |
stops.order_waypoints | Array de Objetos | Array de pedidos | Não |
stops.order_waypoints.type | String | Tipo da nota, se é uma coleta ("pickup") ou uma entrega ("dropoff") | Não |
stops.order_waypoints.documents | Objeto | Objeto contendo os números de pedido, nota e envio | Não |
stops.order_waypoints.documents.invoice_number | String | Número da nota | Não |
stops.order_waypoints.documents.order_number | String | Número do pedido | Sim |
stops.order_waypoints.documents.shipment_number | String | Número do envio | Não |
stops.order_waypoints.party | Objeto | Objeto contendo algumas informações do cliente | Sim |
stops.order_waypoints.party.name | String | Nome do cliente | Sim |
stops.order_waypoints.party.email | String | E-mail do cliente | Não |
stops.order_waypoints.party.phone | String | Número do telefone | Não |
stops.order_waypoints.node | Objeto | Objeto contendo as informações de endereço da nota | Não |
stops.order_waypoints.node.type | String | Tipo da parada, para stops é "service" | Sim |
stops.order_waypoints.node.address | Objeto | Objeto contendo as informações de endereço | Sim |
stops.order_waypoints.node.address.postal_code | String | CEP do serviço | Não |
stops.order_waypoints.node.route | String | Logradouro | Sim |
stops.order_waypoints.node.city | String | Cidade | Não |
stops.order_waypoints.node.state | String | Estado | Não |
stops.order_waypoints.node.country | String | País | Não |
stops.order_waypoints.node.formatted_address | String | Endereço completo | Não |
stops.order_waypoints.constraints | Objeto | Restrições de operação do cliente | Não |
stops.order_waypoints.constraints.operating_hours | Objeto | Janela Horário de atendimento do cliente | Não |
stops.order_waypoints.constraints.operating_hours.start | Data | Data de início da Janela de Atendimento do cliente (ISO 8601) | Sim |
stops.order_waypoints.constraints.operating_hours.end | Data | Data de término da Janela de Atendimento do cliente (ISO 8601) | Sim |
stops.order_waypoints.items | Array de Objetos | Listagem de itens da parada | Não |
stops.order_waypoints.items.dimensions | Array de Objetos | Listagem para dimensões dos itens | Não |
stops.order_waypoints.items.dimensions.type | String | Tipo da dimensão do item ('area','weight', 'volume', 'money_value', 'boxes') | Não |
stops.order_waypoints.items.dimensions.unit | String | Unidade de medida do item ('kg', 'g', 't', 'm3', 'brl', 'unit') | Não |
stops.order_waypoints.items.dimensions.value | Number | Valor dessa dimensão do item | Não |
stops.order_waypoints.notes | Array de Strings | Observações gerais da parada | Não |