/shipments-planner-jobs

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

shipmentIds

array of strings

required

length ≥ 1

shipmentIds*

vehicles

array

required

length ≥ 1

vehicles*

string

required

Internal Vehicle id (auto-generated UUID), opaque — humans identify a vehicle by its numberPlate, not by this id.

tenantId

string

required

Internal id of the tenant that owns this vehicle.

carrierId

string

required

Internal Carrier id (UUID) of the carrier that owns this vehicle.

status

string

enum

required

Directory status controlling whether the vehicle is available for assignment.

Allowed:

make

string

The manufacturer of the vehicle.

model

string

The model of the vehicle.

numberPlate

string

numberPlateCountryCode

string

length between 3 and 3

^[A-Z]{3}$

The country code of the number plate (ISO Alpha-3)

VIN

string

Vehicle Identification Number

class

string

required

length ≥ 1

Reference to a VehicleClass by its id — a caller-chosen readable slug like "RIGID_75", not a UUID. Sets the capacity/dimension template this vehicle belongs to.

extras

array of strings

required

Vehicle capability flags this vehicle provides (e.g. Liftgate, Refrigerated), matched against a shipment's required extras to gate feasibility.

extras*

containerWidth

number

≥ 0

Internal cargo-container width in CENTIMETERS (not the outer vehicle width, which is in meters). Used by 3D load planning to place loads across the container.

containerLength

number

≥ 0

Internal cargo-container length in CENTIMETERS. Drives loading-metre (LDM) utilization and load placement in the primary loading direction.

containerHeight

number

≥ 0

Internal cargo-container height in CENTIMETERS. Constrains load stacking height in 3D load planning.

outerWidth

≥ 0

Outer vehicle width in METERS (note: metres, unlike the centimetre container dimensions). Used for routing/access constraints.

outerLength

≥ 0

Outer vehicle length in meters (see outerWidth).

outerHeight

≥ 0

Outer vehicle height in meters (see outerWidth).

weightCapacity

number

required

≥ 0

Maximum cargo weight the container can carry, in kilograms. Enforced by 3D load planning against the combined load weight.

maxTotalWeight

number

required

≥ 0

Maximum gross vehicle weight in kilograms (cargo plus the vehicle itself).

internalComment

string

Operator-only free-text note about the vehicle.

createdAt

number

required

Creation timestamp in epoch SECONDS (Europe/Berlin).

updatedAtMilliseconds

number

Last-update timestamp in epoch MILLISECONDS (milliseconds, unlike createdAt which is seconds).

properties

object | null

Key-value pairs in the dictionary have property IDs as keys. Property keys and their values appear only when the property value is explicitly set. All property values are validated against their definitions - requests with unknown property IDs or invalid value types will be rejected with a 400 error.

accessDirection

array of strings

Sides from which the cargo container can be loaded and unloaded.

accessDirection

Allowed:

fuelType

string

enum

The type of fuel used by the vehicle.

combustionNorm

string

enum

The emission standard of the vehicle.

Allowed:

emissionClass

string

enum

The emission class of the vehicle.

Allowed:

axleCount

1 to 9007199254740991

The number of axles on the vehicle.

start

object

Address the vehicle starts its tour from. Defaults to the depot/data when omitted.

end

object

Address the vehicle must return to at the end of its tour. Defaults to the start when omitted.

maxDistance

number

≥ 0

Maximum total driving distance for one tour on this vehicle, in METERS (e.g. 300000 for 300 km).

maxDuration

number

≥ 0

Maximum total tour duration for this vehicle, in MINUTES (e.g. 480 for an 8-hour shift), covering driving, service, and waiting.

maxLoads

number

≥ 0

Maximum number of load units this vehicle may carry per tour.

maxStops

number

≥ 0

Maximum number of stops (pickups plus dropoffs) on one tour for this vehicle.

schedule

object

Weekly availability windows during which this vehicle can be routed.

costsPerUse

number

≥ 0

Relative cost weight applied each time this vehicle is used (not a currency amount); raise to make the planner prefer fewer vehicles.

speedFactor

number

≥ 0

Multiplier on estimated driving speed for this vehicle: below 1.0 assumes slower travel (e.g. 0.8 = 20% slower), above 1.0 faster.

options

object

profileId

string

Responses

400

Invalid request body

401

Unauthorized

404

Profile not found

Language

Credentials

Header

URL

Loading…

Response

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

application/json

200Job registered