Site Logo

🎉 ShipEngine is becoming ShipStation API 🎉

Over the next few months you'll notice the ShipEngine website, documentation portal, and dashboard being rebranded as ShipStation API. For our ShipEngine customers, you don't need to take any action or change any of your integrations in any way. All endpoints will remain the same and continue to function as they always have.

To learn more about what's coming, review our New ShipStation API page.

Connect LTL Carrier Accounts

ShipStation API allows you to connect your existing LTL carrier accounts programmatically rather than via the dashboard. You'll add the credentials required to access the carrier's API using the requests described below. Keep in mind that rates will be based on the account information you provide in the quote request.

Requirements

  • The carrier_code for your LTL carrier. This code will be passed in the URL as a query string. This is what tells ShipStation API which carrier you are connecting.

About Carrier Codes

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 ShipStation API depends on the carrier. You can find the requirements for connecting each LTL carrier available through ShipStation 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 ShipStation 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 ShipStation API has assigned to this carrier connection within your ShipStation API account. This carrier_id is only valid for your account. You will use this carrier_id in subsequent requests.

Example Response

1
2
3
{
"carrier_id": "car_vsY7PLz7KEs48vh9"
}

Carriers