Rate
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.
- allType: number
In Total requiredTotal rate including linehaul, fuel and any accessorials already rolled in.
- fuelType: number
Surcharge requiredFuel surcharge in dollars, not a percent. Send 0 rather than leaving it out when a rate carries no fuel surcharge.
- linehaulType: numberrequired
Linehaul amount, before fuel and accessorials
- sourceType: stringrequired
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.
- accessorialsType:Properties: 4
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.
- costType: number | null
Per Mile Cost per mile for this rate, where the provider calculates it
- fuelType: number | null
Surcharge Pct The fuel surcharge as a whole percent, where the provider holds it in that form. Sent alongside
fuelSurcharge, never instead of it. - marginType: number | null
Pct 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.