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
  • Transport
  • Status
  • Invoicing address
  • Sites
  • Asked time slots
  • Transport statuses
  • Transport messages (uploaded documents)
  • Delivery loads
  • Companies
  • Country
  • Truckers

Was this helpful?

  1. UPGRADES

Upgrading API from v3 to v4

Transport

Status

Add the sent_to_trucker status category. When a transport is assigned to a trucker but not sent, the status is assigned.

Invoicing address

delivery.invoicing_address is moved to transport.invoicing_address.

Before (v3)

{
    "deliveries": [{
         "invoicing_address": {...}
    }]
}

After (v4)

{
    "invoicing_address": {...},
    "deliveries": [{...}]
}

Sites

Asked time slots

The following fields are now removed:

arrival_date 
arrival_time_min 
arrival_time_max 
date_exact

They are replaced by the slots field, which represents the time slots asked by the shipper.

Two new fields are added: real_start and real_end, which are the actual times at which the trucker arrived on site and left the site.

Before (v3)

{
    "uid": "aaaa-aaaa-aaaa-aaaa",
    "arrival_date": "2021-03-02",
    "arrival_time_min": "08:00",
    "arrival_time_max": "09:00",
    "date_exact": true
}

After (v4)

{
    "uid": "aaaa-aaaa-aaaa-aaaa",
    "slots": [
        {
            "start": "2021-03-02T00:08:00Z", 
            "end": "2021-03-02T00:09:00Z"
        }
    ],
    "real_start": "2021-03-02T00:08:04Z", 
    "real_end": "2021-03-02T00:08:26Z", 
}

Transport statuses

The field holder_exchanges is removed in v4. It is replaced by the dedicated /api/v4/supports-exchanges/ and /api/v4/support-types/ APIs.

Transport messages (uploaded documents)

The field delivery is removed in v4.

Delivery loads

Update type of volume, weight, tare_weight and linear_meters that are now float instead of string.

Before (v3)

{
    "volume": "2.3",
    "weight": "230",
    "tare_weight": "1400",
    "linear_meters": "3.5"
}

After (v4)

{
    "volume": 2.3,
    "weight": 230,
    "tare_weight": 1400,
    "linear_meters": 3.5
}

Companies

Country

The country field is now mandatory on companies.

Truckers

The param chartered in the truckers filter (URL parameter) is renamed to rental.

GET https://api.dashdoc.eu/api/v4/truckers/?rental=true
PreviousUse the mobile app to simulate transportsNextList of all endpoints for v4

Last updated 1 year ago

Was this helpful?

πŸ’‘