Transport Messages

Create a transport message

post
Authorizations
Body
uidstring · uuidOptionalExample: 1f527452-45f4-11eb-a722-0242ac140004
createdstring · date-timeOptional

Date of creation on our server

Example: 2020-12-22T15:31:39.26167Z
created_devicestring · date-timeOptional
creation_methodstringOptional
typestring · enum · max: 100RequiredPossible values:
document_titlestring · max: 100Optional

Filename or if uploaded by a trucker from the mobile app, the document title is generic, for instance photo.

Example: delivery_note_2105_001
document_typestring · enum · max: 100OptionalPossible values:
documentstring · byteOptional

File content. Use content-type with multipart/form-data value to the header of the request to send a document.

is_attached_to_cmrbooleanOptional
transportstring · uuidRequired
sitestring · uuid | nullableOptional

This field is used for the default values of the field readable_by_company_ids; if null, companies from all Sites of the transport are listed in readable_by_company_ids, otherwise only the company of this Site. Site must exist in this transport. This field is part of a beta feature.

Example: 6d95e434-146c-4b8d-a99c-7ef908238445
readable_by_company_idsinteger[]Optional

A list containing the pk of each company allowed to access the document, every company must be part of the transport. If no values are sent, it will be computed with default values; Carrier, Shipper, Invoiced Customer and Site's pk (see Site field). Once values have been sent, the behavior adding default companies is deactivated. The author company is always added. Only pks of companies from the transport will be added, others will be ignored. This field is part of a beta feature.

Example: [1, 2, 3, 4]
messagestringOptional

message displayed in the activity thread of a transport in the web app and in the mobile app

latitudenumber · floatOptional

Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.

Example: -52.5561625
longitudenumber · floatOptional

Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.

Example: 92.896504
referencestring · max: 140Optional

Free text. This reference is searchable in the transports dashboard.

Example: delivery note 123456 client 1
visible_by_everyonebooleanOptional

This field is used to make the transport message public, which makes it visible by all parties of the transport.

readable_by_truckerbooleanOptional

This field is used to allow truckers to see the transport message. Only available for carriers.

Responses
201
Create successful
application/json
post
POST /api/v4/transport-messages/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 653

{
  "uid": "1f527452-45f4-11eb-a722-0242ac140004",
  "created": "2020-12-22T15:31:39.26167Z",
  "created_device": "2025-06-22T23:11:15.441Z",
  "creation_method": "text",
  "author": {
    "display_name": "Adèle Bouvet",
    "company": 1738,
    "pk": 11239
  },
  "type": "note",
  "document_title": "delivery_note_2105_001",
  "document_type": "load_photo",
  "document": "Ynl0ZXM=",
  "is_attached_to_cmr": true,
  "transport": "123e4567-e89b-12d3-a456-426614174000",
  "site": "6d95e434-146c-4b8d-a99c-7ef908238445",
  "readable_by_company_ids": "[1, 2, 3, 4]",
  "message": "text",
  "latitude": -52.5561625,
  "longitude": 92.896504,
  "reference": "delivery note 123456 client 1",
  "visible_by_everyone": true,
  "readable_by_trucker": true
}
201

Create successful

{
  "uid": "1f527452-45f4-11eb-a722-0242ac140004",
  "created": "2020-12-22T15:31:39.26167Z",
  "created_device": "2025-06-22T23:11:15.441Z",
  "creation_method": "text",
  "author": {
    "display_name": "Adèle Bouvet",
    "company": 1738,
    "pk": 11239
  },
  "type": "note",
  "document_title": "text",
  "document_type": "load_photo",
  "document": "https://storage.googleapis.com/dashdoc-media/media/shipments/aabd42eb.png",
  "is_attached_to_cmr": true,
  "transport": "123e4567-e89b-12d3-a456-426614174000",
  "site": "6d95e434-146c-4b8d-a99c-7ef908238445",
  "site_remote_id": "text",
  "readable_by_company_ids": "[1, 2, 3, 4]",
  "message": "text",
  "latitude": -52.5561625,
  "longitude": 92.896504,
  "reference": "delivery note 123456 client 1",
  "visible_by_everyone": true,
  "readable_by_trucker": true
}

Delete a transport message

delete
Authorizations
Path parameters
uidstringRequired
Responses
204
Empty body
delete
DELETE /api/v4/transport-messages/{uid}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*
204

Empty body

No content

Read a transport message

get
Authorizations
Path parameters
uidstringRequired
Responses
200
Get successful
application/json
get
GET /api/v4/transport-messages/{uid}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*
200

Get successful

