Skip to main content
PUT
Update Quote Preferences

Authorizations

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

Body

application/json
destination_saved_facilities
object[]

Saved facilities favorited as quote destinations; counterpart of origin_saved_facilities.

favorite_commodity_sets
object[]
favorite_destination_cif_sets
object[]

CIF customer sets favorited as quote destinations; counterpart of favorite_origin_cif_sets.

favorite_destination_geography_sets
object[]

Geography sets favorited specifically as quote destinations.

favorite_equipment_profile_sets
object[]
favorite_geography_sets
object[]

Legacy direction-agnostic geography sets. Retained for backward compatibility: these remain usable for BOTH origin and destination search until the carrier re-saves quote preferences, after which favorites are stored separately as origin and destination sets and this list is emptied. New clients should read these in addition to the origin/destination lists, and write only the origin/destination lists.

favorite_origin_cif_sets
object[]

CIF customer sets favorited as quote origins. Values are 9-digit CIFs, optionally followed by a 4-digit sub-location suffix (13 digits total).

favorite_origin_geography_sets
object[]

Geography sets favorited specifically as quote origins.

origin_saved_facilities
object[]

Saved facilities favorited as quote origins; narrow the commodity and equipment choices when the selected origin is one of them.

quotes_hide_duplicate_junctions
boolean

When true, quote route search (ListQuotes) and the quote route typeahead (ListRoutes) hide routes that reuse an interchange junction — the same gateway appearing on more than one leg (e.g. UP-NEWOR-CSXT-NEWOR-NS, which doubles back through NEWOR). Stored on the carrier row; defaults to true. Explicit presence: on UpdateQuotePreferences the carrier row is written only when this field is set, so a client that omits it (e.g. a favorites-only save) never flips the stored value. This is the canonical home for the toggle; the deprecated ShipperSettings.quotes_hide_duplicate_junctions reads/writes the same carrier column. See DEV-7011.

Response

A successful response.

destination_saved_facilities
object[]

Saved facilities favorited as quote destinations; counterpart of origin_saved_facilities.

favorite_commodity_sets
object[]
favorite_destination_cif_sets
object[]

CIF customer sets favorited as quote destinations; counterpart of favorite_origin_cif_sets.

favorite_destination_geography_sets
object[]

Geography sets favorited specifically as quote destinations.

favorite_equipment_profile_sets
object[]
favorite_geography_sets
object[]

Legacy direction-agnostic geography sets. Retained for backward compatibility: these remain usable for BOTH origin and destination search until the carrier re-saves quote preferences, after which favorites are stored separately as origin and destination sets and this list is emptied. New clients should read these in addition to the origin/destination lists, and write only the origin/destination lists.

favorite_origin_cif_sets
object[]

CIF customer sets favorited as quote origins. Values are 9-digit CIFs, optionally followed by a 4-digit sub-location suffix (13 digits total).

favorite_origin_geography_sets
object[]

Geography sets favorited specifically as quote origins.

origin_saved_facilities
object[]

Saved facilities favorited as quote origins; narrow the commodity and equipment choices when the selected origin is one of them.

quotes_hide_duplicate_junctions
boolean

When true, quote route search (ListQuotes) and the quote route typeahead (ListRoutes) hide routes that reuse an interchange junction — the same gateway appearing on more than one leg (e.g. UP-NEWOR-CSXT-NEWOR-NS, which doubles back through NEWOR). Stored on the carrier row; defaults to true. Explicit presence: on UpdateQuotePreferences the carrier row is written only when this field is set, so a client that omits it (e.g. a favorites-only save) never flips the stored value. This is the canonical home for the toggle; the deprecated ShipperSettings.quotes_hide_duplicate_junctions reads/writes the same carrier column. See DEV-7011.