Creates a route

post

https://api.geoconcept.com/delivery/api/nd/missions/createRoute

Creates a route as specified.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

agency

string

Identifier of the agency. Included missions must be in this agency, and assigned person must be attached to this agency.

automaticOrdering

boolean

If true, the missions will be automatically ordered to minimise the route duration. Otherwise, if missions have a provided position, this position will be used to order them.

contractorId

string

Identifier of contractor. To be used for contractor dedicated routes.

force

boolean

Defaults to false

If true, route will be created even if conflicts are detected.

licensePlate

string

License plate of the vehicle used to perform this route.

missionIds

array of strings

List of missions ids to be included in the new route. All deliveries must have the same pickup address. All pickups must have the same consignee address (depot address in this case). All missions must be in the same agency, and the assigned person must be abilited on this agency.

missionIds

odometer

double

Odometer value before route start.

personId

string

Identifier of the assigned person.

routeEndSurveyId

string

Identifier of the survey to fill at route end. Leave it null to let unchanged.

routeName

string

Name of the route. It will be displayed in UI and mobile app.

routeStartAcceptance

string

enum

Route start acceptance policy depending on planned missions. NOTBLOCKED: route start will not be blocked. BLOCKED: route start will be blocked until the dispatcher grants acceptance. GRANTED: route start has been granted grants acceptance.

Allowed:

routeStartSurveyId

string

Identifier of the survey to fill at route start. Leave it null to let unchanged.

startFromAgency

boolean

Defaults to false

If true, route will start from agency. Otherwise, it will start from deliveries pickup address (and all deliveries must have the same pickup address). Used only if automaticOrdering=true

startTime

date-time

Route start date and time.

subContratorId

string

Identifier of sub-contractor. To be used to assign the route to a specific sub-contractor. If personId is specified, we will use the sub-contractor Id of this user instead.

Headers

UseHTTPCodeOnError

boolean

Defaults to false

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

defaultResponse containing the created route