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. GET STARTED
  2. Understand the data model

Transport - Segment - Delivery

PreviousUnderstand the data modelNextOrigin/Destination sites

Last updated 1 year ago

Was this helpful?

Transport is our main model. It is linked to a single main carrier (carrier_address field), and most importantly can store multiple Deliveries and Segments.

A Transport must contain at least one Segment and one Delivery

A Delivery object represents a single delivery for a single client. It has one origin and one destination (both are objects), and an array of Loads(goods to be delivered).

Segments represent the way the Deliveries contained in the transport will be effectively delivered. We can say the Delivery is what the carrier is supposed to do, and the Segment is how the carrier does it. A Segment object has one origin and one destination (again, both are objects), and a and vehicle and/or trailer license plates.

For a simple transport (one Delivery, one Segment), there are only two sites, A and B. The Delivery and the Segment have the same origin and the same destination. The Delivery contains the shipping data, and the segment the trucker data.

Let's now consider a more complex transport. The carrier is ordered to ship two goods from two different origins to the same destination. One trucker will grab the goods, will ship them to a storehouse and another trucker will drive them from the storehouse to the destination.

A is the first loading point stop, B is the second one, C is the storehouse stop and D is the unloading stop.

πŸ‘‹
Site
Site
Trucker
Simple Transport Example
More complex transport example