CrossCountry Freight Solutions API Documentation

Introduction

Our API allows eligible customers to request quotes, track shipments, schedule pickups, and retrieve service information using modern REST web services. You can download the xsd schema to help you get started.

Authentication

In order to request quotes, track shipments, or schedule pickups, you must obtain an API key. An API key is not required for obtaining service information, however if your company has specialized rating you should send the API key to retrieve information specific to your company.

The API key is sent in an HTTP header named "APIKEY" of each request (for example, "APIKEY: 1DB013BED10240B89F0F6726B0D69C5E").

Restrictions

Authenticated services are limited to an IP address range assigned during setup, and are throttled at 250 requests in a 15 minute time period. Unauthenticated services are not throttled, but excessive usage is subject to restriction.

Updates

If changes are made to the API, you will be informed via email using the addresses you specified during setup. The old version and new version of the API will both be accessible for 30 days after the notice, after which time all integrations must be migrated to the new version.

Service

Services for retrieving service information

API	Description
GET Service/Accessorial?Accessorial={Accessorial}&Effective={Effective}	Retrieve accessorial definitions, including information about calculation
GET Service/Alert?ZipCode={ZipCode}	Retrieve alerts that may impact service in the specified zip code, such as weather
GET Service/FreightClass	Retrieve list of freight classes
GET Service/FuelInfo?EffectiveDate={EffectiveDate}	Retrieve fuel surcharge definition
GET Service/Holiday	Retrieve a list of observed holidays in the next year
GET Service/PackageType?PackageType={PackageType}	Retrieve package type definitions
GET Service/Rule?Item={Item}&Section={Section}&Paragraph={Paragraph}	Retrieve rules tariff information
GET Service/ServicePoint?ZoneId={ZoneId}&City={City}&State={State}&Zip={Zip}&PartialZip={PartialZip}&Country={Country}&ServiceType={ServiceType}	Retrieve service point definitions
GET Service/ServiceType?ServiceType={ServiceType}	Retrieve service type definitions
GET Service/StatusDescription	Retrieve status descriptions
GET Service/Terminal?Terminal={Terminal}	Retrieve terminal definitions
GET Service/TransitInfo?Orig={Orig}&Dest={Dest}&ShipDate={ShipDate}	Calculate transit time between two points

Quote

Services for requesting quotes (API key required)

API	Description
POST Quote	Submit a quote request
PUT Quote?Orig={Orig}&Dest={Dest}&Weight={Weight}&Units={Units}&PackageType={PackageType}&Class={Class}&Length={Length}&Width={Width}&Height={Height}	Submit a simple quote request using query string parameters
GET Quote?QuoteNum={QuoteNum}	Retrieve a previous quote by quote number

Pickup

Services for requesting pickups (API key required). Please review prohibited articles and restricted articles in the rules tariff.

API	Description
POST Pickup	Submit a pickup request
PUT Pickup?Location={Location}&Address={Address}&Zip={Zip}&Bills={Bills}&Units={Units}&Weight={Weight}&TestFlag={TestFlag}	Submit a simple pickup request using query string parameters
DELETE Pickup?FreightBillNum={FreightBillNum}	Cancel a pickup request
GET Pickup?FreightBillNum={FreightBillNum}	Retrieve a pickup request by freight bill number

Track

Services for tracking shipments (API key required)

API	Description
GET Track?ReferenceNum={ReferenceNum}&BeginDate={BeginDate}&EndDate={EndDate}	Retrieve shipment tracking information

Image

Services for retrieving binary images (API key required).

API	Description
GET Image?ImageId={ImageId}	Retrieve a binary image