Update Quote Preferences - Cedar.AI Documentation

PUT

shipper

quote-preferences

Update Quote Preferences

curl --request PUT \
  --url https://api-lg-k.arms.cedarai.com/shipper/quote-preferences \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "destination_saved_facilities": [
    {
      "cif": "<string>",
      "city_state": {
        "city": "<string>",
        "state_or_province": "<string>"
      },
      "equipment_profile_names": [
        "<string>"
      ],
      "name": "<string>",
      "stccs": [
        "<string>"
      ]
    }
  ],
  "favorite_commodity_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "favorite_destination_cif_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "favorite_destination_geography_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "favorite_equipment_profile_sets": [
    {
      "name": "<string>",
      "profiles": [
        {
          "measurements": [
            {
              "range": {
                "from": 123,
                "to": 123
              }
            }
          ],
          "name": "<string>"
        }
      ]
    }
  ],
  "favorite_geography_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "favorite_origin_cif_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "favorite_origin_geography_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "origin_saved_facilities": [
    {
      "cif": "<string>",
      "city_state": {
        "city": "<string>",
        "state_or_province": "<string>"
      },
      "equipment_profile_names": [
        "<string>"
      ],
      "name": "<string>",
      "stccs": [
        "<string>"
      ]
    }
  ]
}
'

{
  "destination_saved_facilities": [
    {
      "cif": "<string>",
      "city_state": {
        "city": "<string>",
        "state_or_province": "<string>"
      },
      "equipment_profile_names": [
        "<string>"
      ],
      "name": "<string>",
      "stccs": [
        "<string>"
      ]
    }
  ],
  "favorite_commodity_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "favorite_destination_cif_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "favorite_destination_geography_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "favorite_equipment_profile_sets": [
    {
      "name": "<string>",
      "profiles": [
        {
          "measurements": [
            {
              "range": {
                "from": 123,
                "to": 123
              }
            }
          ],
          "name": "<string>"
        }
      ]
    }
  ],
  "favorite_geography_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "favorite_origin_cif_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "favorite_origin_geography_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "origin_saved_facilities": [
    {
      "cif": "<string>",
      "city_state": {
        "city": "<string>",
        "state_or_province": "<string>"
      },
      "equipment_profile_names": [
        "<string>"
      ],
      "name": "<string>",
      "stccs": [
        "<string>"
      ]
    }
  ]
}

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.

Show child attributes

favorite_commodity_sets

object[]

Show child attributes

favorite_destination_cif_sets

object[]

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

Show child attributes

favorite_destination_geography_sets

object[]

Geography sets favorited specifically as quote destinations.

Show child attributes

favorite_equipment_profile_sets

object[]

Show child attributes

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.

Show child attributes

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

Show child attributes

favorite_origin_geography_sets

object[]

Geography sets favorited specifically as quote origins.

Show child attributes

origin_saved_facilities

object[]

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

Show child attributes

Response

A successful response.

destination_saved_facilities

object[]

Saved facilities favorited as quote destinations; counterpart of origin_saved_facilities.

Show child attributes

favorite_commodity_sets

object[]

Show child attributes

favorite_destination_cif_sets

object[]

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

Show child attributes

favorite_destination_geography_sets

object[]

Geography sets favorited specifically as quote destinations.

Show child attributes

favorite_equipment_profile_sets

object[]

Show child attributes

favorite_geography_sets

object[]

Show child attributes

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

Show child attributes

favorite_origin_geography_sets

object[]

Geography sets favorited specifically as quote origins.

Show child attributes

origin_saved_facilities

object[]

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

Show child attributes

⌘I

Update Quote Preferences

curl --request PUT \
  --url https://api-lg-k.arms.cedarai.com/shipper/quote-preferences \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "destination_saved_facilities": [
    {
      "cif": "<string>",
      "city_state": {
        "city": "<string>",
        "state_or_province": "<string>"
      },
      "equipment_profile_names": [
        "<string>"
      ],
      "name": "<string>",
      "stccs": [
        "<string>"
      ]
    }
  ],
  "favorite_commodity_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "favorite_destination_cif_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "favorite_destination_geography_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "favorite_equipment_profile_sets": [
    {
      "name": "<string>",
      "profiles": [
        {
          "measurements": [
            {
              "range": {
                "from": 123,
                "to": 123
              }
            }
          ],
          "name": "<string>"
        }
      ]
    }
  ],
  "favorite_geography_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "favorite_origin_cif_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "favorite_origin_geography_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "origin_saved_facilities": [
    {
      "cif": "<string>",
      "city_state": {
        "city": "<string>",
        "state_or_province": "<string>"
      },
      "equipment_profile_names": [
        "<string>"
      ],
      "name": "<string>",
      "stccs": [
        "<string>"
      ]
    }
  ]
}
'

{
  "destination_saved_facilities": [
    {
      "cif": "<string>",
      "city_state": {
        "city": "<string>",
        "state_or_province": "<string>"
      },
      "equipment_profile_names": [
        "<string>"
      ],
      "name": "<string>",
      "stccs": [
        "<string>"
      ]
    }
  ],
  "favorite_commodity_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "favorite_destination_cif_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "favorite_destination_geography_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "favorite_equipment_profile_sets": [
    {
      "name": "<string>",
      "profiles": [
        {
          "measurements": [
            {
              "range": {
                "from": 123,
                "to": 123
              }
            }
          ],
          "name": "<string>"
        }
      ]
    }
  ],
  "favorite_geography_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "favorite_origin_cif_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "favorite_origin_geography_sets": [
    {
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "origin_saved_facilities": [
    {
      "cif": "<string>",
      "city_state": {
        "city": "<string>",
        "state_or_province": "<string>"
      },
      "equipment_profile_names": [
        "<string>"
      ],
      "name": "<string>",
      "stccs": [
        "<string>"
      ]
    }
  ]
}