Shipper Quotes API

List Customers

Searches customers (CIFs) by free text and returns each match together with the SCRS entries in force for it today: the carriers serving each of the customer’s rail stations and their reciprocal-switching status. Your own SCRS custom entries replace the file’s rows for the same facility, exactly as ListQuotes sees them, unless exclude_custom_entries is set. Use the returned CIFs as ListQuotesRequest.origin_cifs / destination_cifs.

Example: GET /shipper/customers?search_text=home%20depot%20austin&page_size=25

GET

shipper

customers

List Customers

curl --request GET \
  --url https://api-lg-k.arms.cedarai.com/shipper/customers \
  --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/customers"

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/customers', 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/customers",
  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/customers"

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

}

require 'uri'
require 'net/http'

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

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

{
  "customers": [
    {
      "address": {
        "city": "<string>",
        "country": "<string>",
        "lines": [
          "<string>"
        ],
        "state": "<string>",
        "zip": "<string>"
      },
      "cif": "<string>",
      "customer_location_suffix": "<string>",
      "name": "<string>",
      "scrs_entries": [
        {
          "carrier": "<string>",
          "conditions": [
            {
              "cond_cd": "<string>",
              "cond_val": "<string>",
              "cond_val_from": "<string>",
              "cond_val_to": "<string>",
              "connection": "<string>",
              "group_number": "<string>",
              "relationship": "<string>"
            }
          ],
          "effective_date": "<string>",
          "expiration_date": "<string>",
          "fsac": "<string>",
          "station_name": "<string>",
          "station_splc": "<string>",
          "station_state": "<string>",
          "switching_status": "SCRS_SWITCHING_STATUS_OPEN"
        }
      ]
    }
  ],
  "next_page_token": "<string>"
}

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

Authorizations

x-arms-api-key

string

header

required

x-arms-assume-user

string

header

required

Query Parameters

search_text

string

Required. Free-text search: every whitespace-separated token must prefix-match a word of the customer's name, physical city, state/province, or CIF. Case-insensitive. Examples: "home depot austin tx", "006123".

page_size

integer<int64>

Maximum customers to return. Defaults to 25; values above 100 are treated as 100.

page_token

string

next_page_token from a previous response, to fetch the following page.

exclude_custom_entries

boolean

When true, return the SCRS file's rows only, ignoring your SCRS custom entries (overrides). Defaults to false: your custom entries replace the file's rows for their facility, as they do for ListQuotes.

Response

A successful response.

customers

object[]

Matching customers, ordered by name, then city, state, and CIF.

Show child attributes

next_page_token

string

Present when more customers match; pass it back as page_token.

⌘I

List Customers

curl --request GET \
  --url https://api-lg-k.arms.cedarai.com/shipper/customers \
  --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/customers"

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/customers', 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/customers",
  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/customers"

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

}

require 'uri'
require 'net/http'

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

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

{
  "customers": [
    {
      "address": {
        "city": "<string>",
        "country": "<string>",
        "lines": [
          "<string>"
        ],
        "state": "<string>",
        "zip": "<string>"
      },
      "cif": "<string>",
      "customer_location_suffix": "<string>",
      "name": "<string>",
      "scrs_entries": [
        {
          "carrier": "<string>",
          "conditions": [
            {
              "cond_cd": "<string>",
              "cond_val": "<string>",
              "cond_val_from": "<string>",
              "cond_val_to": "<string>",
              "connection": "<string>",
              "group_number": "<string>",
              "relationship": "<string>"
            }
          ],
          "effective_date": "<string>",
          "expiration_date": "<string>",
          "fsac": "<string>",
          "station_name": "<string>",
          "station_splc": "<string>",
          "station_state": "<string>",
          "switching_status": "SCRS_SWITCHING_STATUS_OPEN"
        }
      ]
    }
  ],
  "next_page_token": "<string>"
}

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