Tracking Files

List all tracking files

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

Query parameters

pageintegerOptional

A page number within the paginated result set.

date__instringOptional

A date range to filter the tracking files.

Example: 2024-10-11T23:00:00Z,2024-10-15T23:00:00Z

status__instring · enumOptional

A comma separated list of statuses to filter the tracking files.

Example: open,closedPossible values:

transport_uid__instringOptional

A comma separated list of transport uids to filter the tracking files.

Example: 4443d4b6-e165-11ea-a488-0242ac110007,4443d4b6-e165-11ea-a488-0242ac110008

Responses

200

Get successful

application/json

countintegerOptionalExample: 1

nextstring · nullableOptional

previousstring · nullableOptional

get

/tracking-files/

HTTPcURLJavaScriptPython

GET /api/v4/tracking-files/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*

200

Get successful

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "uid": "123e4567-e89b-12d3-a456-426614174000",
      "status": "open",
      "created": "2023-10-01T00:00:00Z",
      "name": "My tracking file name",
      "shipper_id": 123,
      "quantity_per_transport": 100,
      "start_date": "2023-10-01T00:00:00Z",
      "end_date": "2023-10-10T00:00:00Z",
      "unit": "kilogram",
      "template_uid": "template-uid-123",
      "loading_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
        }
      },
      "unloading_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
        }
      },
      "total_load": {
        "uid": "text",
        "remote_id": "text",
        "description": "text",
        "reference": "text",
        "weight": 1,
        "volume": 1,
        "volume_display_unit": "m3",
        "linear_meters": 1,
        "quantity": 1,
        "category": "text",
        "dangerous_goods_category": "1",
        "is_dangerous": true,
        "adr_un_code": "text",
        "legal_mentions": "text",
        "complementary_information": "text",
        "container_number": "text",
        "tare_weight": 1,
        "container_seal_number": "text",
        "refrigerated": true,
        "temperature": "text",
        "steres": 1,
        "idtf_number": "text",
        "use_identifiers": true,
        "identifiers": "text",
        "identifiers_observations": "text"
      },
      "requires_washing": false,
      "is_multiple_compartments": false
    }
  ]
}

Create a tracking file

post

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

Body

application/json

namestringRequired

Name of the tracking file

Example: My tracking file name

shipper_idinteger · nullableRequired

ID of the shipper

Example: 123

start_datestring · date-time · nullableOptional

Start date of the tracking file

Example: 2023-10-01T00:00:00Z

end_datestring · date-time · nullableOptional

End date of the tracking file

Example: 2023-10-10T00:00:00Z

loading_address_idinteger · nullableOptional

ID of the loading address.

Example: 456

unloading_address_idinteger · nullableOptional

ID of the unloading address

Example: 789

quantity_per_transportnumber · float · nullableOptional

Quantity per transport

Example: 100

unitstring · enum · nullableOptional

Unit of measurement

Example: kilogramPossible values:

requires_washingbooleanOptional

Indicates if washing is required by default for transports that will be created in this tracking file

Default: falseExample: false

is_multiple_compartmentsbooleanOptional

Indicates if there are multiple compartments by default for transports that will be created in this tracking file

Default: falseExample: false

Responses

201

Create successful

application/json

post

/tracking-files/

HTTPcURLJavaScriptPython

POST /api/v4/tracking-files/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 696

{
  "name": "My tracking file name",
  "shipper_id": 123,
  "start_date": "2023-10-01T00:00:00Z",
  "end_date": "2023-10-10T00:00:00Z",
  "loading_address_id": 456,
  "unloading_address_id": 789,
  "quantity_per_transport": 100,
  "unit": "kilogram",
  "total_load": {
    "remote_id": "text",
    "description": "text",
    "reference": "text",
    "weight": 1,
    "volume": 1,
    "linear_meters": 1,
    "quantity": 1,
    "category": "text",
    "is_dangerous": false,
    "adr_un_code": "UN 1202",
    "legal_mentions": "Dangerous for the environment",
    "complementary_information": "text",
    "container_number": "text",
    "tare_weight": 1,
    "container_seal_number": "text",
    "refrigerated": true,
    "temperature": "text",
    "steres": 1,
    "idtf_number": "text"
  },
  "requires_washing": false,
  "is_multiple_compartments": false
}

201

