Skip to main content
GET
/
shipper
/
quotes
/
{name}
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>'
{
  "created_at": "2023-11-07T05:31:56Z",
  "distance": {
    "value": {
      "value": "<string>"
    }
  },
  "legs": [
    {
      "billing_carrier": "<string>",
      "charges": [
        {
          "amount": {
            "cents": 123,
            "currency": "<string>",
            "dollars": "<string>"
          },
          "billing_carrier": "<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": [],
            "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>"
            }
          },
          "route_deprecated": "<string>",
          "special_charge_description": "<string>",
          "special_charge_or_allowance_code": "<string>"
        }
      ],
      "destination": {
        "carrier": "<string>",
        "city": "<string>",
        "fsac": "<string>",
        "junction_code": "<string>",
        "splc": "<string>",
        "state": "<string>"
      },
      "distance": {
        "value": {
          "value": "<string>"
        }
      },
      "origin": {
        "carrier": "<string>",
        "city": "<string>",
        "fsac": "<string>",
        "junction_code": "<string>",
        "splc": "<string>",
        "state": "<string>"
      },
      "route": {
        "entries": [
          {
            "carrier": "<string>",
            "outbound_junction": "<string>",
            "sequence_code": "<string>"
          }
        ],
        "route_deprecated": "<string>",
        "val": "<string>"
      },
      "route_deprecated": "<string>",
      "total": {
        "cents": 123,
        "currency": "<string>",
        "dollars": "<string>"
      }
    }
  ],
  "name": "<string>",
  "number_of_cars": 123,
  "route": {
    "entries": [
      {
        "carrier": "<string>",
        "outbound_junction": "<string>",
        "sequence_code": "<string>"
      }
    ],
    "route_deprecated": "<string>",
    "val": "<string>"
  },
  "route_deprecated": "<string>",
  "total": {
    "cents": 123,
    "currency": "<string>",
    "dollars": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.cedarai.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

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

Path Parameters

​
name
string
required

Stable quote resource name as returned in Quote.name, e.g. "quotes/".

Pattern: [^/]+

Response

A successful response.

​
created_at
string<date-time>

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.

​
distance
object
​
legs
object[]

Quote legs, each with its own route, distance, and itemized charges.

​
name
string

Stable quote identifier.

​
number_of_cars
integer<int32>

Number of cars used to scale per-car and aggregate quote amounts.

​
route
object
​
route_deprecated
string

Deprecated in favor of route.

​
total
object