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

List of all endpoints for v4

PreviousUpgrading API from v3 to v4NextAddresses

Last updated 4 months ago

Was this helpful?

You may find a list of all endpoints usable in your integration:

πŸ“š
Addresses
GET /addresses/
POST /addresses/
DELETE /addresses/{pk}/
GET /addresses/{pk}/
PATCH /addresses/{pk}/
Security Protocol
GET /addresses/{pk}/security-protocol/
Adr Un Codes
GET /adr-un-codes/
GET /adr-un-codes/{pk}/
Carbon Footprint
Transport Operation Categories
GET /carbon-footprint/transport-operation-categories/
Companies
GET /companies/
POST /companies/
GET /companies/{pk}/
PATCH /companies/{pk}/
Contacts
GET /contacts/
POST /contacts/
DELETE /contacts/{uid}/
GET /contacts/{uid}/
PATCH /contacts/{uid}/
Invite
POST /contacts/{uid}/invite/
Deliveries
GET /deliveries/
GET /deliveries/{uid}/
PATCH /deliveries/{uid}/
Add Round
POST /deliveries/{uid}/add-round/
Cmrs
GET /deliveries/{uid}/cmrs/
Dock Activities
GET /dock-activities/
Mark Loaded By Dock
POST /dock-activities/{uid}/mark-loaded-by-dock/
Mark Unloaded By Dock
POST /dock-activities/{uid}/mark-unloaded-by-dock/
Invoices
GET /invoices/
GET /invoices/{uid}/
PATCH /invoices/{uid}/
Items
GET /invoices/items/
POST /invoices/items/
DELETE /invoices/items/{uid}/
PATCH /invoices/items/{uid}/
Mark Paid
POST /invoices/{uid}/mark-paid/
Mark Not Paid
POST /invoices/{uid}/mark-not-paid/
Managers
DELETE /managers/{pk}/
GET /managers/{pk}/
PATCH /managers/{pk}/
Invite
POST /managers/invite/
Me
GET /managers/me/
PATCH /managers/me/
Set Company
POST /managers/set-company/
Manager Truckers
GET /manager-truckers/
POST /manager-truckers/
DELETE /manager-truckers/{pk}/
GET /manager-truckers/{pk}/
PATCH /manager-truckers/{pk}/
Lease
POST /manager-truckers/{pk}/lease/
Generate Invite Code
POST /manager-truckers/{pk}/generate-invite-code/
Unavailability
POST /manager-truckers/{pk}/unavailability/
DELETE /manager-truckers/{pk}/unavailability/{pk_unavailability}/
PATCH /manager-truckers/{pk}/unavailability/{pk_unavailability}/
Security Protocols
POST /security-protocols/
PATCH /security-protocols/{pk}/
Segments
PATCH /segments/{uid}/
Assign
POST /segments/{uid}/assign/
Break
POST /segments/{uid}/break/
Charter
POST /segments/charter/
Tracking Files
GET /tracking-files/
POST /tracking-files/
DELETE /tracking-files/{uid}/
GET /tracking-files/{uid}/
PATCH /tracking-files/{uid}/
Sites
GET /sites/{uid}
PATCH /sites/{uid}
Mark Done
POST /sites/{uid}/mark-done
Enable Eta
POST /sites/{uid}/enable-eta/
Support Types
GET /support-types/
POST /support-types/
DELETE /support-types/{uid}/
GET /support-types/{uid}/
Supports Exchanges
POST /supports-exchanges/
GET /supports-exchanges/{uid}/
PATCH /supports-exchanges/{uid}/
Telematics
Vehicles
POST /telematics/vehicles/
Traces
POST /telematics/traces/{vendor}/
Trailers
GET /trailers/
POST /trailers/
DELETE /trailers/{pk}/
GET /trailers/{pk}/
PATCH /trailers/{pk}/
Unavailability
POST /trailers/{pk}/unavailability/
DELETE /trailers/{pk}/unavailability/{pk_unavailability}/
PATCH /trailers/{pk}/unavailability/{pk_unavailability}/
Track Dechets
GET /track-dechets/
POST /track-dechets/
DELETE /track-dechets/{uid}/
GET /track-dechets/{uid}/
Transport Loading Plans
GET /transport-loading-plans/
Transport Messages
POST /transport-messages/
DELETE /transport-messages/{uid}/
GET /transport-messages/{uid}/
PATCH /transport-messages/{uid}/
Transports
GET /transports/
POST /transports/
DELETE /transports/{uid}/
GET /transports/{uid}/
PATCH /transports/{uid}/
Charter
POST /transports/{uid}/charter/
Assign
POST /transports/assign/
Archive
POST /transports/archive/
Merge To Trip
POST /transports/merge-to-trip/
Mark Done
POST /transports/mark-done/
Mark Invoiced
POST /transports/mark-invoiced/
POST /transports/{uid}/mark-invoiced/
Mark Paid
POST /transports/mark-paid/
Cancel
POST /transports/{uid}/cancel/
Confirm
POST /transports/{uid}/confirm/
Decline
POST /transports/{uid}/decline/
Revenue Split
GET /transports/{uid}/revenue-split/
Cmrs
GET /transports/{uid}/cmrs/
Effective Price Lines
GET /transports/{uid}/effective-price-lines/
Loads Constraints
POST /transports/{uid}/loads-constraints/
Transport Status
POST /transport-status/
Transport Templates
GET /transport-templates/
Scheduler
Trips
Set Name
POST /scheduler/trips/{uid}/set-name/
Vehicles
GET /vehicles/
POST /vehicles/
DELETE /vehicles/{pk}/
GET /vehicles/{pk}/
PATCH /vehicles/{pk}/
Unavailability
POST /vehicles/{pk}/unavailability/
DELETE /vehicles/{pk}/unavailability/{pk_unavailability}/
PATCH /vehicles/{pk}/unavailability/{pk_unavailability}/
Wam
Contacts
GET /wam/contacts/
POST /wam/contacts/
DELETE /wam/contacts/{uid}
GET /wam/contacts/{uid}
PATCH /wam/contacts/{uid}
Forms
GET /wam/forms/
POST /wam/forms/
DELETE /wam/forms/{uid}/
GET /wam/forms/{uid}/
PATCH /wam/forms/{uid}/
Sign As Organizer
POST /wam/forms/{uid}/sign-as-organizer/
Create Transport
POST /wam/forms/{uid}/create-transport/
Loads
GET /wam/forms/{form-uid}/loads/
POST /wam/forms/{form-uid}/loads/
DELETE /wam/forms/{form-uid}/loads/{uid}/
GET /wam/forms/{form-uid}/loads/{uid}/
PATCH /wam/forms/{form-uid}/loads/{uid}/
Companies
Details
DELETE /wam/companies/{company-id}/details/
GET /wam/companies/{company-id}/details/
POST /wam/companies/{company-id}/details/
437KB
openapi.json