Get Quote Preferences - Cedar.AI Documentation

GET

shipper

quote-preferences

Get Quote Preferences

curl --request GET \
  --url https://api-lg-k.arms.cedarai.com/shipper/quote-preferences \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>'

import requests

url = "https://api-lg-k.arms.cedarai.com/shipper/quote-preferences"

headers = {
    "x-arms-api-key": "<api-key>",
    "x-arms-assume-user": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-arms-api-key': '<api-key>', 'x-arms-assume-user': '<api-key>'}
};

fetch('https://api-lg-k.arms.cedarai.com/shipper/quote-preferences', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-lg-k.arms.cedarai.com/shipper/quote-preferences",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-arms-api-key: <api-key>",
    "x-arms-assume-user: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-lg-k.arms.cedarai.com/shipper/quote-preferences"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-arms-api-key", "<api-key>")
	req.Header.Add("x-arms-assume-user", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-lg-k.arms.cedarai.com/shipper/quote-preferences")
  .header("x-arms-api-key", "<api-key>")
  .header("x-arms-assume-user", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-lg-k.arms.cedarai.com/shipper/quote-preferences")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-arms-api-key"] = '<api-key>'
request["x-arms-assume-user"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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": [
        {
          "car_type": "ALL_CAR_TYPES",
          "excluded_car_types": [
            "ALL_CAR_TYPES"
          ],
          "excluded_marks": [
            "<string>"
          ],
          "included_marks": [
            "<string>"
          ],
          "measurements": [
            {
              "dimension": "OUTSIDE_LENGTH_INCHES",
              "range": {
                "from": 123,
                "to": 123
              }
            }
          ],
          "name": "<string>",
          "plate_codes": [
            "<string>"
          ],
          "special_car_type": "FLAT"
        }
      ]
    }
  ],
  "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>"
      ]
    }
  ],
  "quotes_hide_duplicate_junctions": true
}

{
  "code": 123,
  "details": [
    {
      "@type": "<string>"
    }
  ],
  "message": "<string>"
}

Authorizations

x-arms-api-key

string

header

required

x-arms-assume-user

string

header

required

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[]

Legacy direction-agnostic geography sets. Retained for backward compatibility: these remain usable for BOTH origin and destination search until quote preferences are re-saved, 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

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 (for example UP-NEWOR-CSXT-NEWOR-NS, which doubles back through NEWOR). Defaults to true.

On UpdateQuotePreferences the stored value is written only when this field is present, so a client that omits it (for example a favorites-only save) never changes it.

⌘I

Get Quote Preferences

curl --request GET \
  --url https://api-lg-k.arms.cedarai.com/shipper/quote-preferences \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>'

import requests

url = "https://api-lg-k.arms.cedarai.com/shipper/quote-preferences"

headers = {
    "x-arms-api-key": "<api-key>",
    "x-arms-assume-user": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-arms-api-key': '<api-key>', 'x-arms-assume-user': '<api-key>'}
};

fetch('https://api-lg-k.arms.cedarai.com/shipper/quote-preferences', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-lg-k.arms.cedarai.com/shipper/quote-preferences",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-arms-api-key: <api-key>",
    "x-arms-assume-user: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-lg-k.arms.cedarai.com/shipper/quote-preferences"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-arms-api-key", "<api-key>")
	req.Header.Add("x-arms-assume-user", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-lg-k.arms.cedarai.com/shipper/quote-preferences")
  .header("x-arms-api-key", "<api-key>")
  .header("x-arms-assume-user", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-lg-k.arms.cedarai.com/shipper/quote-preferences")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-arms-api-key"] = '<api-key>'
request["x-arms-assume-user"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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": [
        {
          "car_type": "ALL_CAR_TYPES",
          "excluded_car_types": [
            "ALL_CAR_TYPES"
          ],
          "excluded_marks": [
            "<string>"
          ],
          "included_marks": [
            "<string>"
          ],
          "measurements": [
            {
              "dimension": "OUTSIDE_LENGTH_INCHES",
              "range": {
                "from": 123,
                "to": 123
              }
            }
          ],
          "name": "<string>",
          "plate_codes": [
            "<string>"
          ],
          "special_car_type": "FLAT"
        }
      ]
    }
  ],
  "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>"
      ]
    }
  ],
  "quotes_hide_duplicate_junctions": true
}

{
  "code": 123,
  "details": [
    {
      "@type": "<string>"
    }
  ],
  "message": "<string>"
}