v1

latestOpenAPI 3.0.02026-07-24189145350.1 KB
Routes

Add 1 or more Routes

Endpoint to add Routes

post/routes

Request body

codestring required

Route code

startDatestring date-time

Route start date

datestring date required

Route scheduled date

status'overdue' | 'finished' | 'extended' | 'pending' | 'closed' | 'ongoing' required

Route state

deviceIdnumber

Route assigned vehicle

totalAmountnumber

Route total amount

driverIdnumber

Route driver id

companionIdnumber

Route companion id

secondaryCodestring

Route secondary code

warehouseDepartureDatestring date-time

Warehouse departure date

warehouseReturnDatestring date-time

Warehouse return date

carrierstring

Route carrier

scheduledStartDatestring date-time

Route scheduled date

recalculatedAtstring date-time

Route recalculated date

optimizedboolean

Route is optimized

assignedDeviceIMEInumber

Route assigned device IMEI

Response

Route/s added On Error, meta object will contain an error array with these possible values

Error codes:

CodeDescriptionField
2010Activity type not found or not allowed for this user
2021Poi code not found or not allowed for this user
2022Order code not found or not allowed for this user
2040Driver id not found or not allowed for this user
2041Companion id not found or not allowed for this user
2042Device id not found or not allowed for this user
2043Invalid status
2044Driver's id and companion's id can't be equals