RateQuoteResponse
The rates that apply to the shipment. rates is empty and noRateReason is set where the shipment cannot be priced.
- augmentType: string
Quote Id requiredThe
augmentQuoteIdfrom the request, echoed back unchanged - currencyType: "USD" or "CAD"enumrequired
Currency for every money field in the response. Cross-border lanes are in scope, so CAD is supported.
- quotedType: stringFormat: date-time
At requiredWhen the rate was produced, in UTC
- ratesType:requiredProperties: 8
One entry per rating source. Empty where the shipment cannot be priced.
A list keyed by
sourcerather than a fixed field per rater means adding a source later is additive instead of a breaking change. - externalType: string | null
Id Your id for the quote this request created, such as the TMS quote number. Augment stores it against
augmentQuoteId. - noType: string | null
Rate Detail Optional free text expanding on
noRateReason, shown to the rep working the quote. Augment does not parse it. - noType: string | nullenum
Rate Reason Why there is no rate. Required when
ratesis empty, and null wheneverrateshas at least one entry.An enum rather than free text so Augment can route the quote without parsing a message.
MISSING_REQUIRED_INPUTis 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.valuesLANE_NOT_SERVICEDNO_CAPACITYEQUIPMENT_NOT_SUPPORTEDHAZMAT_NOT_SUPPORTEDOVERSIZE_OUT_OF_SCOPECOMMODITY_RESTRICTEDCUSTOMER_NOT_FOUNDMISSING_REQUIRED_INPUTRATE_UNAVAILABLEOTHERnull - totalType: number | null
Miles The mileage the rates were actually priced against. Augment prefers this over the estimate it sent, and extends
PER_MILEaccessorials with it.