Get Shipper Quote
curl --request GET \
--url https://api-lg-k.arms.cedarai.com/shipper/quotes/{name} \
--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/quotes/{name}"
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/quotes/{name}', 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/quotes/{name}",
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/quotes/{name}"
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/quotes/{name}")
.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/quotes/{name}")
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{
"created_at": "2023-11-07T05:31:56Z",
"distance": {
"value": {
"value": "<string>"
}
},
"furtherance_beyond_destination": true,
"legs": [
{
"billing_carrier": "<string>",
"charges": [
{
"amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"per_car_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"rate": {
"amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"car_type_conditions": [
{}
],
"docket_column": 123,
"docket_level": 123,
"docket_line": 123,
"docket_sub_level": 123,
"equipment_ownership_conditions": [],
"matching_equipment_profile_names": [
"<string>"
],
"pndr": {
"docket_identifier": "<string>",
"number": "<string>",
"producer": "<string>",
"revision": 123
},
"publication": {
"effective_date": "<string>",
"expiration_date": "<string>",
"issuer": "<string>",
"number": "<string>",
"suffix": "<string>"
}
},
"rated_quantity": {
"amount": {
"value": "<string>"
}
},
"special_charge_description": "<string>",
"special_charge_or_allowance_code": "<string>"
}
],
"destination": {
"carrier": "<string>",
"city": "<string>",
"fsac": "<string>",
"junction_code": "<string>",
"latitude": 123,
"longitude": 123,
"splc": "<string>",
"state": "<string>"
},
"distance": {
"value": {
"value": "<string>"
}
},
"origin": {
"carrier": "<string>",
"city": "<string>",
"fsac": "<string>",
"junction_code": "<string>",
"latitude": 123,
"longitude": 123,
"splc": "<string>",
"state": "<string>"
},
"route": {
"entries": [
{
"carrier": "<string>",
"outbound_junction": "<string>",
"sequence_code": "<string>"
}
],
"val": "<string>"
},
"total": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
}
}
],
"name": "<string>",
"number_of_cars": 123,
"prior_movement_before_origin": true,
"route": {
"entries": [
{
"carrier": "<string>",
"outbound_junction": "<string>",
"sequence_code": "<string>"
}
],
"val": "<string>"
},
"total": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
}
}{
"code": 123,
"details": [
{
"@type": "<string>"
}
],
"message": "<string>"
}Path Parameters
Stable quote resource name as returned in Quote.name, e.g. "quotes/".
[^/]+Response
A successful response.
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.
Show child attributes
Show child attributes
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.
Quote legs, each with its own route, distance, and itemized charges.
Show child attributes
Show child attributes
Stable quote identifier.
Number of cars used to scale per-car and aggregate quote amounts.
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.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
curl --request GET \
--url https://api-lg-k.arms.cedarai.com/shipper/quotes/{name} \
--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/quotes/{name}"
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/quotes/{name}', 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/quotes/{name}",
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/quotes/{name}"
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/quotes/{name}")
.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/quotes/{name}")
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{
"created_at": "2023-11-07T05:31:56Z",
"distance": {
"value": {
"value": "<string>"
}
},
"furtherance_beyond_destination": true,
"legs": [
{
"billing_carrier": "<string>",
"charges": [
{
"amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"per_car_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"rate": {
"amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"car_type_conditions": [
{}
],
"docket_column": 123,
"docket_level": 123,
"docket_line": 123,
"docket_sub_level": 123,
"equipment_ownership_conditions": [],
"matching_equipment_profile_names": [
"<string>"
],
"pndr": {
"docket_identifier": "<string>",
"number": "<string>",
"producer": "<string>",
"revision": 123
},
"publication": {
"effective_date": "<string>",
"expiration_date": "<string>",
"issuer": "<string>",
"number": "<string>",
"suffix": "<string>"
}
},
"rated_quantity": {
"amount": {
"value": "<string>"
}
},
"special_charge_description": "<string>",
"special_charge_or_allowance_code": "<string>"
}
],
"destination": {
"carrier": "<string>",
"city": "<string>",
"fsac": "<string>",
"junction_code": "<string>",
"latitude": 123,
"longitude": 123,
"splc": "<string>",
"state": "<string>"
},
"distance": {
"value": {
"value": "<string>"
}
},
"origin": {
"carrier": "<string>",
"city": "<string>",
"fsac": "<string>",
"junction_code": "<string>",
"latitude": 123,
"longitude": 123,
"splc": "<string>",
"state": "<string>"
},
"route": {
"entries": [
{
"carrier": "<string>",
"outbound_junction": "<string>",
"sequence_code": "<string>"
}
],
"val": "<string>"
},
"total": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
}
}
],
"name": "<string>",
"number_of_cars": 123,
"prior_movement_before_origin": true,
"route": {
"entries": [
{
"carrier": "<string>",
"outbound_junction": "<string>",
"sequence_code": "<string>"
}
],
"val": "<string>"
},
"total": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
}
}{
"code": 123,
"details": [
{
"@type": "<string>"
}
],
"message": "<string>"
}