CtrlChain Developers
Resources

Orders

An order contains all relevant data related to a shipment. Orders are created by the platform when a lane booking request is accepted.

Order definition

  • The related (sub)group and the booker
  • Stops with dates, references, and instructions
  • Desired pickup and delivery date times
  • Vehicle, trailer, and driver data once a carrier is assigned
  • Uploaded PODs, with a download link once they are approved

Order details

GET /api/v1/Order/detail/{orderId} returns the full order, including its status, stops, and carrier details. Webhook notifications include a DetailUrl that points straight at this endpoint for the affected order.

Documents

Once the PODs related to an order are approved, they appear in the approvedPODs array with a downloadUrl. Files can also be fetched directly via GET /api/v1/Order/file/download/{fileId}.