RateQuoteResponse

The rates that apply to the shipment. rates is empty and noRateReason is set where the shipment cannot be priced.

augmentQuoteId
Type: string
required

The augmentQuoteId from the request, echoed back unchanged
currency
Type: string enum
required

Currency for every money field in the response. Cross-border lanes are in scope, so CAD is supported.
values
- USD
- CAD
quotedAt
Type: string Format: date-time
required

When the rate was produced, in UTC
rates
Type: array object[] · Rate[]
required

One entry per rating source. Empty where the shipment cannot be priced.

A list keyed by source rather than a fixed field per rater means adding a source later is additive instead of a breaking change.
One rate from one rating source.

linehaul, fuelSurcharge and allInTotal are all required every time. Augment does not add the parts up and does not subtract them out of the total. When they disagree it flags the rate for a person instead of picking a number to trust.
- allInTotal
  Type: number
  required
  
  Total rate including linehaul, fuel and any accessorials already rolled in.
- fuelSurcharge
  Type: number
  required
  
  Fuel surcharge in dollars, not a percent. Send 0 rather than leaving it out when a rate carries no fuel surcharge.
- linehaul
  Type: number
  required
  
  Linehaul amount, before fuel and accessorials
- source
  Type: string
  required
  
  The system or model that produced the rate.
  
  Not a closed set. New rating sources are added over time and Augment tolerates a value it has not seen, so the examples below are not exhaustive. Values should use UPPER_SNAKE_CASE, and a given source's value should remain stable between responses.
  
  The values are vendor-neutral on purpose: the same field carries a specialized in-house rate, a market rate, or a model added later, without either side reserving vendor-specific names.
- accessorials
  Type: array object[] · RateAccessorial[]
  
  The accessorials that apply to this shipment on this rate, with amounts. Send an empty array when none do.
  
  Augment asks for these per rate instead of keeping its own table, because a table cannot represent a route-dependent charge such as metro tolls, bridge and island fees, or county and city permits, and goes stale silently whenever a charge changes on the provider side.
  
  One priced accessorial. basis is what lets a flat permit charge and a per-mile oversize charge share one shape.
- costPerMile
  Type: number | null
  
  Cost per mile for this rate, where the provider calculates it
- fuelSurchargePct
  Type: number | null
  
  The fuel surcharge as a whole percent, where the provider holds it in that form. Sent alongside fuelSurcharge, never instead of it.
- marginPct
  Type: number | null
  
  Margin as a whole percent: 17, not 0.17.
  
  When a rate carries a margin, Augment seeds its margin selector with it and does not stack a second margin on top; a rep override is still tracked. Send null when the source has no margin of its own, as with a raw market rate.
noRateDetail
Type: string | null

Optional free text expanding on noRateReason, shown to the rep working the quote. Augment does not parse it.
noRateReason
Type: string | null enum

Why there is no rate. Required when rates is empty, and null whenever rates has at least one entry.

An enum rather than free text so Augment can route the quote without parsing a message. MISSING_REQUIRED_INPUT is the only value Augment can act on automatically: the request was well formed but did not carry a value the provider requires, so Augment can obtain it from the customer and retry. Every other value is final for that shipment and routes the quote to a rep.
values
- LANE_NOT_SERVICED
- NO_CAPACITY
- EQUIPMENT_NOT_SUPPORTED
- HAZMAT_NOT_SUPPORTED
- OVERSIZE_OUT_OF_SCOPE
totalMiles
Type: number | null

The mileage the rates were actually priced against. Augment prefers this over the estimate it sent, and extends PER_MILE accessorials with it.