Skip to main content
GET
Get Shipper Quote

Authorizations

x-arms-api-key
string
header
required
x-arms-assume-user
string
header
required

Path Parameters

name
string
required

Stable quote resource name as returned in Quote.name, e.g. "quotes/".

Pattern: [^/]+

Response

A successful response.

created_at
string<date-time>

When this quote was first generated. Populated by GetQuote (from the persisted reconstruction mapping) so callers can tell when an id was minted; unset on live ListQuotes responses.

distance
object
furtherance_beyond_destination
boolean

Rule 11 segment pricing counterpart (ListQuotesRequest.destination_unknown): continuation beyond the last leg's destination gateway junction is unknown and NOT included in the quoted total. Omitted otherwise.

legs
object[]

Quote legs, each with its own route, distance, and itemized charges.

name
string

Stable quote identifier.

number_of_cars
integer<int32>

Number of cars used to scale per-car and aggregate quote amounts.

prior_movement_before_origin
boolean

Rule 11 segment pricing (ListQuotesRequest.origin_unknown): the movement's true origin is unknown — it enters the priced portion at the first leg's origin gateway junction, and the prior movement is NOT included in the quoted total. Omitted otherwise.

route
object
total
object