Criação de Rota Única

Cria uma única rota e a associa a um operador. Para criação de uma roteirização ver Criar Grupo de Pedidos .

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Schema do Job

CampoTipoDescriçãoObrigatório
codeStringCódigo da RotaNão
nameStringNome da RotaSim
siteStringID do siteSim
due_dateDateData em que de execução da rotaSim
operatorsArray de StringsArray com os IDs dos motoristas ou Array com numeros de telefone dos motoristas (username) no formato +5511987654321Não
vehicleObjetoObjeto contendo as informações do veículo utilizado da rotaNão
vehicle.license_plateStringPlaca do veículoSim
vehicle.typeStringTipo do veículo¹Sim
vehicle.consumptionObjetoObjeto contendo as informações de consumo do veículoNão
vehicle.consumption.fuelStringTipo de combustível utilizado pelo veículo²Não
vehicle.consumption.unitStringUnidade de consumo do veículoNão
vehicle.consumption.valueNumberValor do consumo de combustível do veículoNão
start_locationObjetoObjeto contendo as informações da origemNão
start_location.nameStringNome da origemSim
start_location.nodeObjetoObjeto contendo as informações de endereço da origemNão
start_location.node.typeStringTipo da parada, para start e end location é "depot"Sim
start_location.node.addressObjetoObjeto contendo as informações de endereçoSim
start_location.node.address.postal_codeStringCEP da origemNão
start_location.node.address.routeStringLogradouroSim
start_location.node.address.street_numberStringNúmeroNão
start_location.node.address.cityStringCidadeNão
start_location.node.address.stateStringEstadoNão
start_location.node.address.countryStringPaísNão
start_location.node.address.formatted_addressStringEndereço completoNão
end_locationObjetoObjeto contendo as informações da origem (possui o mesmo schema do start_location)Não
stopsArray de ObjetosArray de objetos das paradasSim
stops.order_waypointsArray de ObjetosArray de pedidosNão
stops.order_waypoints.typeStringTipo da nota, se é uma coleta ("pickup") ou uma entrega ("dropoff")Não
stops.order_waypoints.documentsObjetoObjeto contendo os números de pedido, nota e envioNão
stops.order_waypoints.documents.invoice_numberStringNúmero da notaNão
stops.order_waypoints.documents.order_numberStringNúmero do pedidoSim
stops.order_waypoints.documents.shipment_numberStringNúmero do envioNão
stops.order_waypoints.partyObjetoObjeto contendo algumas informações do clienteSim
stops.order_waypoints.party.nameStringNome do clienteSim
stops.order_waypoints.party.emailStringE-mail do clienteNão
stops.order_waypoints.party.phoneStringNúmero do telefoneNão
stops.order_waypoints.nodeObjetoObjeto contendo as informações de endereço da notaNão
stops.order_waypoints.node.typeStringTipo da parada, para stops é "service"Sim
stops.order_waypoints.node.addressObjetoObjeto contendo as informações de endereçoSim
stops.order_waypoints.node.address.postal_codeStringCEP do serviçoNão
stops.order_waypoints.node.routeStringLogradouroSim
stops.order_waypoints.node.cityStringCidadeNão
stops.order_waypoints.node.stateStringEstadoNão
stops.order_waypoints.node.countryStringPaísNão
stops.order_waypoints.node.formatted_addressStringEndereço completoNão
stops.order_waypoints.constraintsObjetoRestrições de operação do clienteNão
stops.order_waypoints.constraints.operating_hoursObjetoJanela Horário de atendimento do clienteNão
stops.order_waypoints.constraints.operating_hours.startDataData de início da Janela de Atendimento do cliente (ISO 8601)Sim
stops.order_waypoints.constraints.operating_hours.endDataData de término da Janela de Atendimento do cliente (ISO 8601)Sim
stops.order_waypoints.itemsArray de ObjetosListagem de itens da paradaNão
stops.order_waypoints.items.dimensionsArray de ObjetosListagem para dimensões dos itensNão
stops.order_waypoints.items.dimensions.typeStringTipo da dimensão do item ('area','weight', 'volume', 'money_value', 'boxes')Não
stops.order_waypoints.items.dimensions.unitStringUnidade de medida do item ('kg', 'g', 't', 'm3', 'brl', 'unit')Não
stops.order_waypoints.items.dimensions.valueNumberValor dessa dimensão do itemNão
stops.order_waypoints.notesArray de StringsObservações gerais da paradaNão
Body Params
string
Defaults to id_do_job

Esse campo é um identificador da rota e é utilizado para edita-la em caso de alterações de pedidos por exemplo

string
date
Defaults to now
operators
array of strings
operators
stops
array
stops
string
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json