Create successful

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "status": "open",
  "created": "2023-10-01T00:00:00Z",
  "name": "My tracking file name",
  "shipper_id": 123,
  "quantity_per_transport": 100,
  "start_date": "2023-10-01T00:00:00Z",
  "end_date": "2023-10-10T00:00:00Z",
  "unit": "kilogram",
  "template_uid": "template-uid-123",
  "loading_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
    }
  },
  "unloading_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
    }
  },
  "total_load": {
    "uid": "text",
    "remote_id": "text",
    "description": "text",
    "reference": "text",
    "weight": 1,
    "volume": 1,
    "volume_display_unit": "m3",
    "linear_meters": 1,
    "quantity": 1,
    "category": "text",
    "dangerous_goods_category": "1",
    "is_dangerous": true,
    "adr_un_code": "text",
    "legal_mentions": "text",
    "complementary_information": "text",
    "container_number": "text",
    "tare_weight": 1,
    "container_seal_number": "text",
    "refrigerated": true,
    "temperature": "text",
    "steres": 1,
    "idtf_number": "text",
    "use_identifiers": true,
    "identifiers": "text",
    "identifiers_observations": "text"
  },
  "requires_washing": false,
  "is_multiple_compartments": false
}

Delete a given tracking file

delete

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

Unique identifier of the tracking file

Responses

204

Delete successful

delete

/tracking-files/{uid}/

HTTPcURLJavaScriptPython

DELETE /api/v4/tracking-files/{uid}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*

204

Delete successful

No content

Read a tracking file

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

Unique identifier of the tracking file

Responses

200

Get successful

application/json

uidstringOptional

Unique identifier of the tracking file

Example: 123e4567-e89b-12d3-a456-426614174000

statusstring · enumOptional

Status of the tracking file

Example: openPossible values:

createdstring · date-timeOptional

Creation date of the tracking file

Example: 2023-10-01T00:00:00Z

namestringOptional

Name of the tracking file

Example: My tracking file name

shipper_idintegerOptional

Primary key of the shipper

Example: 123

quantity_per_transportnumber · floatOptional

Quantity per transport

Example: 100

start_datestring · date-timeOptional

Start date of the tracking file

Example: 2023-10-01T00:00:00Z

end_datestring · date-timeOptional

End date of the tracking file

Example: 2023-10-10T00:00:00Z

unitstring · enumOptional

Unit of measurement

Example: kilogramPossible values:

template_uidstringOptional

Unique identifier of the template linked to the tracking file

Example: template-uid-123

requires_washingbooleanOptional

Indicates if washing is required by default for transports that will be created in this tracking file

Example: false

is_multiple_compartmentsbooleanOptional

Indicates if there are multiple compartments by default for transports that will be created in this tracking file

Example: false

get

/tracking-files/{uid}/

HTTPcURLJavaScriptPython

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

200

Get successful

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "status": "open",
  "created": "2023-10-01T00:00:00Z",
  "name": "My tracking file name",
  "shipper_id": 123,
  "quantity_per_transport": 100,
  "start_date": "2023-10-01T00:00:00Z",
  "end_date": "2023-10-10T00:00:00Z",
  "unit": "kilogram",
  "template_uid": "template-uid-123",
  "loading_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
    }
  },
  "unloading_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
    }
  },
  "total_load": {
    "uid": "text",
    "remote_id": "text",
    "description": "text",
    "reference": "text",
    "weight": 1,
    "volume": 1,
    "volume_display_unit": "m3",
    "linear_meters": 1,
    "quantity": 1,
    "category": "text",
    "dangerous_goods_category": "1",
    "is_dangerous": true,
    "adr_un_code": "text",
    "legal_mentions": "text",
    "complementary_information": "text",
    "container_number": "text",
    "tare_weight": 1,
    "container_seal_number": "text",
    "refrigerated": true,
    "temperature": "text",
    "steres": 1,
    "idtf_number": "text",
    "use_identifiers": true,
    "identifiers": "text",
    "identifiers_observations": "text"
  },
  "requires_washing": false,
  "is_multiple_compartments": false
}

Update a given tracking file

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

Unique identifier of the tracking file

Body

application/json

namestringRequired

Name of the tracking file

Example: My tracking file name

shipper_idinteger · nullableRequired

ID of the shipper

Example: 123