{
  "uid": "1f527452-45f4-11eb-a722-0242ac140004",
  "created": "2020-12-22T15:31:39.26167Z",
  "created_device": "2025-06-22T23:11:15.441Z",
  "creation_method": "text",
  "author": {
    "display_name": "Adèle Bouvet",
    "company": 1738,
    "pk": 11239
  },
  "type": "note",
  "document_title": "text",
  "document_type": "load_photo",
  "document": "https://storage.googleapis.com/dashdoc-media/media/shipments/aabd42eb.png",
  "is_attached_to_cmr": true,
  "transport": "123e4567-e89b-12d3-a456-426614174000",
  "site": "6d95e434-146c-4b8d-a99c-7ef908238445",
  "site_remote_id": "text",
  "readable_by_company_ids": "[1, 2, 3, 4]",
  "message": "text",
  "latitude": -52.5561625,
  "longitude": 92.896504,
  "reference": "delivery note 123456 client 1",
  "visible_by_everyone": true,
  "readable_by_trucker": true,
  "extracted_reference": "AX22"
}

Partially update a transport message

patch
Authorizations
Path parameters
uidstringRequired
Body
uidstring · uuidOptionalExample: 1f527452-45f4-11eb-a722-0242ac140004
createdstring · date-timeOptional

Date of creation on our server

Example: 2020-12-22T15:31:39.26167Z
created_devicestring · date-timeOptional
creation_methodstringOptional
typestring · enum · max: 100OptionalPossible values:
document_titlestring · max: 100Optional

Filename or if uploaded by a trucker from the mobile app, the document title is generic, for instance photo.

document_typestring · enum · max: 100OptionalPossible values:
is_attached_to_cmrbooleanOptional
transportstring · uuidOptional
sitestring · uuid | nullableOptional

This field is used for the default values of the field readable_by_company_ids; if null, companies from all Sites of the transport are listed in readable_by_company_ids, otherwise only the company of this Site. Site must exist in this transport. This field is part of a beta feature.

Example: 6d95e434-146c-4b8d-a99c-7ef908238445
readable_by_company_idsinteger[]Optional

A list containing the pk of each company allowed to access the document, every company must be part of the transport. If no values are sent, it will be computed with default values; Carrier, Shipper, Invoiced Customer and Site's pk (see Site field). Once values have been sent, the behavior adding default companies is deactivated. The author company is always added. Only pks of companies from the transport will be added, others will be ignored. This field is part of a beta feature.

Example: [1, 2, 3, 4]
messagestringOptional

message displayed in the activity thread of a transport in the web app and in the mobile app

latitudenumber · floatOptional

Latitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.

Example: -52.5561625
longitudenumber · floatOptional

Longitude using the decimal GPS coordinates (WGS84). At 7 decimals, the position is accurate around the centimeter.

Example: 92.896504
referencestring · max: 140Optional

Free text. This reference is searchable in the transports dashboard. Filled by trucker if document is added from mobile app, by user if document is added from web app, or filled by API request.

Example: delivery note 123456 client 1
visible_by_everyonebooleanOptional

This field is used to make the transport message public, which makes it visible by all parties of the transport.

readable_by_truckerbooleanOptional

This field is used to allow truckers to see the transport message. Only available for carriers.

Responses
200
Update successful
application/json
patch
PATCH /api/v4/transport-messages/{uid}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 689

{
  "uid": "1f527452-45f4-11eb-a722-0242ac140004",
  "created": "2020-12-22T15:31:39.26167Z",
  "created_device": "2025-06-22T23:11:15.441Z",
  "creation_method": "text",
  "author": {
    "display_name": "Adèle Bouvet",
    "company": 1738,
    "pk": 11239
  },
  "type": "note",
  "document_title": "text",
  "document_type": "load_photo",
  "document": {
    "value": "text",
    "options": {
      "filename": "delivery_note_2105_001"
    }
  },
  "is_attached_to_cmr": true,
  "transport": "123e4567-e89b-12d3-a456-426614174000",
  "site": "6d95e434-146c-4b8d-a99c-7ef908238445",
  "readable_by_company_ids": "[1, 2, 3, 4]",
  "message": "text",
  "latitude": -52.5561625,
  "longitude": 92.896504,
  "reference": "delivery note 123456 client 1",
  "visible_by_everyone": true,
  "readable_by_trucker": true
}
200

Update successful

{
  "uid": "1f527452-45f4-11eb-a722-0242ac140004",
  "created": "2020-12-22T15:31:39.26167Z",
  "created_device": "2025-06-22T23:11:15.441Z",
  "creation_method": "text",
  "author": {
    "display_name": "Adèle Bouvet",
    "company": 1738,
    "pk": 11239
  },
  "type": "note",
  "document_title": "text",
  "document_type": "load_photo",
  "document": "https://storage.googleapis.com/dashdoc-media/media/shipments/aabd42eb.png",
  "is_attached_to_cmr": true,
  "transport": "123e4567-e89b-12d3-a456-426614174000",
  "site": "6d95e434-146c-4b8d-a99c-7ef908238445",
  "readable_by_company_ids": "[1, 2, 3, 4]",
  "message": "text",
  "latitude": -52.5561625,
  "longitude": 92.896504,
  "reference": "delivery note 123456 client 1",
  "visible_by_everyone": true,
  "readable_by_trucker": true,
  "extracted_reference": "AX22"
}
PreviousTransport Loading PlansNextTransports

Last updated

Was this helpful?