search
Ctrlk

Transports

hashtag
List all transports

get
Authorizations
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
pageintegerOptional

A page number within the paginated result set.

uid__instringOptional

Comma separated list of transport uids.

Example: 4443d4b6-e165-11ea-a488-0242ac110007
uid__not_instringOptional

Comma separated list of transport uids to exclude from results.

Example: 4443d4b6-e165-11ea-a488-0242ac110007
statusstring · enumOptionalPossible values:
status__instring · enumOptional

Comma separated list of statuses.

Possible values:
created__gtestring · date-timeOptional

Filter transports created after or at a certain date

created__ltestring · date-timeOptional

Filter transports created before or at a certain date

updated__gtestring · date-timeOptional

Filter transports updated after or at a certain date

updated__ltestring · date-timeOptional

Filter transports updated before or at a certain date

carrier_referencestringOptional

filter on a particular carrier reference

Example: OT2021-123456
Responses
chevron-right
200Success
application/json
countintegerOptionalExample: 1
nextstring · nullableOptional
previousstring · nullableOptional
get
/transports/
200Success

hashtag
Create a transport

post

This will create a transport. You can store your internal transport identifier in the remote_id field.

Authorizations
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/"
Body
remote_idstringOptional

Your transport id. It has to be unique among all your transports

requested_vehiclestring · max: 40Optional

Only useful when the transport is created by the shipper. Free text except punction and special characters.

carrier_referencestringOptional

Text that will help the carrier operators manage the transports, e.g. transport number in his TMS

pricenumber · float · nullableOptionalDeprecated

Full price for the transport

Example: 250
requires_washingbooleanOptional

Flag to enable the truck washing flow in the mobile app

business_privacybooleanOptional

Flag to enable 'business privacy' mode: no eCMR will be generated, and the trucker won't be prompted to share the transport link.

is_multiple_compartmentsbooleanOptional

Flag to enable 'multiple compartments' mode: truckers will have to select in which compartments loads were loaded. It also generated a specific delivery document : loading_plan.

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.

volume_display_unitstring · enumOptionalDefault: m3Possible values:
transport_operation_category_uidstring · uuidOptional

UID of the transport operation category

send_to_truckerbooleanOptional

Flag to send the missions to the assigned truckers. It has no effect on already sent missions.

Default: true
Responses
post
/transports/
201Success

hashtag
Delete a transport

delete
Authorizations
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/"
Path parameters
uidstringRequired
remote_idstringOptional

If you choose to identify an object with its remote_id instead of its uid then

  • replace the uid value with the remote_id value in the URL

  • specify lookup_field=remote_id in the query parameters

Query parameters
lookup_fieldstringOptional

Used to specify what field is used in the URL to identify the object you're requesting, e.g. with the remote_id (see path parameters)

Responses
delete
/transports/{uid}/
204

Empty body

No content

hashtag
Read a transport

get
Authorizations
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/"
Path parameters
uidstringRequired
remote_idstringOptional

If you choose to identify an object with its remote_id instead of its uid then

  • replace the uid value with the remote_id value in the URL

  • specify lookup_field=remote_id in the query parameters

Query parameters
lookup_fieldstringOptional

Used to specify what field is used in the URL to identify the object you're requesting, e.g. with the remote_id (see path parameters)

Responses
chevron-right
200Success
application/json
uidstring · uuidRequired

Dashdoc's internal id. It will be automatically generated by us.

Example: 447521b0-e165-11ea-a488-0242ac110007
sequential_idnumberRequiredExample: 1240993
createdstring · date-timeRequired

Date of creation sent by the creator. Useful when the transport is created by mobile devices. If network connection is bad, the created date can be later than created_device

updatedstring · date-timeRequired
deletedstring · nullableOptional
remote_idstringRequired

Your transport id. It has to be unique among all your transports

created_devicestring · date-timeRequired
creation_methodstring · enumRequiredPossible values:
archived_byobject[]Optional
is_orderbooleanRequired
invite_codestringRequiredExample: RWMUYE
statusstring · enumRequiredPossible values:
has_observationsbooleanRequired
requested_vehiclestring · max: 40Required

Only useful when the transport is created by the shipper. Free text except punction and special characters.

carrier_referencestringRequired

Text that will help the carrier operators manage the transports, e.g. transport number in his TMS. It should only be set by the carrier of the transport and the transport's creator can toggle a company-wide setting to only allow the carrier to set it.

pricenumber · float · nullableRequiredDeprecated

Full price for the transport

Example: 250
requires_washingbooleanRequired

Flag to enable the truck washing flow in the mobile app

business_privacybooleanRequired

Flag to enable 'business privacy' mode: no eCMR will be generated, and the trucker won't be prompted to share the transport link.

is_multiple_compartmentsbooleanOptional

Flag to enable 'multiple compartments' mode: truckers will have to select in which compartments loads were loaded. It also generates a specific delivery document : loading_plan.

loading_planstringOptional

Uid of the loading plan created by the trucker. Contact us if you need to retrieve data from it

