Optimize plan

post https://api.kosmo.delivery/v2/plans/{planId}/optimize

Optimize a plan. It returns a list of optimized orders. Sometimes it can be not ready, so need to check the status. Recommended to check it once in 5 seconds.

Responses

Response body

object

planId

string

required

The ID of the optimized plan.

status

string

required

The status of the optimized plan.

pending success failed

result

object

The result of the optimized plan.

totalDistance

integer

required

The total distance in meters of the optimized plan.

totalDuration

integer

required

The total duration in seconds of the optimized plan.

totalStops

integer

required

The total stops of the optimized plan.

unassignedCount

integer

required

The unassigned count of stops.

routes

array of objects

The list of routes.

routes

object

driver

string

The driver of the route.

totalDistance

integer

required

The total distance in meters of the route.

totalDuration

integer

required

The total duration in seconds of the route.

startAt

string

required

The start time of the route.

startLocation

object

required

The start location of the route.

stops

array of objects

required

The list of stops.

stops*

object

status

string

The status of the dropoff.

delivered canceled to_dropoff returning returned

location

object

required

Details of location.

contact

object

Details of contact (can be a store or a person).

parcel

object

Deprecated - use parcels instead.

parcels

array of objects

parcels

object

description

string

Description of the parcel.

weight

number

Weight of the parcel in kilograms.

height

integer

Height of the parcel in centimeters.

quantity

integer

Number of parcels.

width

integer

Width of the parcel in centimeters.

length

integer

Length of the parcel in centimeters.

value

integer

Value of the parcel in cents

orderReferenceId

string

You can provide this field to identify this dropoff with a specific ID in your system. So you will be able to track your system order in a case if you want to create multi dropoff order.

cashOnDeliveryAmount

integer

The amount of cash on delivery in cents. It's required to be greater than 0 if you want to collect cash on delivery.

timeAtLocation

integer

The time in seconds the driver will spend at the location.

arrivalTimeStart

date-time

Expected arrival time to receive order.

arrivalTimeEnd

date-time

Expected dropoff time to receive order.

estimatedArrival

date-time

Estimated arrival time to receive order.

clientId

string

The client ID. You can manage your clients in the Kosmo dashboard.

tags

stopType

string

Defaults to dropoff

Type of the stop.

pickup dropoff

priority

string

The priority of the stop.

first last

arrival

object

The arrival location of the route.

string

required

The ID of the route.

unassigned

array of objects

The list of unassigned stops.

unassigned

object

stop

object

required

Details of dropoff.

reasons

array of strings

required

The reason of unassigned.

reasons*

Language

Credentials

Bearer

token


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.kosmo.delivery/v2/plans/planId/optimize \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

200OK

400Bad Request

403Forbidden

500Internal Server Error