Shipper Quotes API
List Shipper Quotes
POST
/
shipper
/
quotes
List Shipper Quotes
curl --request POST \
--url https://api-lg-k.arms.cedarai.com/shipper/quotes \
--header 'Content-Type: application/json' \
--header 'x-arms-api-key: <api-key>' \
--header 'x-arms-assume-user: <api-key>' \
--data '
{
"aar_car_type_pattern": "<string>",
"car_types": [],
"contents": {
"quantity": {
"amount": {
"value": "<string>"
}
},
"stccs_or_prefixes": [
"<string>"
]
},
"contract_cifs": [
"<string>"
],
"destination": {
"carrier_fsac": {
"carrier": "<string>",
"fsac": "<string>"
},
"city_state": {
"city": "<string>",
"state_or_province": "<string>"
},
"junction": {
"junction_code": "<string>"
},
"splc": {
"splc": "<string>"
}
},
"destination_cifs": [
"<string>"
],
"destination_unknown": true,
"destinations": [
{
"carrier_fsac": {
"carrier": "<string>",
"fsac": "<string>"
},
"city_state": {
"city": "<string>",
"state_or_province": "<string>"
},
"junction": {
"junction_code": "<string>"
},
"splc": {
"splc": "<string>"
}
}
],
"equipment_ownership_statuses": [],
"equipment_profiles": [
{
"measurements": [
{
"range": {
"from": 123,
"to": 123
}
}
],
"name": "<string>"
}
],
"exclude_carriers": [
"<string>"
],
"exclude_junctions": [
"<string>"
],
"number_of_cars": 123,
"origin": {
"carrier_fsac": {
"carrier": "<string>",
"fsac": "<string>"
},
"city_state": {
"city": "<string>",
"state_or_province": "<string>"
},
"junction": {
"junction_code": "<string>"
},
"splc": {
"splc": "<string>"
}
},
"origin_cifs": [
"<string>"
],
"origin_unknown": true,
"origins": [
{
"carrier_fsac": {
"carrier": "<string>",
"fsac": "<string>"
},
"city_state": {
"city": "<string>",
"state_or_province": "<string>"
},
"junction": {
"junction_code": "<string>"
},
"splc": {
"splc": "<string>"
}
}
],
"route": {
"entries": [
{
"carrier": "<string>",
"outbound_junction": "<string>",
"sequence_code": "<string>"
}
],
"val": "<string>"
},
"ship_date": "<string>"
}
'import requests
url = "https://api-lg-k.arms.cedarai.com/shipper/quotes"
payload = {
"aar_car_type_pattern": "<string>",
"car_types": [],
"contents": {
"quantity": { "amount": { "value": "<string>" } },
"stccs_or_prefixes": ["<string>"]
},
"contract_cifs": ["<string>"],
"destination": {
"carrier_fsac": {
"carrier": "<string>",
"fsac": "<string>"
},
"city_state": {
"city": "<string>",
"state_or_province": "<string>"
},
"junction": { "junction_code": "<string>" },
"splc": { "splc": "<string>" }
},
"destination_cifs": ["<string>"],
"destination_unknown": True,
"destinations": [
{
"carrier_fsac": {
"carrier": "<string>",
"fsac": "<string>"
},
"city_state": {
"city": "<string>",
"state_or_province": "<string>"
},
"junction": { "junction_code": "<string>" },
"splc": { "splc": "<string>" }
}
],
"equipment_ownership_statuses": [],
"equipment_profiles": [
{
"measurements": [{ "range": {
"from": 123,
"to": 123
} }],
"name": "<string>"
}
],
"exclude_carriers": ["<string>"],
"exclude_junctions": ["<string>"],
"number_of_cars": 123,
"origin": {
"carrier_fsac": {
"carrier": "<string>",
"fsac": "<string>"
},
"city_state": {
"city": "<string>",
"state_or_province": "<string>"
},
"junction": { "junction_code": "<string>" },
"splc": { "splc": "<string>" }
},
"origin_cifs": ["<string>"],
"origin_unknown": True,
"origins": [
{
"carrier_fsac": {
"carrier": "<string>",
"fsac": "<string>"
},
"city_state": {
"city": "<string>",
"state_or_province": "<string>"
},
"junction": { "junction_code": "<string>" },
"splc": { "splc": "<string>" }
}
],
"route": {
"entries": [
{
"carrier": "<string>",
"outbound_junction": "<string>",
"sequence_code": "<string>"
}
],
"val": "<string>"
},
"ship_date": "<string>"
}
headers = {
"x-arms-api-key": "<api-key>",
"x-arms-assume-user": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-arms-api-key': '<api-key>',
'x-arms-assume-user': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
aar_car_type_pattern: '<string>',
car_types: [],
contents: {quantity: {amount: {value: '<string>'}}, stccs_or_prefixes: ['<string>']},
contract_cifs: ['<string>'],
destination: {
carrier_fsac: {carrier: '<string>', fsac: '<string>'},
city_state: {city: '<string>', state_or_province: '<string>'},
junction: {junction_code: '<string>'},
splc: {splc: '<string>'}
},
destination_cifs: ['<string>'],
destination_unknown: true,
destinations: [
{
carrier_fsac: {carrier: '<string>', fsac: '<string>'},
city_state: {city: '<string>', state_or_province: '<string>'},
junction: {junction_code: '<string>'},
splc: {splc: '<string>'}
}
],
equipment_ownership_statuses: [],
equipment_profiles: [{measurements: [{range: {from: 123, to: 123}}], name: '<string>'}],
exclude_carriers: ['<string>'],
exclude_junctions: ['<string>'],
number_of_cars: 123,
origin: {
carrier_fsac: {carrier: '<string>', fsac: '<string>'},
city_state: {city: '<string>', state_or_province: '<string>'},
junction: {junction_code: '<string>'},
splc: {splc: '<string>'}
},
origin_cifs: ['<string>'],
origin_unknown: true,
origins: [
{
carrier_fsac: {carrier: '<string>', fsac: '<string>'},
city_state: {city: '<string>', state_or_province: '<string>'},
junction: {junction_code: '<string>'},
splc: {splc: '<string>'}
}
],
route: {
entries: [
{carrier: '<string>', outbound_junction: '<string>', sequence_code: '<string>'}
],
val: '<string>'
},
ship_date: '<string>'
})
};
fetch('https://api-lg-k.arms.cedarai.com/shipper/quotes', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'aar_car_type_pattern' => '<string>',
'car_types' => [
],
'contents' => [
'quantity' => [
'amount' => [
'value' => '<string>'
]
],
'stccs_or_prefixes' => [
'<string>'
]
],
'contract_cifs' => [
'<string>'
],
'destination' => [
'carrier_fsac' => [
'carrier' => '<string>',
'fsac' => '<string>'
],
'city_state' => [
'city' => '<string>',
'state_or_province' => '<string>'
],
'junction' => [
'junction_code' => '<string>'
],
'splc' => [
'splc' => '<string>'
]
],
'destination_cifs' => [
'<string>'
],
'destination_unknown' => true,
'destinations' => [
[
'carrier_fsac' => [
'carrier' => '<string>',
'fsac' => '<string>'
],
'city_state' => [
'city' => '<string>',
'state_or_province' => '<string>'
],
'junction' => [
'junction_code' => '<string>'
],
'splc' => [
'splc' => '<string>'
]
]
],
'equipment_ownership_statuses' => [
],
'equipment_profiles' => [
[
'measurements' => [
[
'range' => [
'from' => 123,
'to' => 123
]
]
],
'name' => '<string>'
]
],
'exclude_carriers' => [
'<string>'
],
'exclude_junctions' => [
'<string>'
],
'number_of_cars' => 123,
'origin' => [
'carrier_fsac' => [
'carrier' => '<string>',
'fsac' => '<string>'
],
'city_state' => [
'city' => '<string>',
'state_or_province' => '<string>'
],
'junction' => [
'junction_code' => '<string>'
],
'splc' => [
'splc' => '<string>'
]
],
'origin_cifs' => [
'<string>'
],
'origin_unknown' => true,
'origins' => [
[
'carrier_fsac' => [
'carrier' => '<string>',
'fsac' => '<string>'
],
'city_state' => [
'city' => '<string>',
'state_or_province' => '<string>'
],
'junction' => [
'junction_code' => '<string>'
],
'splc' => [
'splc' => '<string>'
]
]
],
'route' => [
'entries' => [
[
'carrier' => '<string>',
'outbound_junction' => '<string>',
'sequence_code' => '<string>'
]
],
'val' => '<string>'
],
'ship_date' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-lg-k.arms.cedarai.com/shipper/quotes"
payload := strings.NewReader("{\n \"aar_car_type_pattern\": \"<string>\",\n \"car_types\": [],\n \"contents\": {\n \"quantity\": {\n \"amount\": {\n \"value\": \"<string>\"\n }\n },\n \"stccs_or_prefixes\": [\n \"<string>\"\n ]\n },\n \"contract_cifs\": [\n \"<string>\"\n ],\n \"destination\": {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n },\n \"destination_cifs\": [\n \"<string>\"\n ],\n \"destination_unknown\": true,\n \"destinations\": [\n {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n }\n ],\n \"equipment_ownership_statuses\": [],\n \"equipment_profiles\": [\n {\n \"measurements\": [\n {\n \"range\": {\n \"from\": 123,\n \"to\": 123\n }\n }\n ],\n \"name\": \"<string>\"\n }\n ],\n \"exclude_carriers\": [\n \"<string>\"\n ],\n \"exclude_junctions\": [\n \"<string>\"\n ],\n \"number_of_cars\": 123,\n \"origin\": {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n },\n \"origin_cifs\": [\n \"<string>\"\n ],\n \"origin_unknown\": true,\n \"origins\": [\n {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n }\n ],\n \"route\": {\n \"entries\": [\n {\n \"carrier\": \"<string>\",\n \"outbound_junction\": \"<string>\",\n \"sequence_code\": \"<string>\"\n }\n ],\n \"val\": \"<string>\"\n },\n \"ship_date\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-arms-api-key", "<api-key>")
req.Header.Add("x-arms-assume-user", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-lg-k.arms.cedarai.com/shipper/quotes")
.header("x-arms-api-key", "<api-key>")
.header("x-arms-assume-user", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"aar_car_type_pattern\": \"<string>\",\n \"car_types\": [],\n \"contents\": {\n \"quantity\": {\n \"amount\": {\n \"value\": \"<string>\"\n }\n },\n \"stccs_or_prefixes\": [\n \"<string>\"\n ]\n },\n \"contract_cifs\": [\n \"<string>\"\n ],\n \"destination\": {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n },\n \"destination_cifs\": [\n \"<string>\"\n ],\n \"destination_unknown\": true,\n \"destinations\": [\n {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n }\n ],\n \"equipment_ownership_statuses\": [],\n \"equipment_profiles\": [\n {\n \"measurements\": [\n {\n \"range\": {\n \"from\": 123,\n \"to\": 123\n }\n }\n ],\n \"name\": \"<string>\"\n }\n ],\n \"exclude_carriers\": [\n \"<string>\"\n ],\n \"exclude_junctions\": [\n \"<string>\"\n ],\n \"number_of_cars\": 123,\n \"origin\": {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n },\n \"origin_cifs\": [\n \"<string>\"\n ],\n \"origin_unknown\": true,\n \"origins\": [\n {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n }\n ],\n \"route\": {\n \"entries\": [\n {\n \"carrier\": \"<string>\",\n \"outbound_junction\": \"<string>\",\n \"sequence_code\": \"<string>\"\n }\n ],\n \"val\": \"<string>\"\n },\n \"ship_date\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-lg-k.arms.cedarai.com/shipper/quotes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-arms-api-key"] = '<api-key>'
request["x-arms-assume-user"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"aar_car_type_pattern\": \"<string>\",\n \"car_types\": [],\n \"contents\": {\n \"quantity\": {\n \"amount\": {\n \"value\": \"<string>\"\n }\n },\n \"stccs_or_prefixes\": [\n \"<string>\"\n ]\n },\n \"contract_cifs\": [\n \"<string>\"\n ],\n \"destination\": {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n },\n \"destination_cifs\": [\n \"<string>\"\n ],\n \"destination_unknown\": true,\n \"destinations\": [\n {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n }\n ],\n \"equipment_ownership_statuses\": [],\n \"equipment_profiles\": [\n {\n \"measurements\": [\n {\n \"range\": {\n \"from\": 123,\n \"to\": 123\n }\n }\n ],\n \"name\": \"<string>\"\n }\n ],\n \"exclude_carriers\": [\n \"<string>\"\n ],\n \"exclude_junctions\": [\n \"<string>\"\n ],\n \"number_of_cars\": 123,\n \"origin\": {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n },\n \"origin_cifs\": [\n \"<string>\"\n ],\n \"origin_unknown\": true,\n \"origins\": [\n {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n }\n ],\n \"route\": {\n \"entries\": [\n {\n \"carrier\": \"<string>\",\n \"outbound_junction\": \"<string>\",\n \"sequence_code\": \"<string>\"\n }\n ],\n \"val\": \"<string>\"\n },\n \"ship_date\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"quotes": [
{
"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>"
}Body
application/json
Optional exact AAR/UMET car type pattern (for example "A-4" for plug doors) used for quote equipment assumptions and ARCT condition evaluation.
Optional car type overrides used for rating/equipment assumptions. Deprecated for new clients in favor of equipment_profiles, which also supports special quote-only types and additional measurement ranges. When provided, quote search matches rates for any selected car type.
Available options:
ALL_CAR_TYPES, BI_LEVEL, BOX_CAR, BULKHEAD, CLOSED, CLOSED_BI_LEVEL, CLOSED_TRI_LEVEL, COIL, COVERED_COIL, COVERED_GONDOLA, CUSHIONED_BOX_CAR, FLAT_PEDESTAL, GONDOLA, GRAVITY_FLOW, INSULATED_BOX_CAR, MECHANICAL_REFRIGERATOR, OPEN, OPEN_COIL_CARS, OPEN_GONDOLA, OPEN_HOPPER, PLUG_DOORS, TRI_LEVEL, TRIPLE_CROSS_HOPPER Show child attributes
Show child attributes
Contract CIF filters. If provided, matching contract quotes are included in addition to tariff results.
Show child attributes
Show child attributes
Customer CIFs at the destination; SCRS counterpart of origin_cifs for destinations.
Rule 11 segment pricing counterpart of origin_unknown: continuation beyond the destination gateway is unknown and unpriced. Same geography handling and junction-narrowing as origin_unknown. Requires method_of_payment = RULE_11.
List of candidate destination locations. Prefer this over the single destination input.
Show child attributes
Show child attributes
Optional equipment ownership status filters. When provided, quote search matches rates whose EQOS conditions include any of the selected statuses.
Equipment ownership status categories used in EQOS shipment conditions.
- HIGHWAY_CARRIER: H - Highway carrier
- SHIPPER_OWNED_OR_LEASED: S - Shipper owned or leased
- STEAMSHIP_LINES: O - Steamship lines
- RAILROAD_OWNED_OR_LEASED: R - Railroad owned or leased
Available options:
HIGHWAY_CARRIER, SHIPPER_OWNED_OR_LEASED, STEAMSHIP_LINES, RAILROAD_OWNED_OR_LEASED Optional equipment profile filters. When provided, quote search matches rates for any selected profile.
Show child attributes
Show child attributes
Carriers (reporting marks / SCAC, for example "BNSF", "UP") to exclude from routing. Any candidate route that involves one of these carriers on any leg is dropped from the results. Empty means no carrier exclusion is applied. Compared case-insensitively.
Junction / gateway codes (for example "DIANN") to exclude from routing. Any candidate route that interchanges through one of these junctions is dropped from the results. Empty means no junction exclusion is applied. Compared case-insensitively.
Available options:
PREPAID, COLLECT, RULE_11 Number of cars requested for the movement. Omitted/0 defaults to 1.
Show child attributes
Show child attributes
Customer CIFs at the origin. When provided, candidate origin stations are filtered to those onto which at least one of these customers may switch traffic under SCRS (Serving Carrier Reciprocal Switch) rules. Empty means no SCRS origin restriction is applied.
Rule 11 segment pricing: the true origin of the movement is unknown; the origin geographies (any supported form — city/state, FSAC, SPLC, or junction) locate the KNOWN gateway where the movement enters the priced portion. The location is narrowed to its stations at an interchange junction; a location with no junction station fails with INVALID_ARGUMENT (LOCATION_HAS_NO_GATEWAY). The priced portion is rated as part of a larger Rule 11 move arriving via that gateway (prior movement unpriced). Requires method_of_payment = RULE_11. May be combined with destination_unknown to price a bridge segment between two gateways.
List of candidate origin locations. This should be at most a handful, preferably fewer than 10. Prefer this over the single origin input.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Desired shipment date used for applicability/rating in ISO8601 format. Use YYYY-MM-DD (for example: "2026-03-03").
Response
A successful response.
Candidate quotes returned for the request.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
List Shipper Quotes
curl --request POST \
--url https://api-lg-k.arms.cedarai.com/shipper/quotes \
--header 'Content-Type: application/json' \
--header 'x-arms-api-key: <api-key>' \
--header 'x-arms-assume-user: <api-key>' \
--data '
{
"aar_car_type_pattern": "<string>",
"car_types": [],
"contents": {
"quantity": {
"amount": {
"value": "<string>"
}
},
"stccs_or_prefixes": [
"<string>"
]
},
"contract_cifs": [
"<string>"
],
"destination": {
"carrier_fsac": {
"carrier": "<string>",
"fsac": "<string>"
},
"city_state": {
"city": "<string>",
"state_or_province": "<string>"
},
"junction": {
"junction_code": "<string>"
},
"splc": {
"splc": "<string>"
}
},
"destination_cifs": [
"<string>"
],
"destination_unknown": true,
"destinations": [
{
"carrier_fsac": {
"carrier": "<string>",
"fsac": "<string>"
},
"city_state": {
"city": "<string>",
"state_or_province": "<string>"
},
"junction": {
"junction_code": "<string>"
},
"splc": {
"splc": "<string>"
}
}
],
"equipment_ownership_statuses": [],
"equipment_profiles": [
{
"measurements": [
{
"range": {
"from": 123,
"to": 123
}
}
],
"name": "<string>"
}
],
"exclude_carriers": [
"<string>"
],
"exclude_junctions": [
"<string>"
],
"number_of_cars": 123,
"origin": {
"carrier_fsac": {
"carrier": "<string>",
"fsac": "<string>"
},
"city_state": {
"city": "<string>",
"state_or_province": "<string>"
},
"junction": {
"junction_code": "<string>"
},
"splc": {
"splc": "<string>"
}
},
"origin_cifs": [
"<string>"
],
"origin_unknown": true,
"origins": [
{
"carrier_fsac": {
"carrier": "<string>",
"fsac": "<string>"
},
"city_state": {
"city": "<string>",
"state_or_province": "<string>"
},
"junction": {
"junction_code": "<string>"
},
"splc": {
"splc": "<string>"
}
}
],
"route": {
"entries": [
{
"carrier": "<string>",
"outbound_junction": "<string>",
"sequence_code": "<string>"
}
],
"val": "<string>"
},
"ship_date": "<string>"
}
'import requests
url = "https://api-lg-k.arms.cedarai.com/shipper/quotes"
payload = {
"aar_car_type_pattern": "<string>",
"car_types": [],
"contents": {
"quantity": { "amount": { "value": "<string>" } },
"stccs_or_prefixes": ["<string>"]
},
"contract_cifs": ["<string>"],
"destination": {
"carrier_fsac": {
"carrier": "<string>",
"fsac": "<string>"
},
"city_state": {
"city": "<string>",
"state_or_province": "<string>"
},
"junction": { "junction_code": "<string>" },
"splc": { "splc": "<string>" }
},
"destination_cifs": ["<string>"],
"destination_unknown": True,
"destinations": [
{
"carrier_fsac": {
"carrier": "<string>",
"fsac": "<string>"
},
"city_state": {
"city": "<string>",
"state_or_province": "<string>"
},
"junction": { "junction_code": "<string>" },
"splc": { "splc": "<string>" }
}
],
"equipment_ownership_statuses": [],
"equipment_profiles": [
{
"measurements": [{ "range": {
"from": 123,
"to": 123
} }],
"name": "<string>"
}
],
"exclude_carriers": ["<string>"],
"exclude_junctions": ["<string>"],
"number_of_cars": 123,
"origin": {
"carrier_fsac": {
"carrier": "<string>",
"fsac": "<string>"
},
"city_state": {
"city": "<string>",
"state_or_province": "<string>"
},
"junction": { "junction_code": "<string>" },
"splc": { "splc": "<string>" }
},
"origin_cifs": ["<string>"],
"origin_unknown": True,
"origins": [
{
"carrier_fsac": {
"carrier": "<string>",
"fsac": "<string>"
},
"city_state": {
"city": "<string>",
"state_or_province": "<string>"
},
"junction": { "junction_code": "<string>" },
"splc": { "splc": "<string>" }
}
],
"route": {
"entries": [
{
"carrier": "<string>",
"outbound_junction": "<string>",
"sequence_code": "<string>"
}
],
"val": "<string>"
},
"ship_date": "<string>"
}
headers = {
"x-arms-api-key": "<api-key>",
"x-arms-assume-user": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-arms-api-key': '<api-key>',
'x-arms-assume-user': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
aar_car_type_pattern: '<string>',
car_types: [],
contents: {quantity: {amount: {value: '<string>'}}, stccs_or_prefixes: ['<string>']},
contract_cifs: ['<string>'],
destination: {
carrier_fsac: {carrier: '<string>', fsac: '<string>'},
city_state: {city: '<string>', state_or_province: '<string>'},
junction: {junction_code: '<string>'},
splc: {splc: '<string>'}
},
destination_cifs: ['<string>'],
destination_unknown: true,
destinations: [
{
carrier_fsac: {carrier: '<string>', fsac: '<string>'},
city_state: {city: '<string>', state_or_province: '<string>'},
junction: {junction_code: '<string>'},
splc: {splc: '<string>'}
}
],
equipment_ownership_statuses: [],
equipment_profiles: [{measurements: [{range: {from: 123, to: 123}}], name: '<string>'}],
exclude_carriers: ['<string>'],
exclude_junctions: ['<string>'],
number_of_cars: 123,
origin: {
carrier_fsac: {carrier: '<string>', fsac: '<string>'},
city_state: {city: '<string>', state_or_province: '<string>'},
junction: {junction_code: '<string>'},
splc: {splc: '<string>'}
},
origin_cifs: ['<string>'],
origin_unknown: true,
origins: [
{
carrier_fsac: {carrier: '<string>', fsac: '<string>'},
city_state: {city: '<string>', state_or_province: '<string>'},
junction: {junction_code: '<string>'},
splc: {splc: '<string>'}
}
],
route: {
entries: [
{carrier: '<string>', outbound_junction: '<string>', sequence_code: '<string>'}
],
val: '<string>'
},
ship_date: '<string>'
})
};
fetch('https://api-lg-k.arms.cedarai.com/shipper/quotes', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'aar_car_type_pattern' => '<string>',
'car_types' => [
],
'contents' => [
'quantity' => [
'amount' => [
'value' => '<string>'
]
],
'stccs_or_prefixes' => [
'<string>'
]
],
'contract_cifs' => [
'<string>'
],
'destination' => [
'carrier_fsac' => [
'carrier' => '<string>',
'fsac' => '<string>'
],
'city_state' => [
'city' => '<string>',
'state_or_province' => '<string>'
],
'junction' => [
'junction_code' => '<string>'
],
'splc' => [
'splc' => '<string>'
]
],
'destination_cifs' => [
'<string>'
],
'destination_unknown' => true,
'destinations' => [
[
'carrier_fsac' => [
'carrier' => '<string>',
'fsac' => '<string>'
],
'city_state' => [
'city' => '<string>',
'state_or_province' => '<string>'
],
'junction' => [
'junction_code' => '<string>'
],
'splc' => [
'splc' => '<string>'
]
]
],
'equipment_ownership_statuses' => [
],
'equipment_profiles' => [
[
'measurements' => [
[
'range' => [
'from' => 123,
'to' => 123
]
]
],
'name' => '<string>'
]
],
'exclude_carriers' => [
'<string>'
],
'exclude_junctions' => [
'<string>'
],
'number_of_cars' => 123,
'origin' => [
'carrier_fsac' => [
'carrier' => '<string>',
'fsac' => '<string>'
],
'city_state' => [
'city' => '<string>',
'state_or_province' => '<string>'
],
'junction' => [
'junction_code' => '<string>'
],
'splc' => [
'splc' => '<string>'
]
],
'origin_cifs' => [
'<string>'
],
'origin_unknown' => true,
'origins' => [
[
'carrier_fsac' => [
'carrier' => '<string>',
'fsac' => '<string>'
],
'city_state' => [
'city' => '<string>',
'state_or_province' => '<string>'
],
'junction' => [
'junction_code' => '<string>'
],
'splc' => [
'splc' => '<string>'
]
]
],
'route' => [
'entries' => [
[
'carrier' => '<string>',
'outbound_junction' => '<string>',
'sequence_code' => '<string>'
]
],
'val' => '<string>'
],
'ship_date' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-lg-k.arms.cedarai.com/shipper/quotes"
payload := strings.NewReader("{\n \"aar_car_type_pattern\": \"<string>\",\n \"car_types\": [],\n \"contents\": {\n \"quantity\": {\n \"amount\": {\n \"value\": \"<string>\"\n }\n },\n \"stccs_or_prefixes\": [\n \"<string>\"\n ]\n },\n \"contract_cifs\": [\n \"<string>\"\n ],\n \"destination\": {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n },\n \"destination_cifs\": [\n \"<string>\"\n ],\n \"destination_unknown\": true,\n \"destinations\": [\n {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n }\n ],\n \"equipment_ownership_statuses\": [],\n \"equipment_profiles\": [\n {\n \"measurements\": [\n {\n \"range\": {\n \"from\": 123,\n \"to\": 123\n }\n }\n ],\n \"name\": \"<string>\"\n }\n ],\n \"exclude_carriers\": [\n \"<string>\"\n ],\n \"exclude_junctions\": [\n \"<string>\"\n ],\n \"number_of_cars\": 123,\n \"origin\": {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n },\n \"origin_cifs\": [\n \"<string>\"\n ],\n \"origin_unknown\": true,\n \"origins\": [\n {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n }\n ],\n \"route\": {\n \"entries\": [\n {\n \"carrier\": \"<string>\",\n \"outbound_junction\": \"<string>\",\n \"sequence_code\": \"<string>\"\n }\n ],\n \"val\": \"<string>\"\n },\n \"ship_date\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-arms-api-key", "<api-key>")
req.Header.Add("x-arms-assume-user", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-lg-k.arms.cedarai.com/shipper/quotes")
.header("x-arms-api-key", "<api-key>")
.header("x-arms-assume-user", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"aar_car_type_pattern\": \"<string>\",\n \"car_types\": [],\n \"contents\": {\n \"quantity\": {\n \"amount\": {\n \"value\": \"<string>\"\n }\n },\n \"stccs_or_prefixes\": [\n \"<string>\"\n ]\n },\n \"contract_cifs\": [\n \"<string>\"\n ],\n \"destination\": {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n },\n \"destination_cifs\": [\n \"<string>\"\n ],\n \"destination_unknown\": true,\n \"destinations\": [\n {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n }\n ],\n \"equipment_ownership_statuses\": [],\n \"equipment_profiles\": [\n {\n \"measurements\": [\n {\n \"range\": {\n \"from\": 123,\n \"to\": 123\n }\n }\n ],\n \"name\": \"<string>\"\n }\n ],\n \"exclude_carriers\": [\n \"<string>\"\n ],\n \"exclude_junctions\": [\n \"<string>\"\n ],\n \"number_of_cars\": 123,\n \"origin\": {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n },\n \"origin_cifs\": [\n \"<string>\"\n ],\n \"origin_unknown\": true,\n \"origins\": [\n {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n }\n ],\n \"route\": {\n \"entries\": [\n {\n \"carrier\": \"<string>\",\n \"outbound_junction\": \"<string>\",\n \"sequence_code\": \"<string>\"\n }\n ],\n \"val\": \"<string>\"\n },\n \"ship_date\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-lg-k.arms.cedarai.com/shipper/quotes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-arms-api-key"] = '<api-key>'
request["x-arms-assume-user"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"aar_car_type_pattern\": \"<string>\",\n \"car_types\": [],\n \"contents\": {\n \"quantity\": {\n \"amount\": {\n \"value\": \"<string>\"\n }\n },\n \"stccs_or_prefixes\": [\n \"<string>\"\n ]\n },\n \"contract_cifs\": [\n \"<string>\"\n ],\n \"destination\": {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n },\n \"destination_cifs\": [\n \"<string>\"\n ],\n \"destination_unknown\": true,\n \"destinations\": [\n {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n }\n ],\n \"equipment_ownership_statuses\": [],\n \"equipment_profiles\": [\n {\n \"measurements\": [\n {\n \"range\": {\n \"from\": 123,\n \"to\": 123\n }\n }\n ],\n \"name\": \"<string>\"\n }\n ],\n \"exclude_carriers\": [\n \"<string>\"\n ],\n \"exclude_junctions\": [\n \"<string>\"\n ],\n \"number_of_cars\": 123,\n \"origin\": {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n },\n \"origin_cifs\": [\n \"<string>\"\n ],\n \"origin_unknown\": true,\n \"origins\": [\n {\n \"carrier_fsac\": {\n \"carrier\": \"<string>\",\n \"fsac\": \"<string>\"\n },\n \"city_state\": {\n \"city\": \"<string>\",\n \"state_or_province\": \"<string>\"\n },\n \"junction\": {\n \"junction_code\": \"<string>\"\n },\n \"splc\": {\n \"splc\": \"<string>\"\n }\n }\n ],\n \"route\": {\n \"entries\": [\n {\n \"carrier\": \"<string>\",\n \"outbound_junction\": \"<string>\",\n \"sequence_code\": \"<string>\"\n }\n ],\n \"val\": \"<string>\"\n },\n \"ship_date\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"quotes": [
{
"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>"
}