start_datestring · date-time · nullableOptional

Start date of the tracking file

Example: 2023-10-01T00:00:00Z

end_datestring · date-time · nullableOptional

End date of the tracking file

Example: 2023-10-10T00:00:00Z

loading_address_idinteger · nullableOptional

ID of the loading address.

Example: 456

unloading_address_idinteger · nullableOptional

ID of the unloading address

Example: 789

quantity_per_transportnumber · float · nullableOptional

Quantity per transport

Example: 100

unitstring · enum · nullableOptional

Unit of measurement

Example: kilogramPossible values:

requires_washingbooleanOptional

Indicates if washing is required by default for transports that will be created in this tracking file

Default: falseExample: false

is_multiple_compartmentsbooleanOptional

Indicates if there are multiple compartments by default for transports that will be created in this tracking file

Default: falseExample: false

Responses

200

Update successful

application/json

uidstringOptional

Unique identifier of the tracking file

Example: 123e4567-e89b-12d3-a456-426614174000

statusstring · enumOptional

Status of the tracking file

Example: openPossible values:

createdstring · date-timeOptional

Creation date of the tracking file

Example: 2023-10-01T00:00:00Z

namestringOptional

Name of the tracking file

Example: My tracking file name

shipper_idintegerOptional

Primary key of the shipper

Example: 123

quantity_per_transportnumber · floatOptional

Quantity per transport

Example: 100

start_datestring · date-timeOptional

Start date of the tracking file

Example: 2023-10-01T00:00:00Z

end_datestring · date-timeOptional

End date of the tracking file

Example: 2023-10-10T00:00:00Z

unitstring · enumOptional

Unit of measurement

Example: kilogramPossible values:

template_uidstringOptional

Unique identifier of the template linked to the tracking file

Example: template-uid-123

requires_washingbooleanOptional

Indicates if washing is required by default for transports that will be created in this tracking file

Example: false

is_multiple_compartmentsbooleanOptional

Indicates if there are multiple compartments by default for transports that will be created in this tracking file

Example: false

patch

/tracking-files/{uid}/

HTTPcURLJavaScriptPython

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

{
  "name": "My tracking file name",
  "shipper_id": 123,
  "start_date": "2023-10-01T00:00:00Z",
  "end_date": "2023-10-10T00:00:00Z",
  "loading_address_id": 456,
  "unloading_address_id": 789,
  "quantity_per_transport": 100,
  "unit": "kilogram",
  "total_load": {
    "remote_id": "text",
    "description": "text",
    "reference": "text",
    "weight": 1,
    "volume": 1,
    "linear_meters": 1,
    "quantity": 1,
    "category": "text",
    "is_dangerous": false,
    "adr_un_code": "UN 1202",
    "legal_mentions": "Dangerous for the environment",
    "complementary_information": "text",
    "container_number": "text",
    "tare_weight": 1,
    "container_seal_number": "text",
    "refrigerated": true,
    "temperature": "text",
    "steres": 1,
    "idtf_number": "text"
  },
  "requires_washing": false,
  "is_multiple_compartments": false
}

200

Update successful

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "status": "open",
  "created": "2023-10-01T00:00:00Z",
  "name": "My tracking file name",
  "shipper_id": 123,
  "quantity_per_transport": 100,
  "start_date": "2023-10-01T00:00:00Z",
  "end_date": "2023-10-10T00:00:00Z",
  "unit": "kilogram",
  "template_uid": "template-uid-123",
  "loading_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
    }
  },
  "unloading_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
    }
  },
  "total_load": {
    "uid": "text",
    "remote_id": "text",
    "description": "text",
    "reference": "text",
    "weight": 1,
    "volume": 1,
    "volume_display_unit": "m3",
    "linear_meters": 1,
    "quantity": 1,
    "category": "text",
    "dangerous_goods_category": "1",
    "is_dangerous": true,
    "adr_un_code": "text",
    "legal_mentions": "text",
    "complementary_information": "text",
    "container_number": "text",
    "tare_weight": 1,
    "container_seal_number": "text",
    "refrigerated": true,
    "temperature": "text",
    "steres": 1,
    "idtf_number": "text",
    "use_identifiers": true,
    "identifiers": "text",
    "identifiers_observations": "text"
  },
  "requires_washing": false,
  "is_multiple_compartments": false
}