Create a scale ticket

Request

Creates a new scale ticket with weight measurements, materials, and vehicle information

Security

apiKey

Bodyapplication/jsonrequired

siteIdstring, (uuid)required

Unique identifier for the disposal site

Example:"64318450-1ce2-499d-8a70-f313aabe1831"

materialsArray of objects, non-empty(MaterialItem)required

List of materials with quantities

inboundFlowobject(FlowData)

outboundFlowobject(FlowData)

customFieldsobject

Optional map of custom key-value pairs for additional integration-specific data not covered by standard fields

Example:

{
  "driverName": "John",
  "routeName": "Route 1",
  "vehicleId": "TRK-042",
  "customerReference": "PO-98765"
}

curl -i -X POST \
  https://docs.haulerhero.com/_mock/scale/hero-api/v1/tickets \
  -H 'Content-Type: application/json' \
  -H 'HERO-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "siteId": "64318450-1ce2-499d-8a70-f313aabe1831",
    "materials": [
      {
        "id": "a51b814b-1b23-4f28-8c2a-b90030340eea",
        "name": "Paper",
        "quantity": 100,
        "unitPriceCents": 15.5,
        "unitOfMeasure": "Ton"
      }
    ],
    "inboundFlow": {
      "ticketNumber": "INB-20240701-001",
      "updatedAt": "2024-07-01T12:00:00Z"
    },
    "outboundFlow": {
      "ticketNumber": "OUT-20250701-001",
      "updatedAt": "2025-07-01T12:00:00Z"
    },
    "customFields": {
      "driverName": "John",
      "routeName": "Route 1"
    }
  }'

Responses

Scale ticket created successfully

Bodyapplication/json

successbooleanrequired

Whether the request was successful

Example:true

disposalTicketIdstring, (uuid)required

Unique identifier for the created disposal ticket

Example:"123e4567-e89b-12d3-a456-426614174000"

Response

{
  "success": true,
  "disposalTicketId": "123e4567-e89b-12d3-a456-426614174000"
}