Charter

Charter many segments

Shortcut API to create a chartered transport from one segment or a list of successive segments (from a "parent transport"). Those segments, will be chartered to a "child transport".

Child transport is created as follow:

• Shipper is the actual carrier of the parent transport

• Carrier is the chartered carrier given in the carrier parameter

• Trucker and plates are not set, but information about it can be given in the instructions parameters

• Other transport data (deliveries, segments, etc.) are duplicated

• Child transport starts at the first segment's origin and ends at the last segment's destination

POSThttps://api.dashdoc.eu/api/v4/segments/charter/

Query parameters

Body

application/json

carrier*CharterTransport_carrier (object)

Carrier to whom you wish to charter the transport. Identified either by its pk or remote_id.

instructionsglobal_instructions (string)

Operating instructions. The carrier, the shipper and the creator of the transport have access to those instructions. However, the creator is the only who has the right to edit.

Response

201400

Segments chartered successfully

Body

application/json

child_transportstring

uid of the chartered transport that has been created

Example: "3545c058-392d-11eb-90c5-0242ac140006"

Request

JavaScriptCurlPython

const response = await fetch('https://api.dashdoc.eu/api/v4/segments/charter/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "carrier": {}
    }),
});
const data = await response.json();

Response

201400

{
  "child_transport": "3545c058-392d-11eb-90c5-0242ac140006"
}