Charter

Charter many segments

post

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

Authorizations

ApiKeyAuth

AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"

Query parameters

uid__instringOptional

Comma separated list of segment uids, or just one if only one segment is to be chartered.

Example: 1004fcf8-9136-11eb-aa8d-0242ac110006,a05b7bfa-71e8-11eb-b223-0242ac110007

remote_id__instringOptional

Comma separated list of remote ids, or just one if only one segment is to be chartered. Can be used to identify segments using their remote_id instead of their uid.

Example: seg_1234567,seg_7654321

Body

application/json

instructionsstring · max: 1000Optional

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.

pricenumber · float | nullableOptionalDeprecated

Full price for the transport

Example: 250

Responses

201

Segments chartered successfully

application/json

400

missing or incorrect query parameters

application/json

post

/segments/charter/

HTTPcURLJavaScriptPython

POST /api/v4/segments/charter/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "carrier": {
    "pk": 23498,
    "remote_id": "text",
    "carrier_contacts": "['abce-df123-acd4', 'dcbe-df153-dcd7']"
  },
  "instructions": "text"
}

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