invoice_numberstring · nullableRequired
invoiced_pricenumber · float · nullableOptionalDeprecated

Invoiced price for the transport. Deprecated in favour of pricing field

Example: 250
volume_display_unitstring · enumOptionalPossible values:
billing-metricsstring · nullableOptionalDeprecated

Retired feature, will always be null.

shapestringOptional
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.

carbon_footprintnumber · nullableRead-onlyOptional

Carbon footprint of the transport in kgCO2

agreed_price_totalstring · nullableOptional

The total of the agreed price (including fuel surcharge, excluding taxes) if readable, otherwise null.

Example: 123.45
invoiced_price_totalstring · nullableOptional

The total of the invoiced price (including fuel surcharge, excluding taxes) if readable, otherwise null.

Example: 123.45
shipper_final_price_totalstring · nullableOptional

The total of the shipper final price (including fuel surcharge, excluding taxes) if readable, otherwise null.

Example: 123.45
effective_price_totalstring · nullableOptional

The total of the effective price (including fuel surcharge, excluding taxes) if readable, otherwise null.

Example: 123.45
purchase_cost_totalstring · nullableOptional

The total of the purchase costs if readable, otherwise null.

Example: 123.45
get
/transports/{uid}/
200Success

hashtag
Partially update a transport

patch
Authorizations
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/"
Path parameters
uidstringRequired
remote_idstringOptional

If you choose to identify an object with its remote_id instead of its uid then

  • replace the uid value with the remote_id value in the URL

  • specify lookup_field=remote_id in the query parameters

Query parameters
lookup_fieldstringOptional

Used to specify what field is used in the URL to identify the object you're requesting, e.g. with the remote_id (see path parameters)

Body
remote_idstringOptional

Your transport id. It has to be unique among all your transports

requested_vehiclestring · max: 40Optional

Only useful when the transport is created by the shipper. Free text except punction and special characters.

carrier_referencestringOptional

Text that will help the carrier operators manage the transports, e.g. transport number in his TMS

pricenumber · float · nullableOptionalDeprecated

Full price for the transport

Example: 250
requires_washingbooleanOptional

Flag to enable the truck washing flow in the mobile app

business_privacybooleanOptional

Flag to enable 'business privacy' mode: no eCMR will be generated, and the trucker won't be prompted to share the transport link.

is_multiple_compartmentsbooleanOptional

Flag to enable 'multiple compartments' mode: truckers will have to select in which compartments loads were loaded. It also generated a specific delivery document : loading_plan.

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.

volume_display_unitstring · enumOptionalDefault: m3Possible values:
transport_operation_category_uidstring · uuidOptional

UID of the transport operation category

send_to_truckerbooleanOptional

Flag to send the missions to the assigned truckers. It has no effect on already sent missions.

Default: true
Responses
chevron-right
200Success
application/json
uidstring · uuidRequired

Dashdoc's internal id. It will be automatically generated by us.

Example: 447521b0-e165-11ea-a488-0242ac110007
sequential_idnumberRequiredExample: 1240993
createdstring · date-timeRequired

Date of creation sent by the creator. Useful when the transport is created by mobile devices. If network connection is bad, the created date can be later than created_device

updatedstring · date-timeRequired
deletedstring · nullableOptional
remote_idstringRequired

Your transport id. It has to be unique among all your transports

created_devicestring · date-timeRequired
creation_methodstring · enumRequiredPossible values:
archived_byobject[]Optional
is_orderbooleanRequired
invite_codestringRequiredExample: RWMUYE
statusstring · enumRequiredPossible values:
has_observationsbooleanRequired
requested_vehiclestring · max: 40Required

Only useful when the transport is created by the shipper. Free text except punction and special characters.

carrier_referencestringRequired

Text that will help the carrier operators manage the transports, e.g. transport number in his TMS. It should only be set by the carrier of the transport and the transport's creator can toggle a company-wide setting to only allow the carrier to set it.

pricenumber · float · nullableRequiredDeprecated

Full price for the transport

Example: 250
requires_washingbooleanRequired

Flag to enable the truck washing flow in the mobile app

business_privacybooleanRequired

Flag to enable 'business privacy' mode: no eCMR will be generated, and the trucker won't be prompted to share the transport link.

is_multiple_compartmentsbooleanOptional

Flag to enable 'multiple compartments' mode: truckers will have to select in which compartments loads were loaded. It also generates a specific delivery document : loading_plan.

loading_planstringOptional

Uid of the loading plan created by the trucker. Contact us if you need to retrieve data from it

invoice_numberstring · nullableRequired
invoiced_pricenumber · float · nullableOptionalDeprecated

Invoiced price for the transport. Deprecated in favour of pricing field

Example: 250
volume_display_unitstring · enumOptionalPossible values:
billing-metricsstring · nullableOptionalDeprecated

Retired feature, will always be null.

shapestringOptional
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.

carbon_footprintnumber · nullableRead-onlyOptional

Carbon footprint of the transport in kgCO2

patch
/transports/{uid}/
200Success
PreviousTransport MessagesNextCharter

Last updated

Was this helpful?