CargoPlans

Get load plan details

Returns the full state of a load plan including assigned cargo units.

get/cargo-plans/{id}

Request

Base URL: http://localhost:3000
URL: http://localhost:3000/cargo-plans/{id}
Auth: none declared

Path parameters

idstring uuid required

UUID of the load plan

Query parameters

weightUnit'KG' | 'TONNE' | 'LB'

Unit of weight measurement

Unit in which weight values are expressed in the response. Defaults to KG.

Response

Load plan found

idstring uuid required

Unique identifier of the load plan

status'DRAFT' | 'FINALIZED' required

Current status of the load plan

versioninteger required

Optimistic concurrency version of the load plan

weightUnit'KG' | 'TONNE' | 'LB' required

Unit of weight measurement

currentLdmnumber required

Currently used loading metres

plannedWeightnumber required

Total weight of all assigned cargo units, expressed in the unit given by weightUnit

Example response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "version": 3,
  "trailer": {
    "canCarryPallets": true,
    "maxWeightCapacityKg": 24000,
    "widthMm": 2400,
    "heightMm": 2700,
    "maxLdm": 13.6,
    "capabilities": {
      "supportsSideLoading": true
    }
  },
  "currentLdm": 2.4,
  "plannedWeight": 600,
  "units": [
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "palletLabel": "EPAL 1",
      "weight": 600,
      "totalHeightMm": 1400
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.