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.

List a Single LTL Carrier

This endpoint returns a list of helpful information about a single LTL carrier account, including the available accessorial services, container types, and service levels for that particular LTL carrier account.

To list the details for all carriers, use the list connected LTL carrier call.

Requirements

  • The unique carrier_id for your LTL carrier account in ShipStation API.

This unique ID represents your connection with a specific carrier, and ShipStation API generates and returns this unique carrier_id when you connect a carrier account.

Container Types & Accessorial Services

If you have experience with LTL shipping, you are probably familiar with speaking about LTL shipments in terms of the container used for shipping as well as the possible accessorial services you might wish to utilize.

In ShipStation API, when you see package, this refers to the LTL shipper's container type offerings. Likewise, accessorial services are simply referred to as options in ShipStation API.

Example Request & Response

GET /v-beta/ltl/carriers/:carrier_id

1
2
3
GET /v-beta/ltl/carriers/aed2a8c0-7998-4fef-9a82-2cab5f527dc2 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Example response:

{
"carriers": [
{
"carrier_id": "aed2a8c0-7998-4fef-9a82-2cab5f527dc2",
"countries": [
"CA",
"MX",
"US"
],
"credential_requirements": {},
"document_types": [
"bill_of_lading",
"delivery_receipt"
],
"features": [
"auto_pro",
"documents",
"quote",
"scheduled_pickup",
"spot_quote",
"tracking"
],
"name": "Test Carrier",
"options": [
{
"attributes": {
"name": {
"title": "Emergency Contact Name",
"type": "string"
},
"phone": {
"pattern": "([0-9]{10})",
"title": "Emergency Contact Phone Number",
"type": "string"
}
},
"code": "haz",
"features": [
"quote",
"spot_quote",
"scheduled_pickup"
],
"name": "Hazardous material"
},
{
"attributes": null,
"code": "ipu",
"features": [
"quote",
"spot_quote"
],
"name": "Inside pickup"
},
{
"attributes": null,
"code": "lftp",
"features": [
"quote",
"spot_quote",
"scheduled_pickup"
],
"name": "Lift gate required at pickup"
},
{
"attributes": null,
"code": "rep",
"features": [
"quote",
"spot_quote"
],
"name": "Residential pickup"
}
],
"packages": [
{
"code": "bag",
"features": [
"quote",
"spot_quote",
"scheduled_pickup"
],
"name": "Bag"
},
{
"code": "pal",
"features": [
"quote",
"spot_quote",
"scheduled_pickup"
],
"name": "Pail"
},
{
"code": "pcs",
"features": [
"quote",
"spot_quote",
"scheduled_pickup"
],
"name": "Piece"
},
{
"code": "pkg",
"features": [
"quote",
"spot_quote",
"scheduled_pickup"
],
"name": "Package"
},
{
"code": "skd",
"features": [
"quote",
"spot_quote",
"scheduled_pickup"
],
"name": "Skid"
}
],
"scac": "FAIL",
"services": [
{
"code": "gtd_am",
"features": [
"quote",
"spot_quote",
"scheduled_pickup"
],
"name": "Guaranteed Morning"
},
{
"code": "gtd_noon",
"features": [
"quote",
"spot_quote",
"scheduled_pickup"
],
"name": "Guaranteed Noon"
},
{
"code": "gtd_pm",
"features": [
"quote",
"spot_quote",
"scheduled_pickup"
],
"name": "Guaranteed End of Day"
},
{
"code": "stnd",
"features": [
"quote",
"spot_quote",
"scheduled_pickup"
],
"name": "Standard"
}
]
}
]
}