# Scale API

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.


Version: 1.0.0

## Servers

Hauler Hero production server
```
https://api.haulerhero.com
```

## Security

### apiKey

API key for authenticating requests.

To obtain an API key:
- Contact your account manager
- Email: api-support@haulerhero.com

Include in request header: `HERO-API-KEY: your_api_key_here`


Type: apiKey
In: header
Name: HERO-API-KEY

## Download OpenAPI description

[Scale API](https://docs.haulerhero.com/_bundle/scale.yaml)

## Scale Tickets

Scale ticket and weighing operations

### Create a scale ticket

 - [POST /hero-api/v1/tickets](https://docs.haulerhero.com/scale/scale-tickets/addscaleticket.md): Creates a new scale ticket with weight measurements, materials, and vehicle information