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. Wam
  4. Forms

Loads

PreviousCreate TransportNextCompanies

Last updated 1 year ago

Was this helpful?

馃摎

Delete a load of a given waste form

delete
Authorizations
Path parameters
form-uidstringRequired

Unique identifier of the waste form

uidstringRequired

Unique identifier of the waste load

Responses
204
Delete successful
delete
DELETE /api/v4/wam/forms/{form-uid}/loads/{uid}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*
204

Delete successful

No content

Read a load of a given waste form

get
Authorizations
Path parameters
form-uidstringRequired

Unique identifier of the waste form

uidstringRequired

Unique identifier of the waste load

Responses
200
Get successful
application/json
get
GET /api/v4/wam/forms/{form-uid}/loads/{uid}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*
200

Get successful

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "description": "Waste description",
  "weight": 12500,
  "quantity": 10,
  "eural_code": "02 01 01*",
  "physical_properties": "Flammable and reactive waste",
  "chemical_composition": "Radioactive Materials",
  "packaging_type": "Barrels",
  "treatment_type": "Regeneration of acids or bases.",
  "treatment_codes": [
    "R1",
    "D13"
  ]
}
  • GETList all loads of a given waste form
  • POSTCreate a waste load
  • DELETEDelete a load of a given waste form
  • GETRead a load of a given waste form
  • PATCHUpdate a load of a given waste form

List all loads of a given waste form

get
Authorizations
Path parameters
form-uidstringRequired

Unique identifier of the waste form

Query parameters
pageintegerOptional

A page number within the paginated result set.

Responses
200
Get successful
application/json
get
GET /api/v4/wam/forms/{form-uid}/loads/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*
200

Get successful

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "uid": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Waste description",
      "weight": 12500,
      "quantity": 10,
      "eural_code": "02 01 01*",
      "physical_properties": "Flammable and reactive waste",
      "chemical_composition": "Radioactive Materials",
      "packaging_type": "Barrels",
      "treatment_type": "Regeneration of acids or bases.",
      "treatment_codes": [
        "R1",
        "D13"
      ]
    }
  ]
}

Create a waste load

post
Authorizations
Path parameters
form-uidstringRequired

Unique identifier of the waste form

Body
descriptionstringOptional

Description of the waste load

Example: Waste description
weightnumber 路 floatOptional

Weight of the waste in kilograms

Example: 12500
quantitynumber 路 doubleOptional

Quantity of packages. This is required for hazardous waste.

Example: 10
eural_codestringOptional

The Eural code of the waste. If this eural code indicates a hazardous waste, it should be suffixed with a *.

Example: 02 01 01
physical_propertiesstringOptional

Physical properties of the waste load. This is required for hazardous waste.

Example: Flammable and reactive waste
chemical_compositionstringOptional

Chemical composition of the waste load. This is required for hazardous waste.

Example: Radioactive Materials
packaging_typestringOptional

Packaging type of the waste load. This is required for hazardous waste.

Example: Barrels
treatment_typestringOptional

Treatment type of the waste load. This is required for hazardous waste.

Example: Regeneration of acids or bases.
Responses
201
Create successful
application/json
post
POST /api/v4/wam/forms/{form-uid}/loads/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 297

{
  "description": "Waste description",
  "weight": 12500,
  "quantity": 10,
  "eural_code": "02 01 01",
  "physical_properties": "Flammable and reactive waste",
  "chemical_composition": "Radioactive Materials",
  "packaging_type": "Barrels",
  "treatment_type": "Regeneration of acids or bases.",
  "treatment_codes": [
    "R1",
    "D13"
  ]
}
201

Create successful

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "description": "Waste description",
  "weight": 12500,
  "quantity": 10,
  "eural_code": "02 01 01*",
  "physical_properties": "Flammable and reactive waste",
  "chemical_composition": "Radioactive Materials",
  "packaging_type": "Barrels",
  "treatment_type": "Regeneration of acids or bases.",
  "treatment_codes": [
    "R1",
    "D13"
  ]
}

Update a load of a given waste form

patch
Authorizations
Path parameters
form-uidstringRequired

Unique identifier of the waste form

uidstringRequired

Unique identifier of the waste load

Body
descriptionstringOptional

Description of the waste load

Example: Waste description
weightnumber 路 floatOptional

Weight of the waste in kilograms

Example: 12500
quantitynumber 路 doubleOptional

Quantity of packages. This is required for hazardous waste.

Example: 10
eural_codestringOptional

The Eural code of the waste. If this eural code indicates a hazardous waste, it should be suffixed with a *.

Example: 02 01 01
physical_propertiesstringOptional

Physical properties of the waste load. This is required for hazardous waste.

Example: Flammable and reactive waste
chemical_compositionstringOptional

Chemical composition of the waste load. This is required for hazardous waste.

Example: Radioactive Materials
packaging_typestringOptional

Packaging type of the waste load. This is required for hazardous waste.

Example: Barrels
treatment_typestringOptional

Treatment type of the waste load. This is required for hazardous waste.

Example: Regeneration of acids or bases.
Responses
200
Update successful
application/json
patch
PATCH /api/v4/wam/forms/{form-uid}/loads/{uid}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 297

{
  "description": "Waste description",
  "weight": 12500,
  "quantity": 10,
  "eural_code": "02 01 01",
  "physical_properties": "Flammable and reactive waste",
  "chemical_composition": "Radioactive Materials",
  "packaging_type": "Barrels",
  "treatment_type": "Regeneration of acids or bases.",
  "treatment_codes": [
    "R1",
    "D13"
  ]
}
200

Update successful

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "description": "Waste description",
  "weight": 12500,
  "quantity": 10,
  "eural_code": "02 01 01*",
  "physical_properties": "Flammable and reactive waste",
  "chemical_composition": "Radioactive Materials",
  "packaging_type": "Barrels",
  "treatment_type": "Regeneration of acids or bases.",
  "treatment_codes": [
    "R1",
    "D13"
  ]
}