/shipments-planner-jobs/recalculate

post

https://api.dev.orbit.do/v5/shipments-planner-jobs/recalculate

Synchronously re-optimize the changed tours of an existing planner solution and return the updated solution. Unlike registering a job, this call does not create tours and does not need polling.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

shipmentIds

array of strings

required

length ≥ 1

Internal Shipment ids (6-character uppercase codes) to plan. Must cover every shipment carried by the start solution's changed tours; omitting one is rejected. Supplied ids that do not exist or reference shipments outside a routable status (Unrouted or Failed) are silently dropped from the optimization rather than rejected.

shipmentIds*

vehicles

array

required

length ≥ 1

Vehicles available for the recalculation. Must include the vehicles the start-solution tours reference by vehicleId.

vehicles*

options

object

profileId

string

ignoreTimeWindows

boolean

When true, shipment pickup and delivery time windows are ignored during this recalculation, so stops may be scheduled at any time of day. Vehicle availability windows still apply.

startSolution

object

required

The proposed-tour set to recalculate. Tour ids in solutionTours must be unique, and each changedTours id must appear once and match a solutionTours id.

Responses

400

Invalid request body

401

Unauthorized

404

Profile not found

409

the submitted plan pins a shipment that now has several legs without naming one, so its kept stops cannot be matched to a leg — re-plan those shipments and recalculate the rebuilt plan

500

The solution could not be recalculated

Language

Credentials

Header

URL

Loading…

Response

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

application/json

200Recalculated solution