Skip to content
Scale Tickets/
Create a scale ticket

Scale API (1.0.0)

The Scale API manages scale tickets with inbound and outbound flow data for the Hauler Hero platform.

Integration Prerequisites

Important: If you want to integrate your scale tickets into the Hauler Hero platform, you must call this API endpoint with the required data specified in this specification.

Partners need to:

  1. Obtain API credentials (HERO-API-KEY) from Hauler Hero. Important: Each Hauler Hero account has a unique API key.
  2. Call the POST /hero-api/v1/tickets endpoint whenever a scale ticket is created or updated in your system
  3. Send the required data including site, materials, and flow information as specified in the request schema
  4. Receive confirmation that the ticket was successfully integrated into Hauler Hero

What Data to Send

When calling this API, you must include:

  • Site identification - UUID for the site
  • Material quantities - List of materials with IDs, names, quantities, pricing, and units
  • Inbound/Outbound flow data - Ticket numbers, effective dates

Authentication

All endpoints require API key authentication using the HERO-API-KEY header.

Download OpenAPI description
scale.json
scale.yaml
Languages
Servers
Mock server
https://docs.haulerhero.com/_mock/scale/
Hauler Hero production server
https://api.haulerhero.com/

Scale Tickets

Scale ticket and weighing operations

Operations

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(MaterialItem)non-emptyrequired

List of materials with quantities

materials[].​idstring(uuid)required

Unique identifier for the material

Example: "a51b814b-1b23-4f28-8c2a-b90030340eea"
materials[].​namestringrequired

Material name

Example: "Paper"
materials[].​quantitynumberrequired

Quantity of the material

Example: 100
materials[].​unitPriceCentsnumber(double)

Unit price in cents (e.g., 15.50 for $0.155)

Example: 15.5
materials[].​unitOfMeasurestringrequired

Unit of measurement for the material

Enum"Ton""Gallon""Pound""Kilogram""Cubic Yard""Cubic Meter""Item"
Example: "Ton"
inboundFlowobject(FlowData)
outboundFlowobject(FlowData)
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"
    }
  }'

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
application/json
{
  "success": true,
  "disposalTicketId": "123e4567-e89b-12d3-a456-426614174000"
}