Request a rate quote
This endpoint is implemented by the rate provider and called by Augment. Every other endpoint in this reference operates in the opposite direction, so the distinction warrants emphasis: Augment acts as the HTTP client, and cannot retrieve quotes until the endpoint is available on the provider side. The path and base URL shown above are placeholders for the values the provider assigns.
Each request describes a single shipment and expects the rates that apply to it. mode, rateType, two stops carrying a city and a state, and equipment.equipmentType are always present. The remaining fields are included when Augment holds a value and omitted when it does not, so an omitted optional field should be read as unknown rather than as a default. An omitted isHazmat, for example, does not indicate that the freight is non-hazardous.
dimensions is optional, but Augment includes it whenever a value is available, so that the rate provider rather than Augment determines whether a shipment is legal or oversize. Where oversize freight falls outside the scope of an initial build, dimensions may be disregarded and the field reserved for later use.
Where a shipment cannot be priced, the response must be 200 with an empty rates array and a populated noRateReason. This condition must not be reported with an error status: an error prevents Augment from distinguishing between "no rate exists" and "the endpoint is unavailable", and the two require opposite handling. 4xx and 5xx responses are reserved for malformed requests, authentication failures, and genuine faults.
One shipment to be priced. mode, rateType, stops, equipment and augmentQuoteId are always sent. The rest is sent when Augment has it, so treat a missing field as unknown rather than as a default.
- Type: stringaugment
Quote Id requiredAugment's id for this quote. Echo it back unchanged. Treat it as an opaque string.
- Type: objectequipmentrequired
Equipment needed to move the shipment
- enummoderequired
Transportation mode. Same values as
Load.mode.values- D
R A Y A G E - E
X P E D I T E - F
T L - L
T L - P
A R T I A L
- enumrate
Type requiredThe commercial basis of the rate being asked for. Same values as
Load.rateType.values- C
O N T R A C T - D
E D I C A T E D - P
R O J E C T - S
P O T
- Type: array object[] · 2…stopsrequired
The route in sequence. One
PICKUPand oneDELIVERYis the floor and is enough to return a rate.This is an array rather than an origin and destination pair so a third or later stop is visible in the request. You cannot charge a stop-off fee against a lane that doesn't show the stop.
One stop on the route. A rate request describes a geographic point rather than a facility, so no street address is sent.
- Type: array string[] | null ·accessorials
Accessorial codes Augment already knows the shipment needs, such as
TARPSorTWIC. Advisory only. You return the priced accessorials on each rate and are not limited to what's listed here. - Type: string | nullcommodity
Free-text description of the freight
- Type: string | nullcustomer
Name The shipper the quote is for, when a customer rate applies
- Type: object | nulldimensions
Overall shipment dimensions in whole inches. Legal width runs to roughly 12 feet; wider than that generally needs escorts.
- Type: string | nullhazmat
Un Number UN number for the hazardous material,
UNfollowed by four digits. Sent only whenisHazmatis true and the source document carried the number. - Type: boolean | nullis
Hazmat Whether the shipment carries hazardous materials. Missing means unknown, not false.
- Type: string | null Format: datepickup
Date Requested pickup day
- application/json
- application/json
- application/json
- application/json
- application/json
curl https://rates.example.com/v1/rates/quote \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic username:password' \
--data '{
"mode": "FTL",
"rateType": "SPOT",
"stops": [
{
"sequence": 1,
"stopActivity": "PICKUP",
"address": {
"city": "Houston",
"stateOrProvince": "TX",
"postalCode": "77002",
"country": "US"
}
},
{
"sequence": 2,
"stopActivity": "DELIVERY",
"address": {
"city": "Avon",
"stateOrProvince": "IN",
"postalCode": null,
"country": "US"
}
}
],
"equipment": {
"equipmentType": "FLATBED"
},
"weight": {
"value": 44000,
"unit": "LB"
},
"dimensions": {
"lengthInches": 636,
"widthInches": 126,
"heightInches": 102
},
"commodity": "Steel coil",
"pickupDate": "2026-09-03",
"totalMiles": 1015,
"tarpSize": "8 foot",
"isHazmat": false,
"hazmatUnNumber": null,
"accessorials": [
"TARPS"
],
"customerName": "PALRAM Americas",
"augmentQuoteId": "01kzry3mzq8f4h2n7v9x1c3b5d"
}'
{
"augmentQuoteId": "01kzry3mzq8f4h2n7v9x1c3b5d",
"quotedAt": "2026-08-27T14:22:10Z",
"currency": "USD",
"totalMiles": 1015,
"rates": [
{
"source": "ATS_SPECIALIZED",
"linehaul": 4800,
"fuelSurcharge": 1000,
"fuelSurchargePct": 20.8,
"allInTotal": 5800,
"costPerMile": 4.73,
"marginPct": 17,
"accessorials": [
{
"code": "PERMITS",
"label": "Permit charges",
"amount": 4.18,
"basis": "FLAT"
},
{
"code": "OVERSIZE",
"label": "OD over 10 feet",
"amount": 0.45,
"basis": "PER_MILE"
},
{
"code": "STOP_OFF_CHARGE",
"label": "Stop-off fee",
"amount": 150,
"basis": "PER_STOP"
}
]
},
{
"source": "DAT",
"linehaul": 4550,
"fuelSurcharge": 980,
"fuelSurchargePct": null,
"allInTotal": 5530,
"costPerMile": 4.48,
"marginPct": null,
"accessorials": []
}
],
"noRateReason": null,
"noRateDetail": null
}