RateQuoteResponse

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

  • The augmentQuoteId from the request, echoed back unchanged

  • Currency for every money field in the response. Cross-border lanes are in scope, so CAD is supported.

  • When the rate was produced, in UTC

  • 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.

    Properties: 8
  • Your id for the quote this request created, such as the TMS quote number. Augment stores it against augmentQuoteId.

  • Optional free text expanding on noRateReason, shown to the rep working the quote. Augment does not parse it.

  • 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_SERVICEDNO_CAPACITYEQUIPMENT_NOT_SUPPORTEDHAZMAT_NOT_SUPPORTEDOVERSIZE_OUT_OF_SCOPECOMMODITY_RESTRICTEDCUSTOMER_NOT_FOUNDMISSING_REQUIRED_INPUTRATE_UNAVAILABLEOTHERnull
  • The mileage the rates were actually priced against. Augment prefers this over the estimate it sent, and extends PER_MILE accessorials with it.