Dashdoc API Documentation
  • 👋GET STARTED
    • Introduction
    • Core API concepts
      • Authentication
      • External identifiers
      • Date and time formats
      • Requests and filters
      • Pagination
      • HTTP status codes
      • Rate limiting
      • Send documents
    • Understand the data model
      • Transport - Segment - Delivery
      • Origin/Destination sites
      • Company - Address
      • Trucker
  • 🔁INTEGRATE YOUR SOFTWARE
    • How to integrate your software with Dashdoc
    • Setup
      • Create a sandbox account
      • Get the API token
      • Make an authenticated request
  • 🎓USE CASES AND TUTORIALS
    • Shippers (ERP, WMS) 🔀
      • Create a simple transport as a shipper
      • Manage the address book
    • Carriers 🚛
      • Create a simple transport as a carrier
      • Create a multi-deliveries transport as a carrier
      • Create a break in a transport (segment)
      • Charter whole or part of a transport - Affrètement
      • Manage truckers
      • Create and follow rental orders
      • Handle Qualimat transports
    • Retrieve transport data 🏁
      • Get last updated transports (Poll vs. webhooks)
      • Get status updates with dates and times
      • Get load information (quantity, weight...)
      • Get mileage from transport
      • Get documents and photos with their type
      • Get observations from trucker / signatory
      • Get information about washings
      • Filter transports created by your truckers and partners
    • Invoicing 💰
    • Dashdoc Wam ♻️
      • Create a Waste Form
      • Sign a Waste Form as Organizer
      • Create a Transport for a Waste Form
      • Find the transport linked to a waste form
  • ☁️WEBHOOKS
    • Webhooks
  • 📱MOBILE APP
    • Use the mobile app to simulate transports
  • 💡UPGRADES
    • Upgrading API from v3 to v4
  • 📚API Reference
    • API v4 Reference
    • List of all endpoints for v4
      • Addresses
        • Security Protocol
      • Adr Un Codes
      • Carbon Footprint
        • Transport Operation Categories
      • Companies
      • Contacts
        • Invite
      • Deliveries
        • Add Round
        • Cmrs
      • Dock Activities
        • Mark Loaded By Dock
        • Mark Unloaded By Dock
      • Invoices
        • Items
        • Mark Paid
        • Mark Not Paid
      • Managers
        • Invite
        • Me
        • Set Company
      • Manager Truckers
        • Lease
        • Generate Invite Code
        • Unavailability
      • Security Protocols
      • Segments
        • Assign
        • Break
        • Charter
      • Tracking Files
      • Sites
        • Mark Done
        • Enable Eta
      • Support Types
      • Supports Exchanges
      • Telematics
        • Vehicles
        • Traces
      • Trailers
        • Unavailability
      • Track Dechets
      • Transport Loading Plans
      • Transport Messages
      • Transports
        • Charter
        • Assign
        • Archive
        • Merge To Trip
        • Mark Done
        • Mark Invoiced
        • Mark Paid
        • Cancel
        • Confirm
        • Decline
        • Revenue Split
        • Cmrs
        • Effective Price Lines
        • Loads Constraints
      • Transport Status
      • Transport Templates
      • Scheduler
        • Trips
          • Set Name
      • Vehicles
        • Unavailability
      • Wam
        • Contacts
        • Forms
          • Sign As Organizer
          • Create Transport
          • Loads
        • Companies
          • Details
Powered by GitBook
On this page

Was this helpful?

  1. API Reference
  2. List of all endpoints for v4

Tracking Files

PreviousCharterNextSites

Last updated 3 months ago

Was this helpful?

📚

Delete a given tracking file

delete
Authorizations
Path parameters
uidstringRequired

Unique identifier of the tracking file

Responses
204
Delete successful
delete
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
Path parameters
uidstringRequired

Unique identifier of the tracking file

Responses
200
Get successful
application/json
get
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": "i.love.dashdoc@gmail.com",
      "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": "adele.bouvet@gmail.com",
            "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": "i.love.dashdoc@gmail.com",
      "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": "adele.bouvet@gmail.com",
            "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",
    "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
}
  • GETList all tracking files
  • POSTCreate a tracking file
  • DELETEDelete a given tracking file
  • GETRead a tracking file
  • PATCHUpdate a given tracking file

List all tracking files

get
Authorizations
Query parameters
pageintegerOptional

A page number within the paginated result set.

Responses
200
Get successful
application/json
get
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": "i.love.dashdoc@gmail.com",
          "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": "adele.bouvet@gmail.com",
                "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": "i.love.dashdoc@gmail.com",
          "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": "adele.bouvet@gmail.com",
                "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",
        "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
Body
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
POST /api/v4/tracking-files/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 677

{
  "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",
    "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": "i.love.dashdoc@gmail.com",
      "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": "adele.bouvet@gmail.com",
            "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": "i.love.dashdoc@gmail.com",
      "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": "adele.bouvet@gmail.com",
            "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",
    "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
Path parameters
uidstringRequired

Unique identifier of the tracking file

Body
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
patch
PATCH /api/v4/tracking-files/{uid}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 677

{
  "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",
    "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": "i.love.dashdoc@gmail.com",
      "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": "adele.bouvet@gmail.com",
            "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": "i.love.dashdoc@gmail.com",
      "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": "adele.bouvet@gmail.com",
            "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",
    "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
}