Transport Messages

Create a transport message

POSThttps://api.dashdoc.eu/api/v4/transport-messages/

Body

application/json

uidstring (uuid)

createdcreated (string (date-time))

Date of creation on our server

created_devicestring (date-time)

creation_methodstring

authorNewTransportMessage_author (object)

type*enum

noteload_verificationsharedocumentphoto

document_titlestring

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

document_typeenum

load_photocmrwashing_notedelivery_noteconfirmationweight_notewaste_manifestholders_swap_noteinvoice

documentstring (byte)

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

is_attached_to_cmrboolean

transport*string (uuid)

sitenullable string (uuid)

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.

readable_by_company_idsarray of integer

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.

messagestring

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

latitudelatitude (number (float))

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

longitudelongitude (number (float))

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

referencestring

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

visible_by_everyonevisible_by_everyone (boolean)

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

readable_by_truckerreadable_by_trucker (boolean)

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

Response

201

Create successful

Body

application/json

uidstring (uuid)

createdcreated (string (date-time))

Date of creation on our server

created_devicestring (date-time)

creation_methodstring

authorNewTransportMessage_author (object)

typeenum

noteload_verificationsharedocumentphoto

document_titlestring

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

document_typeenum

load_photocmrwashing_notedelivery_noteconfirmationweight_notewaste_manifestholders_swap_noteinvoice

documentstring

URL of the stored document. You can download the document from this URL.

is_attached_to_cmrboolean

transportstring (uuid)

sitenullable string (uuid)

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.

site_remote_idstring

readable_by_company_idsarray of integer

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.

messagestring

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

latitudelatitude (number (float))

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

longitudelongitude (number (float))

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

referencestring

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.

visible_by_everyonevisible_by_everyone (boolean)

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

readable_by_truckerreadable_by_trucker (boolean)

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

Request

JavaScriptCurl

const response = await fetch('https://api.dashdoc.eu/api/v4/transport-messages/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "transport": "123e4567-e89b-12d3-a456-426614174000",
      "type": "note"
    }),
});
const data = await response.json();

Response

{
  "uid": "1f527452-45f4-11eb-a722-0242ac140004",
  "created": "2020-12-22T15:31:39.26167Z",
  "created_device": "2024-04-28T16:34:04.350Z",
  "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": false,
  "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": false,
  "readable_by_trucker": false
}

Delete a transport message

DELETEhttps://api.dashdoc.eu/api/v4/transport-messages/{uid}/

Path parameters

uid*string

Response

204

Empty body

Request

JavaScriptCurl

const response = await fetch('https://api.dashdoc.eu/api/v4/transport-messages/{uid}/', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Read a transport message

GEThttps://api.dashdoc.eu/api/v4/transport-messages/{uid}/

Path parameters

uid*string

Response

200

Get successful

Body

application/json

uidstring (uuid)

createdcreated (string (date-time))

Date of creation on our server

created_devicestring (date-time)

creation_methodstring

authorNewTransportMessage_author (object)

typeenum

noteload_verificationsharedocumentphoto

document_titlestring

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

document_typeenum

load_photocmrwashing_notedelivery_noteconfirmationweight_notewaste_manifestholders_swap_noteinvoice

documentstring

URL of the stored document. You can download the document from this URL.

is_attached_to_cmrboolean

transportstring (uuid)

sitenullable string (uuid)

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.

site_remote_idstring

readable_by_company_idsarray of integer

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.

messagestring

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

latitudelatitude (number (float))

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

longitudelongitude (number (float))

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

referencestring

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.

visible_by_everyonevisible_by_everyone (boolean)

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

readable_by_truckerreadable_by_trucker (boolean)

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

extracted_referencestring

Reference extracted by AI from the document. AI runs only on weight notes, so it will be null for other documents. "" if no reference has been found by the AI.

Request

JavaScriptCurl

const response = await fetch('https://api.dashdoc.eu/api/v4/transport-messages/{uid}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "uid": "1f527452-45f4-11eb-a722-0242ac140004",
  "created": "2020-12-22T15:31:39.26167Z",
  "created_device": "2024-04-28T16:34:04.350Z",
  "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": false,
  "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": false,
  "readable_by_trucker": false,
  "extracted_reference": "AX22"
}

Partially update a transport message

PATCHhttps://api.dashdoc.eu/api/v4/transport-messages/{uid}/

Path parameters

uid*string

Body

application/json

uidstring (uuid)

createdcreated (string (date-time))

Date of creation on our server

created_devicestring (date-time)

creation_methodstring

authorNewTransportMessage_author (object)

typeenum

noteload_verificationsharedocumentphoto

document_titlestring

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

document_typeenum

load_photocmrwashing_notedelivery_noteconfirmationweight_notewaste_manifestholders_swap_noteinvoice

documentUpdateTransportMessage_document (object)

is_attached_to_cmrboolean

transportstring (uuid)

sitenullable string (uuid)

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.

readable_by_company_idsarray of integer

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.

messagestring

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

latitudelatitude (number (float))

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

longitudelongitude (number (float))

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

referencestring

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.

visible_by_everyonevisible_by_everyone (boolean)

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

readable_by_truckerreadable_by_trucker (boolean)

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

Response

200

Update successful

Body

application/json

uidstring (uuid)

createdcreated (string (date-time))

Date of creation on our server

created_devicestring (date-time)

creation_methodstring

authorNewTransportMessage_author (object)

typeenum

noteload_verificationsharedocumentphoto

document_titlestring

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

document_typeenum

load_photocmrwashing_notedelivery_noteconfirmationweight_notewaste_manifestholders_swap_noteinvoice

documentstring

URL of the stored document. You can download the document from this URL.

is_attached_to_cmrboolean

transportstring (uuid)

sitenullable string (uuid)

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.

readable_by_company_idsarray of integer

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.

messagestring

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

latitudelatitude (number (float))

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

longitudelongitude (number (float))

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

referencestring

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.

visible_by_everyonevisible_by_everyone (boolean)

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

readable_by_truckerreadable_by_trucker (boolean)

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

extracted_referencestring

Reference extracted by AI from the document. AI runs only on weight notes, so it will be null for other documents. "" if no reference has been found by the AI.

Request

JavaScriptCurl

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

Response

{
  "uid": "1f527452-45f4-11eb-a722-0242ac140004",
  "created": "2020-12-22T15:31:39.26167Z",
  "created_device": "2024-04-28T16:34:04.350Z",
  "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": false,
  "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": false,
  "readable_by_trucker": false,
  "extracted_reference": "AX22"
}