Sites

Read a site

get

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/"

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

200

Get successful

application/json

get

/sites/{uid}

HTTPcURLJavaScriptPython

GET /api/v4/sites/{uid} HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*

200

Get successful

{
  "uid": "687cddac-dbd2-11ea-9024-0242ac130006",
  "remote_id": "text",
  "address": {
    "pk": 23498,
    "name": "Transport Bouvet",
    "address": "3 rue des champs",
    "city": "Nantes",
    "postcode": "44000",
    "country": "FR",
    "latitude": -52.5561625,
    "longitude": 92.896504,
    "radius": 500,
    "coords_validated": false,
    "is_demo": true,
    "is_carrier": true,
    "is_shipper": true,
    "is_origin": true,
    "is_destination": true,
    "created_by": {
      "pk": 25,
      "name": "Transport Bouvet"
    },
    "created_by_user": {
      "pk": 34,
      "display_name": "Jean Pierre Bouvet",
      "company": 25,
      "trucker_id": 95
    },
    "created": "2020-12-22T15:31:39.26167Z",
    "instructions": "text",
    "remote_id": "text",
    "company": {
      "pk": 928,
      "remote_id": "text",
      "created": "2020-07-30T21:10:06.445510Z",
      "updated": "2020-07-30T21:10:06.44551Z",
      "deleted": true,
      "invoicing_remote_id": "COMP_456",
      "name": "Transport Bouvet",
      "phone_number": "0601020304",
      "email": "[email protected]",
      "siren": "123456789",
      "trade_number": "text",
      "country": "FR",
      "comments": "text",
      "vat_number": "text",
      "is_verified": true,
      "settings_transport_order_observations": "text",
      "settings_constrain_reference_edition": true,
      "account_type": "text",
      "logo": "text",
      "subscription_access": {},
      "settings": {},
      "primary_address": {
        "pk": "text",
        "name": "Transport Bouvet",
        "address": "3 rue des champs",
        "city": "Nantes",
        "postcode": "44000",
        "country": "FR",
        "latitude": -52.5561625,
        "longitude": 92.896504,
        "radius": 500,
        "coords_validated": false,
        "is_demo": true,
        "is_carrier": true,
        "is_shipper": true,
        "is_origin": true,
        "is_destination": true,
        "created_by": 1,
        "created": "2020-07-30T21:10:06.44551Z",
        "instructions": "text",
        "remote_id": "text"
      },
      "managers": [
        {
          "pk": 928,
          "user": {
            "email": "[email protected]",
            "first_name": "Adèle",
            "last_name": "Bouvet"
          },
          "display_name": "text",
          "role": "text"
        }
      ],
      "has_loggable_managers": true
    }
  },
  "real_start": "2020-12-22T15:31:39.26167Z",
  "real_end": "2020-12-22T15:31:39.26167Z",
  "signature_process": "sign_on_glass",
  "instructions": "text",
  "reference": "text",
  "action": "text",
  "eta": "text",
  "eta_tracking": false,
  "punctuality_status": "untracked",
  "supports_exchanges": {
    "uid": "123e4567-e89b-12d3-a456-426614174000",
    "site": {
      "uid": "123e4567-e89b-12d3-a456-426614174000",
      "remote_id": "text"
    },
    "support_type": {
      "name": "Palettes",
      "created": "2020-12-22T15:31:39.26167Z",
      "uid": "c8e4cc62-446a-11eb-a759-0242ac130005",
      "remote_id": "text"
    },
    "expected_retrieved": 10,
    "actual_retrieved": 10,
    "expected_delivered": 10,
    "actual_delivered": 10,
    "observations": "1 broken",
    "remote_id": "text"
  },
  "category": "loading",
  "slots": [
    {
      "start": "2026-01-19T15:26:18.096Z",
      "end": "2026-01-19T15:26:18.096Z"
    }
  ],
  "trucker_instructions": "text"
}

Partially update a site

patch

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/"

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

application/json

uidstring · uuidOptionalExample: 687cddac-dbd2-11ea-9024-0242ac130006

remote_idstringOptional

The id of the site in your system

real_startstring · date-timeOptional

date and time when trucker arrived on site

Example: 2020-12-22T15:31:39.26167Z

real_endstring · date-timeOptional

