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
  3. Transports

Charter

PreviousTransportsNextAssign

Last updated 1 year ago

Was this helpful?

๐Ÿ“š

Charter transport

post

Shortcut API to create a chartered transport. Current transport, called "parent transport" will be chartered to a "child transport".

Child transport is created as follow:

  • Shipper is the actual carrier of the parent transport

  • Carrier is the chartered carrier given in the carrier parameter

  • Trucker and plates are not set, but information about it can be given in the instructions parameters

  • Other transport data (deliveries, segments, etc.) are duplicated

  • Child transport starts at the first segment's origin and ends at the last segment's destination

Authorizations
Body
instructionsstring ยท max: 1000Optional

Operating instructions. The carrier, the shipper and the creator of the transport have access to those instructions. However, the creator is the only who has the right to edit.

pricenumber ยท float | nullableOptionalDeprecated

Full price for the transport

Example: 250
Responses
201
Transport chartered successfully
application/json
post
POST /api/v4/transports/{uid}/charter/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "carrier": {
    "pk": 23498,
    "remote_id": "text",
    "carrier_contacts": "['abce-df123-acd4', 'dcbe-df153-dcd7']"
  },
  "instructions": "text"
}
201

Transport chartered successfully

{
  "child_transport": "3545c058-392d-11eb-90c5-0242ac140006"
}