Connect LTL Carrier Accounts
ShipEngine API allows you to connect your existing LTL carrier accounts to your ShipEngine API account programmatically rather than having to log in to the ShipEngine API dashboard. You'll add the credentials required to access the carrier's API in the requests described below. Keep in mind, however, that rates will be based on the account information you provide in the quote request.
Carrier Codes
In the requests below, you will need to know the carrier code for your LTL carrier. This code will be passed in the URL as a query string. This is what tells ShipEngine API which carrier you are connecting.
The carrier codes are mapped to the carriers' SCACs, and many carriers have more than one. The SCACs may correspond to different services or other arrangements that the carrier offers. For more information about the individual SCACs listed, contact the carrier.
Connect Carrier Request
Each LTL carrier uses its own format for authentication, so the information your application must pass to connect an account through ShipEngine API depends on the carrier. You can find the requirements for connecting each LTL carrier available through ShipEngine API, including the credential requirements, and an example request, below. Additionally, you can list the credential requirements for a specific carrier.
Connect Carrier Response
While the connection request body looks different for each carrier, the response from ShipEngine API has the same shape regardless of which carrier you are using. An example request is included with the credential requirements for each carrier, and the example response below applies to all carriers.
The response includes the carrier_id
that ShipEngine API has assigned to this carrier connection within your ShipEngine
API account. This carrier_id
is only valid for your account. You will use this carrier_id
in subsequent API requests.
Example Response
Carriers
Connection Information
Property | Type | Required | Description |
---|---|---|---|
key | string | ✔ | The key provided by the carrier. |
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/aact
Connection Information
Property | Type | Required | Description |
---|---|---|---|
username | string | ✔ | The API ID generated by the carrier. |
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/abfs
Connection Information
Property | Type | Required | Description |
---|---|---|---|
username | string | ✔ | Your aduiepyle.com Username. |
password | string | ✔ | Your aduiepyle.com Password. |
account_number | string | ✔ | The account number for your account with the carrier. |
POST /v-beta/ltl/connections/pyle
Connection Information
Property | Type | Required | Description |
---|---|---|---|
key | string | ✔ | Your averittexpress.com API Key. |
username | string | ✔ | Your averittexpress.com Username. |
password | string | ✔ | Your averittexpress.com Password. |
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/avrt
Connection Information
Property | Type | Required | Description |
---|---|---|---|
username | string | ✔ | Your centralfreight.com Username. |
password | string | ✔ | Your Your centralfreight.com Password. |
account_number | string | ✔ | The account number for your account with the carrier. |
POST /v-beta/ltl/connections/cenf
Connection Information
Property | Type | Required | Description |
---|---|---|---|
key | string | ✔ | Access Code provided by the carrier. |
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/ctii
Connection Information
Property | Type | Required | Description |
---|---|---|---|
username | string | ✔ | MyDaylight username. |
password | string | ✔ | MyDaylight password. |
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/dylt
Connection Information
Property | Type | Required | Description |
---|---|---|---|
username | string | ✔ | Day and Ross Account Email. |
password | string | ✔ | Day and Ross Account Password. |
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/dayr
Connection Information
Property | Type | Required | Description |
---|---|---|---|
username | string | ✔ | Your daytonfreight.com Username. |
password | string | ✔ | Your daytonfreight.com Password. |
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/dafg
Connection Information
Property | Type | Required | Description |
---|---|---|---|
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/dphe
Connection Information
Property | Type | Required | Description |
---|---|---|---|
username | string | ✔ | Your MyEstes.com Username. |
password | string | ✔ | Your MyEstes.com Password. |
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/exla
FedEx LTL Freight Priority (
FXFR
) is the premier carrier for all points in the U.S., Canada and Mexico, specializing in next and second day markets.FedEx Freight Economy (
FXNR
) is the premier carrier for all points in the U.S, specializing in long haul markets.The SCAC is only relevant if you are requesting a quote for contracted rates. For spot quotes and bulk quotes, you can use either SCAC to connect your FedEx Freight account to your ShipEngine API account.
Property Type Required Description username
string ✔ FedEx API key or client_id
.password
string ✔ FedEx secret key, or client_secret
.secret
string ✔ Spot Quote Authentication Key generated by the carrier used for volume pricing only. securitycode
string ✔ Your FedEx account number. The
client_id
andclient_secret
values are generated by FedEx’s new REST API developer portal. You must create a FedEx developer account to obtain these credentials, which will require your FedEx account user ID and password.To learn how to obtain the required credentials, review the steps in this FedEx guide.
Example Request
POST /v-beta/ltl/connections/:carrier_code
Connection Information
This connection information applies to the following SCACs: FXFR
and FXNR
.
Connection Information
Property | Type | Required | Description |
---|---|---|---|
username | string | ✔ | Your API Username. |
password | string | ✔ | Your API Password. |
key | string | ✔ | Access Code provided by the carrier. |
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/fwdn
Connection Information
Property | Type | Required | Description |
---|---|---|---|
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/midw
Connection Information
Property | Type | Required | Description |
---|---|---|---|
key | string | ✔ | API Key provided by the carrier. |
username | string | ✔ | Email address used to register for MyOHFL at oakh.com. |
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/oakh
Connection Information
Property | Type | Required | Description |
---|---|---|---|
username | string | ✔ | Your ODFL4me Username. |
password | string | ✔ | Your ODFL4me Password. |
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/odfl
Connection Information
Property | Type | Required | Description |
---|---|---|---|
username | string | ✔ | Your works.pittohio.com Username. |
password | string | ✔ | Your works.pittohio.com Password. |
key | string | ✔ | Your irv numeric identifier value. |
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/pitd
Connection Information
This connection information applies to the following SCACs:
RLCA
, RFLFC
, RNLO
, RLRR
, RLFV
, RLCA
. Contact the carrier if you are unsure of which SCAC
to use.
Property | Type | Required | Description |
---|---|---|---|
key | string | ✔ | API Key generated by the carrier after registering for their B2B API Tools. |
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/:carrier_code
Connection Information
Property | Type | Required | Description |
---|---|---|---|
username | string | ✔ | Your freight.rrts.com Username. |
password | string | ✔ | Your freight.rrts.com Password. |
secret | string | API Secret Key - Required for Document only. | |
key | string | Application Identifier - Required for Document only. | |
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/rdfs
Connection Information
Property | Type | Required | Description |
---|---|---|---|
username | string | ✔ | Your saia.com Username. |
password | string | ✔ | Your saia.com Password. |
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/saia
Connection Information
Property | Type | Required | Description |
---|---|---|---|
username | string | ✔ | Your MySEFL Username. |
password | string | ✔ | Your MySEFL Password. |
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/sefl
Connection Information
Property | Type | Required | Description |
---|---|---|---|
username | string | ✔ | STDF username. |
password | string | ✔ | STDF password. |
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/stdf
Connection Information
Property | Type | Required | Description |
---|---|---|---|
username | string | ✔ | Your ups.com Username. |
password | string | ✔ | Your ups.com Password. |
key | string | ✔ | Access Key. |
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/upgf
Connection Information
Property | Type | Required | Description |
---|---|---|---|
username | string | ✔ | Your wardtlctools.com Username. |
password | string | ✔ | Your wardtlctools.com Password. |
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/ward
Connection Information
This connection information applies to the following SCACs:
CNWY
, CWCE
, CWSE
, CWNO
, XPOL
, and CWWE
. Contact the carrier if you are unsure of which SCAC
to use.
Property | Type | Required | Description |
---|---|---|---|
username | string | ✔ | Your ltl.xpo.com Username. |
password | string | ✔ | Your ltl.xpo.com Password. |
key | string | ✔ | Key provided by carrier for API consumer access. |
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/:carrier_code
Connection Information
This connection information applies to the following SCACs:
RDWY
, YFSY
, and YRCA
. Contact the carrier if you are unsure of which SCAC
to use.
Property | Type | Required | Description |
---|---|---|---|
username | string | ✔ | Your my.yrcfreight.com Username. |
password | string | ✔ | Your my.yrcfreight.com Password. |
account_number | string | ✔ | The account number for your account with the carrier. |
Example Request
POST /v-beta/ltl/connections/:carrier_code