date and time when trucker completed loading / unloading (depending whether site is origin or destination)

Example: 2020-12-22T15:31:39.26167Z

signature_processstringOptionalExample: sign_on_glass

is_booking_neededbooleanOptional

instructionsstring · max: 1000Optional

Site instructions, visible to all parties (trucker, carrier, shipper, site). Displayed in the trucker mobile app. Not visible in the eCMR. If the field is not provided, the address's site instructions will be used.

referencestringOptional

actionstringOptional

etastring | nullableOptional

eta_trackingbooleanOptional

punctuality_statusstringOptional

categorystringOptional

trucker_instructionsstring · max: 1000Optional

This field is part of a beta feature. Private instructions. The carrier of the transport is the only one who can edit and read those instructions. Note that those instructions are not visible in the consignment note and can be accessed by the trucker. The value is null if the caller doesn't have the right of access to the data.

Responses

200

Update successful

application/json

patch

/sites/{uid}

HTTPcURLJavaScriptPython

PATCH /api/v4/sites/{uid} HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2508

{
  "uid": "687cddac-dbd2-11ea-9024-0242ac130006",
  "remote_id": "text",
  "address": {
    "pk": 23498,
    "name": "Transport Bouvet",
    "address": "3 rue des champs",
    "city": "Nantes",
    "postcode": "44000",
    "country": "FR",
    "latitude": -52.5561625,
    "longitude": 92.896504,
    "radius": 500,
    "coords_validated": false,
    "is_demo": true,
    "is_carrier": true,
    "is_shipper": true,
    "is_origin": true,
    "is_destination": true,
    "created_by": {
      "pk": 25,
      "name": "Transport Bouvet"
    },
    "created_by_user": {
      "pk": 34,
      "display_name": "Jean Pierre Bouvet",
      "company": 25,
      "trucker_id": 95
    },
    "created": "2020-12-22T15:31:39.26167Z",
    "instructions": "text",
    "remote_id": "text",
    "company": {
      "pk": 928,
      "remote_id": "text",
      "created": "2020-07-30T21:10:06.445510Z",
      "updated": "2020-07-30T21:10:06.44551Z",
      "deleted": true,
      "invoicing_remote_id": "COMP_456",
      "name": "Transport Bouvet",
      "phone_number": "0601020304",
      "email": "[email protected]",
      "siren": "123456789",
      "trade_number": "text",
      "country": "FR",
      "comments": "text",
      "vat_number": "text",
      "is_verified": true,
      "settings_transport_order_observations": "text",
      "settings_constrain_reference_edition": true,
      "account_type": "text",
      "logo": "text",
      "subscription_access": {},
      "settings": {},
      "primary_address": {
        "pk": "text",
        "name": "Transport Bouvet",
        "address": "3 rue des champs",
        "city": "Nantes",
        "postcode": "44000",
        "country": "FR",
        "latitude": -52.5561625,
        "longitude": 92.896504,
        "radius": 500,
        "coords_validated": false,
        "is_demo": true,
        "is_carrier": true,
        "is_shipper": true,
        "is_origin": true,
        "is_destination": true,
        "created_by": 1,
        "created": "2020-07-30T21:10:06.44551Z",
        "instructions": "text",
        "remote_id": "text"
      },
      "managers": [
        {
          "pk": 928,
          "user": {
            "email": "[email protected]",
            "first_name": "Adèle",
            "last_name": "Bouvet"
          },
          "display_name": "text",
          "role": "text"
        }
      ],
      "has_loggable_managers": true
    }
  },
  "real_start": "2020-12-22T15:31:39.26167Z",
  "real_end": "2020-12-22T15:31:39.26167Z",
  "signature_process": "sign_on_glass",
  "is_booking_needed": true,
  "instructions": "text",
  "reference": "text",
  "action": "text",
  "eta": "text",
  "eta_tracking": true,
  "punctuality_status": "text",
  "supports_exchanges": {
    "uid": "123e4567-e89b-12d3-a456-426614174000",
    "site": {
      "uid": "123e4567-e89b-12d3-a456-426614174000",
      "remote_id": "text"
    },
    "support_type": {
      "name": "Palettes",
      "created": "2020-12-22T15:31:39.26167Z",
      "uid": "c8e4cc62-446a-11eb-a759-0242ac130005",
      "remote_id": "text"
    },
    "expected_retrieved": 10,
    "actual_retrieved": 10,
    "expected_delivered": 10,
    "actual_delivered": 10,
    "observations": "1 broken",
    "remote_id": "text"
  },
  "category": "text",
  "slots": [
    {
      "start": "2026-01-19T15:26:18.096Z",
      "end": "2026-01-19T15:26:18.096Z"
    }
  ],
  "trucker_instructions": "text"
}

