API Reference
Log In
API Reference

/shipments-planner-jobs

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

Register a shipments-planner optimization job. Returns a jobId to poll.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
shipmentIds
array of strings
required
length ≥ 1

Internal Shipment ids (6-character uppercase codes) to plan. Every leg of each shipment that can still be planned enters the pool. Provide either this or legIds, not both.

shipmentIds*
legIds
array of strings
length ≥ 1

Internal Leg ids (UUIDs) to plan, for planning individual legs of shipments rather than whole shipments. Legs that can no longer be planned are ignored. Provide either this or shipmentIds, not both.

legIds
vehicles
array
required
length ≥ 1
vehicles*
options
object
string
Responses

400

Invalid request body

401

Unauthorized

404

Profile not found

422

none of the supplied shipments has a leg that can be planned — every leg is already routed, executed, or cancelled, so there is nothing for the optimizer to assign

Updated 6 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago

Did this page help you?