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. USE CASES AND TUTORIALS
  2. Carriers πŸš›

Create a simple transport as a carrier

PreviousCarriers πŸš›NextCreate a multi-deliveries transport as a carrier

Last updated 1 year ago

Was this helpful?

A simple transport consists in a single delivery from an origin site A to a destination site B. Remember our models ? If you haven't yet, please have a look at it ;-)

Step 1: Get your API Token

Step 2: Get your company's primary key (pk)

You can find your own company's pk by going to the address book on the web app, to the category "Carriers". And clicking on your own company will show the pk in the address bar (you will be on the page https://www.dashdoc.eu/app/address-book/companies/YOUR_PK/ )

Step 3: Create your first transport!

Remember to send your API token in the request headers, see:

Below is an JSON example of a simple transport. You can copy / paste this example to create your first transport. All you need to do is replace the value YOUR_COMPANY_PK by the actual pk you got at step 2.. Feel free to fill in the data with what you want! The JSON must be sent as the body of the request to https://www.dashdoc.eu/api/v4/transports/ .

JSON body
{
    "carrier_address": {
        "company": {
            "pk": "YOUR_COMPANY_PK"
        },
        "address": "Carrier address",
        "postcode": "12345",
        "city": "Carrier city",
        "country": "FR"
    },
    "deliveries": [
        {
            "shipper_address": {
                "address": "Shipper address",
                "postcode": "12345",
                "city": "Shipper city",
                "country": "FR",
                "company": {
                    "name": "Shipper company",
                    "country": "FR"
                }
            },
            "shipper_reference": "Shipper reference",
            "origin": {
                "address": {
                	"address": "Loading address",
	                "postcode": "12345",
	                "city": "Loading city",
	                "country": "FR",
	                "company": {
	                    "name": "Loading company",
	                    "country": "FR"
	                }
                },
                "reference": "Loading reference",
                "loading_instructions": "Loading instructions"
            },
            "destination": {
                "address": {
                	"address" : "Unloading address",
	                "postcode": "12345",
	                "city": "Unloading city",
	                "country": "FR",
	                "company": {
	                    "name": "Unloading company",
	                    "country": "FR"
	                }
                },
                "reference": "Unloading reference",
                "unloading_instructions": "Unloading instructions"
            },
            "planned_loads": [
                {
                    "weight": "12345",
                    "category": "pallets",
                    "quantity": "24",
                    "description": "Load description",
                    "refrigerated": false,
                    "dangerous_goods_category": null
                }
            ]
        }
    ],
    "segments": [
        {
            "origin": {
                "address": {
                	"address": "Loading address",
	                "postcode": "12345",
	                "city": "Loading city",
	                "country": "FR",
	                "company": {
	                    "name": "Loading company",
	                    "country": "FR"
	                }
                },
                "reference": "Loading reference",
                "loading_instructions": "Loading instructions"
            },
            "destination": {
                "address": {
                	"address" : "Unloading address",
	                "postcode": "12345",
	                "city": "Unloading city",
	                "country": "FR",
	                "company": {
	                    "name": "Unloading company",
	                    "country": "FR"
	                }
                },
                "reference": "Unloading reference",
                "unloading_instructions": "Unloading instructions"
            },
            "trailers": [
                {
                    "license_plate": "AB123CD"
                }
            ],
            "vehicle": {
                "license_plate": "EF456GH"
            }
        }
    ]
}

Step 4: Customize your data

Congratulations on creating your first transport !

You might want to send:

  • trucker assignment

  • more details about load or multiple loads

  • dates and times for pick up and delivery

  • set business privacy between origin and destination sites

  • make it a multiple rounds transport

  • even more

Get in touch with your project manager and we'll go through your business needs to help you use API possibilities the best way

Now access the to find all the fields you might need to completely set-up transport creation.

πŸŽ“
Transport - Segment - Delivery
Get the API token
Make an authenticated request
Transport Creation API Reference