200

Update successful

{
  "uid": "687cddac-dbd2-11ea-9024-0242ac130006",
  "remote_id": "text",
  "address": {
    "pk": 23498,
    "name": "Transport Bouvet",
    "address": "3 rue des champs",
    "city": "Nantes",
    "postcode": "44000",
    "country": "FR",
    "latitude": -52.5561625,
    "longitude": 92.896504,
    "radius": 500,
    "coords_validated": false,
    "is_demo": true,
    "is_carrier": true,
    "is_shipper": true,
    "is_origin": true,
    "is_destination": true,
    "created_by": {
      "pk": 25,
      "name": "Transport Bouvet"
    },
    "created_by_user": {
      "pk": 34,
      "display_name": "Jean Pierre Bouvet",
      "company": 25,
      "trucker_id": 95
    },
    "created": "2020-12-22T15:31:39.26167Z",
    "instructions": "text",
    "remote_id": "text",
    "company": {
      "pk": 928,
      "remote_id": "text",
      "created": "2020-07-30T21:10:06.445510Z",
      "updated": "2020-07-30T21:10:06.44551Z",
      "deleted": true,
      "invoicing_remote_id": "COMP_456",
      "name": "Transport Bouvet",
      "phone_number": "0601020304",
      "email": "[email protected]",
      "siren": "123456789",
      "trade_number": "text",
      "country": "FR",
      "comments": "text",
      "vat_number": "text",
      "is_verified": true,
      "settings_transport_order_observations": "text",
      "settings_constrain_reference_edition": true,
      "account_type": "text",
      "logo": "text",
      "subscription_access": {},
      "settings": {},
      "primary_address": {
        "pk": "text",
        "name": "Transport Bouvet",
        "address": "3 rue des champs",
        "city": "Nantes",
        "postcode": "44000",
        "country": "FR",
        "latitude": -52.5561625,
        "longitude": 92.896504,
        "radius": 500,
        "coords_validated": false,
        "is_demo": true,
        "is_carrier": true,
        "is_shipper": true,
        "is_origin": true,
        "is_destination": true,
        "created_by": 1,
        "created": "2020-07-30T21:10:06.44551Z",
        "instructions": "text",
        "remote_id": "text"
      },
      "managers": [
        {
          "pk": 928,
          "user": {
            "email": "[email protected]",
            "first_name": "Adèle",
            "last_name": "Bouvet"
          },
          "display_name": "text",
          "role": "text"
        }
      ],
      "has_loggable_managers": true
    }
  },
  "real_start": "2020-12-22T15:31:39.26167Z",
  "real_end": "2020-12-22T15:31:39.26167Z",
  "signature_process": "sign_on_glass",
  "is_booking_needed": true,
  "instructions": "text",
  "reference": "text",
  "action": "text",
  "eta": "text",
  "eta_tracking": true,
  "punctuality_status": "text",
  "supports_exchanges": {
    "uid": "123e4567-e89b-12d3-a456-426614174000",
    "site": {
      "uid": "123e4567-e89b-12d3-a456-426614174000",
      "remote_id": "text"
    },
    "support_type": {
      "name": "Palettes",
      "created": "2020-12-22T15:31:39.26167Z",
      "uid": "c8e4cc62-446a-11eb-a759-0242ac130005",
      "remote_id": "text"
    },
    "expected_retrieved": 10,
    "actual_retrieved": 10,
    "expected_delivered": 10,
    "actual_delivered": 10,
    "observations": "1 broken",
    "remote_id": "text"
  },
  "category": "text",
  "slots": [
    {
      "start": "2026-01-19T15:26:18.096Z",
      "end": "2026-01-19T15:26:18.096Z"
    }
  ],
  "trucker_instructions": "text"
}