Augment Load Management API
API endpoints for creating, updating, and retrieving loads.
OpenAPI Specification
openapi: 3.1.1
info:
title: Augment API Key Load Management API
description: '<a href="https://trust.goaugment.com/?utm_campaign=api_docs&utm_source=api_docs&utm_medium=api_docs&utm_content=api_docs" target="_blank">Augment is now SOC 2 Type II Certified</a>
The Augment API endpoints are calls your system makes to manage loads,
carriers, and webhook configuration.
The latest version of the Augment API is hosted [online](https://apidocs.goaugment.com).
## API Endpoints
Endpoints your system calls to interact with Augment:
- [Load Management](/reference/tag/load-management)
- [Carrier Management](/reference/tag/carrier-management)
- [Models](/reference/models)
- [Webhook Endpoints](/reference/tag/webhook-endpoints)
- [Webhook Event Subscriptions](/reference/tag/webhook-event-subscriptions)
Webhook management access is gated. Request access from Augment before using
these endpoints. After access is enabled, you can self-manage the webhook
endpoints that receive event payloads and the webhook event subscriptions
that control which events are sent to each endpoint.
Use [Webhook Endpoints](/reference/tag/webhook-endpoints) to create and
update the HTTPS destinations where Augment sends webhook payloads. Use
[Webhook Event Subscriptions](/reference/tag/webhook-event-subscriptions) to
choose event types for each endpoint and send test deliveries.
Outbound webhook payloads, including Track & Trace events, are documented
separately in the [Webhooks](/webhooks) reference. Subscriptions created
through the public webhook management APIs deliver version 2 webhook payloads only.
## Resources
* [Homepage](https://www.goaugment.com)
* [LinkedIn](https://www.linkedin.com/company/goaugment)
* [Jobs - we''re hiring!](https://jobs.ashbyhq.com/go-augment?utm_source=AMy24qx30n)
## Developer Notes
All date-time fields are represented as strings. The date-time notation is defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6). Examples:
- `2025-08-21T12:34:56Z`
- `2025-08-21T04:34:56-08:00`
However, when using local time, do not include the trailing `Z` or timezone offset in the date-time string.
Example:
- `2025-08-21T12:34:56`
'
version: 20.0.1
servers:
- url: https://api.prod.goaugment.com
security:
- httpBasic: []
tags:
- name: Load Management
description: 'API endpoints for creating, updating, and retrieving loads.
'
paths:
/v2/loads:
get:
operationId: getLoad
tags:
- Load Management
summary: Get load by load number
description: 'Retrieve enriched load data by load number (brokerage load ID). Returns the full LoadV2 format including carrier details, tracking events, reference numbers, notes, subscribers, and shipment information.
'
parameters:
- name: loadNumber
in: query
required: true
schema:
type: string
description: The load number (brokerage load ID)
example: LOAD-12345
responses:
'200':
description: Load found and returned successfully
content:
application/json:
schema:
$ref: '#/components/schemas/LoadV2Response'
'400':
description: Bad request - loadNumber query parameter is required
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorBody'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorBody'
'404':
description: Load not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorBody'
post:
operationId: createOrUpdateLoad
tags:
- Load Management
summary: Create or update load
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LoadRequest'
example:
brokerage: {}
load:
loadNumber: '1'
mode: FTL
status: DRAFT
isPostedToDAT: false
route:
- sequence: 1
stopActivity: PICKUP
expectedArrivalWindowStart: '2025-09-01T12:00:00Z'
expectedArrivalWindowEnd: '2025-09-01T14:00:00Z'
address:
street1: 1 Santa Monica Blvd
city: Santa Monica
stateOrProvince: CA
postalCode: '90401'
country: US
- sequence: 2
stopActivity: DELIVERY
expectedArrivalWindowStart: '2025-09-02T12:00:00Z'
expectedArrivalWindowEnd: '2025-09-02T14:00:00Z'
address:
street1: 1 Market St
city: San Francisco
stateOrProvince: CA
postalCode: '94105'
country: US
items:
- quantity: 600
packagingUnit:
unitType: CARTON
quantity: 60
handlingUnit:
unitType: PALLET
quantity: 3
description: 600 pieces packed in 60 cartons on 3 pallets
totalWeightLbs: 12000
lengthInches: 48
widthInches: 40
heightInches: 60
freightClass: '70'
nmfc: '123456'
responses:
'204':
description: Load created successfully
'400':
description: Bad request (work in progress)
patch:
operationId: patchLoad
tags:
- Load Management
summary: Patch a load
description: "Apply one or more patch operations to an existing load using a JSON Patch-inspired format ([RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902)).\n\nEach operation targets a specific field by JSON Pointer path and specifies how to change it.\n\n## Supported operations\n\n| `op` | Description |\n|---------|-------------|\n| `add` | Set a value or insert into an array at a specific index. |\n| `remove` | Remove a value or array element. |\n| `replace` | Replace an existing value. |\n| `append` | *(Custom)* Append an item to the end of an array. |\n| `upsert` | *(Custom)* Update an existing array element matching the `where` condition, or insert a new one if no match is found. |\n\n## Allowed paths\n\nOperations are validated against an allowlist of supported paths. Attempts to modify other paths will be rejected.\n\n| `path` | Supported operations | Value example |\n|--------|---------------------|---------------|\n| `/status` | `add`, `replace` | `\"DISPATCHED\"` |\n| `/mode` | `add`, `replace` | `\"FTL\"` |\n| `/loadType` | `add`, `replace` | `\"SPOT\"` |\n| `/equipment` | `add`, `replace` | `\"DRY_VAN\"` |\n| `/equipmentDescription` | `add`, `replace` | `\"53ft Dry Van\"` |\n| `/commodity` | `add`, `replace` | `\"Electronics\"` |\n| `/service` | `add`, `replace` | `\"STANDARD\"` |\n| `/targetRate` | `add`, `replace` | `1250.00` |\n| `/maxRate` | `add`, `replace` | `3000.00` |\n| `/totalRate` | `add`, `replace` | `2750.00` |\n| `/highValueAmount` | `add`, `replace` | `50000` |\n| `/totalMiles` | `add`, `replace` | `1200` |\n| `/tarpSize` | `add`, `replace` | `\"40x48\"` |\n| `/customerName` | `add`, `replace` | `\"Acme Corp\"` |\n| `/customerContact` | `add`, `replace` | `\"Jane Smith\"` |\n| `/customerNotes` | `add`, `replace` | `\"Call before delivery\"` |\n| `/customerId` | `add`, `replace` | `\"ACME-001\"` |\n| `/isPostedToDAT` | `add`, `replace` | `true` |\n| `/bidExpiration` | `add`, `replace` | `\"2025-08-21T12:34:56Z\"` |\n| `/lastLocationUpdate` | `add`, `replace` | `\"2025-10-15T20:20:00Z\"` |\n| `/weight` | `add`, `replace` | `{\"value\": 45000, \"unit\": \"LB\"}` |\n| `/dimensions` | `add`, `replace` | `{\"lengthInches\": 600, \"widthInches\": 96, \"heightInches\": 108}` |\n| `/minimumTemperature` | `add`, `replace` | `{\"value\": 32, \"unit\": \"F\"}` |\n| `/maximumTemperature` | `add`, `replace` | `{\"value\": 68, \"unit\": \"F\"}` |\n| `/minimumBulkHeadTemperature` | `add`, `replace` | `{\"value\": 35, \"unit\": \"F\"}` |\n| `/maximumBulkHeadTemperature` | `add`, `replace` | `{\"value\": 65, \"unit\": \"F\"}` |\n| `/externalTrackingStatus` | `add`, `replace` | `{\"source\": \"MACROPOINT\", \"code\": \"READY\"}` |\n| `/customData` | `add`, `replace` | `{\"key\": \"value\"}` |\n| `/notes` | `add`, `remove`, `append`, `upsert` | `{\"text\": \"Driver is 30 min out\"}` |\n| `/accessorials` | `add`, `remove`, `append`, `upsert` | `\"HAZMAT\"` |\n| `/referenceNumbers` | `add`, `remove`, `append`, `upsert` | `{\"name\": \"PO_NUMBER\", \"value\": \"PO-12345\"}` |\n| `/trackingEvents` | `add`, `remove`, `append`, `upsert` | `{\"eventType\": \"PICKED_UP\", \"eventSource\": \"CARRIER_API\", \"eventUtc\": \"2025-08-21T12:34:56Z\"}` |\n| `/bidCustomValues` | `add`, `remove`, `append`, `upsert` | `{\"name\": \"rush\", \"value\": \"true\"}` |\n| `/commodityItems` | `add`, `remove`, `append`, `upsert` | `{\"quantity\": 10, \"description\": \"boxes\"}` |\n| `/route` | `add`, `remove`, `append`, `upsert` | `{\"sequence\": 1, \"stopActivity\": \"PICKUP\"}` |\n| `/carrier` | `add`, `remove`, `replace` | `add`: assign a carrier when the load has none.<br>`replace`: replace the carrier already on the load.<br>Both use `value` shaped as [**LoadPatchCarrier**](#model/LoadPatchCarrier).<br>`remove`: unassign the carrier (omit `value`). |\n| `/carrier/drivers` | `append`, `replace` | `append`: one [**LoadPatchCarrierDriver**](#model/LoadPatchCarrierDriver).<br>`replace`: array of the same schema (replaces the full drivers list). |\n| `/carrier/contacts` | `append`, `replace` | `append`: one [**LoadPatchCarrierContact**](#model/LoadPatchCarrierContact).<br>`replace`: array of the same schema (replaces the full contacts list). |\n\n## Examples\n\n**Replace a simple field:**\n\n```json\n{ \"op\": \"replace\", \"path\": \"/status\", \"value\": \"IN_TRANSIT\" }\n```\n\n**Append to an array:**\n\n```json\n{ \"op\": \"append\", \"path\": \"/notes\", \"value\": { \"text\": \"Driver is 30 min out\" } }\n```\n\n**Upsert an array element (update stop 1 if it exists, insert if not):**\n\n```json\n{ \"op\": \"upsert\", \"path\": \"/route\", \"value\": { \"sequence\": 1, \"stopActivity\": \"PICKUP\" }, \"where\": { \"sequence\": 1 } }\n```\n\n**Assign carrier on load:**\n\n```json\n{\n \"op\": \"add\",\n \"path\": \"/carrier\",\n \"value\": {\n \"carrierId\": \"tms-carrier-42\",\n \"name\": \"Acme Trucking\",\n \"dotNumber\": 1234567,\n \"drivers\": [{ \"id\": \"drv-1\", \"name\": \"Driver One\", \"phone\": \"+12081234567\" }],\n \"contacts\": [\n { \"role\": \"DISPATCHER\", \"name\": \"Dispatch\", \"email\": \"dispatch@example.com\" },\n { \"role\": \"AP_REP\", \"name\": \"AP\", \"email\": \"ap@example.com\" }\n ]\n }\n}\n```\n\n**Clear carrier from load:**\n\n```json\n{ \"op\": \"remove\", \"path\": \"/carrier\" }\n```\n\n**Append a driver:**\n\n```json\n{\n \"op\": \"append\",\n \"path\": \"/carrier/drivers\",\n \"value\": {\n \"id\": \"drv-2\",\n \"name\": \"Jane Driver\",\n \"phone\": \"+12081234568\",\n \"phoneExtension\": \"101\"\n }\n}\n```\n\n**Replace carrier contacts:**\n\n```json\n{\n \"loadReference\": \"LOAD-12345\",\n \"operations\": [\n {\n \"op\": \"replace\",\n \"path\": \"/carrier/contacts\",\n \"value\": [\n {\n \"id\": \"contact-dispatch-1\",\n \"role\": \"DISPATCHER\",\n \"name\": \"Night dispatch\",\n \"email\": \"dispatch@example.com\",\n \"phone\": \"+12081234569\",\n \"phoneExtension\": \"202\"\n },\n {\n \"id\": \"contact-ap-1\",\n \"role\": \"AP_REP\",\n \"name\": \"Accounts payable\",\n \"email\": \"ap@example.com\",\n \"phone\": \"+12081234570\",\n \"phoneExtension\": \"303\"\n }\n ]\n }\n ]\n}\n```\n"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LoadPatchRequest'
examples:
statusAndNotes:
summary: Status and notes
value:
loadReference: LOAD-12345
operations:
- op: replace
path: /status
value: IN_TRANSIT
- op: append
path: /notes
value:
text: Driver is 30 min out
carrierAssign:
summary: Assign carrier on load
value:
loadReference: LOAD-12345
operations:
- op: add
path: /carrier
value:
carrierId: tms-carrier-42
name: Acme Trucking
dotNumber: 1234567
drivers:
- id: drv-1
name: Driver One
phone: '+12081234567'
contacts:
- role: DISPATCHER
name: Dispatch
email: dispatch@example.com
- role: AP_REP
name: AP
email: ap@example.com
carrierRemove:
summary: Remove carrier from load
value:
loadReference: LOAD-12345
operations:
- op: remove
path: /carrier
responses:
'204':
description: Load patched successfully
'400':
description: Bad request — invalid operation, disallowed path, or missing required field
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorBody'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorBody'
'404':
description: Load not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorBody'
/v2/loads/tracking:
post:
operationId: addTrackingEvent
tags:
- Load Management
summary: Add a tracking event
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TrackingEventRequest'
responses:
'204':
description: Load updated successfully
'400':
description: Bad request (work in progress)
components:
schemas:
LoadReferenceNumberName:
enum:
- BILLED_DATE
- BOOKING_NUMBER
- BOL_NUMBER
- CONSIGNEE_NUMBER
- CONTAINER_NUMBER
- DAT_POSTING_ID
- PICKUP_NUMBER
- PO_NUMBER
- POSTING_GROUP_ID
- PRO_NUMBER
- RELEASED_DATE
- REQUIRED_DOCS
- SHIPPER_NUMBER
- TMS_LOAD_STATUS
- TRAILER_NUMBER
- TRUCK_NUMBER
- OTHER
RouteStop:
type: object
description: A stop in the load route
required:
- sequenceNumber
- activityType
- address
properties:
sequenceNumber:
type: integer
description: The sequence number of the stop in the route (1-indexed)
example: 1
externalId:
type:
- string
- 'null'
description: External ID for the stop (if provided)
activityType:
type: string
enum:
- PICKUP
- DELIVERY
description: Type of activity at this stop
address:
type: object
description: Stop address
properties:
name:
type:
- string
- 'null'
description: Location name
company:
type:
- string
- 'null'
description: Company name
street1:
type:
- string
- 'null'
description: Street address line 1
street2:
type:
- string
- 'null'
description: Street address line 2
city:
type: string
description: City name
stateOrProvince:
type: string
description: State or province code
postalCode:
type:
- string
- 'null'
description: Postal or ZIP code
country:
type: string
description: Country code (2-letter ISO)
timezone:
type:
- string
- 'null'
description: IANA timezone for the stop location
example: America/Los_Angeles
stopNotes:
type:
- string
- 'null'
description: Notes for this stop
facilityCode:
type:
- string
- 'null'
description: Facility code
scheduleTypes:
type: array
items:
type: string
enum:
- APPOINTMENT
- FIRST_COME_FIRST_SERVE
description: Scheduling types for the stop
expectedStopWindowStart:
type:
- string
- 'null'
format: date-time
description: Expected stop window start time
expectedStopWindowEnd:
type:
- string
- 'null'
format: date-time
description: Expected stop window end time
expectedDropWindowStart:
type:
- string
- 'null'
format: date-time
description: Expected drop window start time (for drop trailers)
expectedDropWindowEnd:
type:
- string
- 'null'
format: date-time
description: Expected drop window end time (for drop trailers)
actualArrivalTime:
type:
- string
- 'null'
format: date-time
description: Actual arrival time at the stop
actualDepartureTime:
type:
- string
- 'null'
format: date-time
description: Actual departure time from the stop
mustArriveByDate:
type:
- string
- 'null'
format: date-time
description: The date and time by which the carrier must arrive at this stop
CarrierAddress:
type: object
description: 'Carrier address on a load. Optional on the parent object; when present, include every required field below.
'
required:
- street1
- city
- stateOrProvince
- postalCode
- country
x-property-order:
- company
- locationName
- street1
- street2
- city
- stateOrProvince
- postalCode
- country
properties:
company:
type: string
locationName:
type: string
street1:
type: string
description: Required when address is provided
street2:
type: string
city:
type: string
description: Required when address is provided
stateOrProvince:
type: string
description: Required when address is provided
postalCode:
type: string
description: Required when address is provided
country:
type: string
description: 'Required when address is provided. 2-letter ISO country code: https://www.iban.com/country-codes'
LoadRouteStop:
type: object
required:
- sequence
- stopActivity
- address
- expectedArrivalWindowStart
- expectedArrivalWindowEnd
x-property-order:
- sequence
- externalId
- stopActivity
- address
- notes
- expectedArrivalWindowStart
- expectedArrivalWindowEnd
- actualArrivalTime
- actualCompletionTime
- expectedDropWindowStart
- expectedDropWindowEnd
- mustArriveByDate
- isLocalTime
- schedulingType
- handlingType
properties:
sequence:
type: integer
description: The sequence number of the stop in the route. Number should start at 1 increase by 1 for the following stop.
externalId:
type: string
description: Optional external ID for the stop. This is used to link the stop to an external system.
stopActivity:
enum:
- PICKUP
- DELIVERY
address:
type: object
required:
- street1
- city
- stateOrProvince
- postalCode
- country
x-property-order:
- company
- locationName
- street1
- street2
- city
- stateOrProvince
- postalCode
- country
properties:
company:
type: string
locationName:
type: string
street1:
type: string
street2:
type: string
city:
type: string
stateOrProvince:
type: string
postalCode:
type: string
country:
type: string
description: 'Must be 2-letter ISO country code as listed here: https://www.iban.com/country-codes'
notes:
description: Optional notes for the stop.
type: string
expectedArrivalWindowStart:
allOf:
- $ref: '#/components/schemas/InputDateTimeUtc'
- description: Expected arrival window start time in UTC, or with a specific timezone offset
expectedArrivalWindowEnd:
allOf:
- $ref: '#/components/schemas/InputDateTimeUtc'
- description: Expected arrival window end time in UTC, or with a specified timezone offset
actualArrivalTime:
allOf:
- $ref: '#/components/schemas/InputDateTimeUtc'
- description: Actual arrival time in UTC, or with a specific timezone offset
actualCompletionTime:
allOf:
- $ref: '#/components/schemas/InputDateTimeUtc'
- description: Actual completion time in UTC, or with a specific timezone offset
expectedDropWindowStart:
allOf:
- $ref: '#/components/schemas/InputDateTimeUtc'
- description: Expected window start time for drop trailers in UTC, or with a specific timezone offset
expectedDropWindowEnd:
allOf:
- $ref: '#/components/schemas/InputDateTimeUtc'
- description: Expected window end time for drop trailers in UTC, or with a specific timezone offset
mustArriveByDate:
allOf:
- $ref: '#/components/schemas/InputDateTimeUtc'
- description: The date and time by which the carrier must arrive at this stop, in UTC or with a specific timezone offset
isLocalTime:
type: boolean
description: 'When true, route times are in local time instead of UTC. When this is true, omit the Z suffix or timezone offset from all route time strings. Example: 2017-07-21T17:32:28
'
schedulingType:
enum:
- APPT
- FCFS
description: 'Scheduling type for the stop.
- APPT (Appointment) indicates the stop operates on an appointment basis.
- FCFS (First Come First Serve) indicates the stop accepts arrivals on a first-come-first-serve basis.
'
handlingType:
enum:
- DT
- L
description: 'Handling type for the stop.
- DT (Drop Trailer) indicates the location supports drop-trailer operations.
- L (Live) indicates live loading or unloading where the driver stays with the trailer.
'
Customer:
type: object
required:
- name
x-property-order:
- customerId
- name
properties:
customerId:
type: string
name:
type: string
TrackingEvent:
type: object
required:
- eventType
- eventSource
- eventUtc
x-property-order:
- eventType
- eventSource
- eventUtc
- nextSequence
- nextEtaUtc
- city
- stateOrProvince
- postalCode
- latitude
- longitude
- temperatureF
- notes
- dispatcher
- driver
properties:
nextSequence:
type: integer
nextEtaUtc:
allOf:
- $ref: '#/components/schemas/InputDateTimeUtc'
- description: Next estimated arrival time in UTC, or with a specific timezone offset
eventType:
enum:
- DELAYED
- INFO
- PICKED_UP
- PING
- COVERED
- DISPATCHED
eventSource:
enum:
- 4KITES
- CARRIER_API
- HIGHWAY
- MACROPOINT
- P44
- PHONE_EMAIL
- SMC3
- TEXT
- TMS
- TRUCKER_TOOLS
- OTHER
eventUtc:
allOf:
- $ref: '#/components/schemas/InputDateTimeUtc'
- description: Event time in UTC, or with a specific timezone offset
city:
type: string
stateOrProvince:
type: string
postalCode:
type: string
latitude:
type: number
longitude:
type: number
temperatureF:
type: number
notes:
type: string
dispatcher:
$ref: '#/components/schemas/TrackingEventContact'
driver:
$ref: '#/components/schemas/TrackingEventContact'
LoadItemUnit:
type: object
required:
- unitType
- quantity
x-property-order:
- unitType
- quantity
properties:
unitType:
$ref: '#/components/schemas/PackageType'
quantity:
type: number
description: Quantity of this unit type.
LoadCustomData:
type: object
nullable: true
description: 'Optional client-specific metadata for the load. Use string keys; each value may be a string, number, boolean, array of JSON-safe values, or a nested object with the same rules. The serialized JSON must not exceed 10,000 characters.
If you want Augie to use values from customData in automated workflows, coordinate the expected keys and meanings with Augment. Your SOPs or workflow instructions may need to be updated so Augie knows when and how to reference those values.
On update, sending this field replaces the stored value. Omitting it preserves the existing value, while sending `null` clears it.
'
additionalProperties: true
example:
customerLoadId: ABC-12345
priorityTier: 2
whiteGloveDelivery: true
tags:
- rush
- high-value
routing:
region: NE
requiresAppointment: true
ExternalTrackingStatusCode:
enum:
- READY
- WAITING
- FAILED
- COMPLETED
description: Status code indicating the current state of external tracking
LoadItem:
type: object
required:
- quantity
- totalWeightLbs
x-property-order:
- quantity
- packagingUnit
- handlingUnit
- description
- totalWeightLbs
- lengthInches
- widthInches
- heightInches
- freightClass
- nmfc
- density
- pickupSequence
- deliverySequence
properties:
quantity:
type: integer
description: Item quantity. Required if item is provided.
packagingUnit:
$ref: '#/components/schemas/LoadItemUnit'
description: 'How the item is packaged, such as 60 cartons. Prefer this field when packaging quantity differs from item quantity or handling quantity.
'
handlingUnit:
$ref: '#/components/schemas/LoadItemUnit'
description: 'How the freight is handled or moved, such as 3 pallets. Prefer this field when handling quantity differs from item quantity or packaging quantity.
'
description:
type: string
description: Commodity description for this item. Augment's AI agent uses this value verbatim when speaking with carriers.
totalWeightLbs:
type: number
description: Required if item is provided
lengthInches:
type: integer
widthInches:
type: integer
heightInches:
type: integer
freightClass:
type: string
enum:
- '50'
- '55'
- '60'
- '65'
- '70'
- '77.5'
- '85'
- '92.5'
- '100'
- '110'
- '125'
- '150'
- '175'
- '200'
- '250'
- '300'
- '400'
- '500'
nmfc:
type: string
density:
type: number
pickupSequence:
type: integer
deliverySequence:
type: integer
Load:
type: object
required:
- loadNumber
- status
- mode
- route
x-property-order:
- loadNumber
- brokerageLoadInternalId
- status
- mode
- rateType
- route
- referenceNumbers
- equipment
- accessorials
- items
- externalTrackingStatus
- isPostedToDAT
- weight
- totalMiles
- maxRate
- targetRate
- highValueAmount
- dimensions
- minimumTemperature
- maximumTemperature
- service
- bidExpiration
- notes
- bookedRate
- shipperRate
- tarpSize
- minimumBulkHeadTemperature
- maximumBulkHeadTemperature
- customData
properties:
loadNumber:
type: string
brokerageLoadInternalId:
type: string
description: Optional internal load ID in the TMS. Use loadNumber as the main ID.
mode:
enum:
- DRAYAGE
- FTL
- LTL
rateType:
enum:
- CONTRACT
- DEDICATED
- PROJECT
- SPOT
status:
$ref: '#/components/schemas/LoadStatus'
referenceNumbers:
type: array
items:
type: object
required:
- name
- value
properties:
name:
$ref: '#/components/schemas/LoadReferenceNumberName'
value:
type: string
equipment:
type: object
description: Optional equipment details. If provided, equipmentType is required
required:
- equipmentType
x-property-order:
- equipmentType
- description
properties:
equipmentType:
description: Required if equipment object is provided
enum:
- AUTO_CARRIER
- AUTO_TRANSPORT
- B_TRAIN
- BOX_TRUCK
- CHASSIS
- CONESTOGA
- CONTAINER
- CONTAINER_INSULATED
- CONTAINER_OR_CHASSIS
- CONTAINER_REFRIGERATED
- CONTAINERS
- CONVEYOR
- DECKS_SPECIALIZED
- DECKS_STANDARD
- DOUBLE_DROP
- DROP_DECK_LANDOLL
- DRY_BULK
- DRY_VAN
- DUMP_END
- DUMP_SIDE
- DUMP_TRAILER
- FLATBED
- FLATBED_AIR_RIDE
- FLATBED_CONESTOGA
-
# --- truncated at 32 KB (68 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/augment/refs/heads/main/openapi/augment-load-management-api-openapi.yml