Sign in
Dispatches_Routes

Dispatch a new route

post/fleetify/routes

Query parameters

keystring required

A key is a unique identifier that is required to authenticate a request to the API.

Request body

driver_emailstring required

Specify the e-mail address of the driver who should receive the route. The e-mail address must be registered in NextBillion.ai Cloud Console.

stepsRouteStepsRequest[] required— unresolved $ref

An array of objects to collect the details about the intermediate steps in the route to be dispatched. Each object corresponds to a single step. The array must begin with a start-type step and end with an end-type step, to form a valid route.

distanceinteger

Specify the total distance, in meters, for an informative display in Driver's app. The distance specified here has no effect on the actual route that the service generates.

document_template_idstring

Specify the ID of the document template that should be used to collect proof of completion for all steps in the route. In order to complete each route step, the driver will need to submit a form generated by the rules defined in the given document template. Use the Documents API to create, read and manage document templates.

Please note that the document template ID assigned to a route does not apply to following step types - start, end, break, layover.

ro_request_idstring

Specify the Route Optimization request ID. When this ID is provided, all other fields will be ignored (including the required fields) and the route optimization result will be used to form the routes and corresponding steps.

Please note that:

  • The driver's email ID must be provided in input vehicle.metadata as user_email such that the route optimization result must contain a valid driver email, step's arrival time, etc., to make a successful dispatch.

  • Document Template for collecting proof of delivery or completion can not be specified when using this field to dispatch a route.

  • In case of an error at any part among the routes, the API will immediately return the error with the index of the specific route or route step.

  • On a successful dispatch, the API returns the last route, if there are many, in the response payload.

Response

statusinteger

Returns the status code of the response.

Changes

Changed in 3 of the 15 revisions of this API.7818114

  • 7ee76f0ff67926638See the full diff
    • ▲

      removed the enum value break of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value car of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value circumstantial of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value curb of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value delivery of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value end of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value explosive of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value ferry of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value general of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value geofence_manual_fallback of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value geofence of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value harmful_to_water of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value highway of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value job of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value layover of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value left_turn of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value manual of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value none of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value pickup of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value right_turn of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value service_road of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value sharp_turn of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value start of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value toll of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value unrestricted of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value uturn of the request property /

      request-property-enum-value-removed

    • ●

      added the new geofence enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new geofence enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new geofence_manual_fallback enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new geofence_manual_fallback enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new manual enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new manual enum value to the //// response property for the response status

      response-property-enum-value-added

    • ○

      the request property default value changed from unrestricted to unrestricted

      request-property-default-value-changed

    • ○

      the request property default value changed from ferry to ferry

      request-property-default-value-changed

    • ○

      the request property default value changed from manual to manual

      request-property-default-value-changed

    • ○

      the request property default value changed from car to car

      request-property-default-value-changed

    • ○

      added the new break enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new car enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new circumstantial enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new curb enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new delivery enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new end enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new explosive enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new ferry enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new general enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new geofence enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new geofence_manual_fallback enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new harmful_to_water enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new highway enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new job enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new layover enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new left_turn enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new manual enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new none enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new pickup enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new right_turn enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new service_road enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new sharp_turn enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new start enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new toll enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new unrestricted enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new uturn enum value to the request property /

      request-property-enum-value-added

    • ○

      the response's property default value changed from manual to manual for the status

      response-property-default-value-changed

    • ○

      the response's property default value changed from manual to manual for the status

      response-property-default-value-changed

    • ○

      removed the geofence_manual_fallback enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the geofence_manual_fallback enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the geofence enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the geofence enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the manual enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the manual enum value from the //// response property for the response status

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a800b73f11c126638See the full diff
    • ▲

      removed the enum value break of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value car of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value circumstantial of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value curb of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value delivery of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value end of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value explosive of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value ferry of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value general of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value geofence of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value geofence_manual_fallback of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value harmful_to_water of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value highway of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value job of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value layover of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value left_turn of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value manual of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value none of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value pickup of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value right_turn of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value service_road of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value sharp_turn of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value start of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value toll of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value unrestricted of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value uturn of the request property /

      request-property-enum-value-removed

    • ●

      added the new geofence_manual_fallback enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new geofence_manual_fallback enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new geofence enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new geofence enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new manual enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new manual enum value to the //// response property for the response status

      response-property-enum-value-added

    • ○

      the request property default value changed from unrestricted to unrestricted

      request-property-default-value-changed

    • ○

      the request property default value changed from ferry to ferry

      request-property-default-value-changed

    • ○

      the request property default value changed from manual to manual

      request-property-default-value-changed

    • ○

      the request property default value changed from car to car

      request-property-default-value-changed

    • ○

      added the new break enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new car enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new circumstantial enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new curb enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new delivery enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new end enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new explosive enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new ferry enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new general enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new geofence_manual_fallback enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new geofence enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new harmful_to_water enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new highway enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new job enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new layover enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new left_turn enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new manual enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new none enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new pickup enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new right_turn enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new service_road enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new sharp_turn enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new start enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new toll enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new unrestricted enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new uturn enum value to the request property /

      request-property-enum-value-added

    • ○

      the response's property default value changed from manual to manual for the status

      response-property-default-value-changed

    • ○

      the response's property default value changed from manual to manual for the status

      response-property-default-value-changed

    • ○

      removed the geofence enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the geofence enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the geofence_manual_fallback enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the geofence_manual_fallback enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the manual enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the manual enum value from the //// response property for the response status

      response-property-enum-value-removed

  • b79d96775b1326638See the full diff
    • ▲

      removed the enum value break of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value car of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value circumstantial of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value curb of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value delivery of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value end of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value explosive of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value ferry of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value general of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value geofence_manual_fallback of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value geofence of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value harmful_to_water of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value highway of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value job of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value layover of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value left_turn of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value manual of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value none of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value pickup of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value right_turn of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value service_road of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value sharp_turn of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value start of the request property //

      request-property-enum-value-removed

    • ▲

      removed the enum value toll of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value unrestricted of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value uturn of the request property /

      request-property-enum-value-removed

    • ●

      added the new geofence enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new geofence enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new geofence_manual_fallback enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new geofence_manual_fallback enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new manual enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new manual enum value to the //// response property for the response status

      response-property-enum-value-added

    • ○

      the request property default value changed from unrestricted to unrestricted

      request-property-default-value-changed

    • ○

      the request property default value changed from ferry to ferry

      request-property-default-value-changed

    • ○

      the request property default value changed from manual to manual

      request-property-default-value-changed

    • ○

      the request property default value changed from car to car

      request-property-default-value-changed

    • ○

      added the new break enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new car enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new circumstantial enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new curb enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new delivery enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new end enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new explosive enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new ferry enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new general enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new geofence enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new geofence_manual_fallback enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new harmful_to_water enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new highway enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new job enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new layover enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new left_turn enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new manual enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new none enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new pickup enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new right_turn enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new service_road enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new sharp_turn enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new start enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new toll enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new unrestricted enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new uturn enum value to the request property /

      request-property-enum-value-added

    • ○

      the response's property default value changed from manual to manual for the status

      response-property-default-value-changed

    • ○

      the response's property default value changed from manual to manual for the status

      response-property-default-value-changed

    • ○

      removed the geofence_manual_fallback enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the geofence_manual_fallback enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the geofence enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the geofence enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the manual enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the manual enum value from the //// response property for the response status

      response-property-enum-value-removed