List Services | ShipEngine
🎉 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 Services
Use this endpoint to retrieve a list of service levels offered by a particular carrier. Service levels include things like standard delivery and guaranteed end of day delivery.
Requirements
- The unique
carrier_idfor the LTL carrier. This ID represents your connection with a specific carrier and it is generated and returned when you connect a carrier account.
You may also retrieve carrier connection information including the carrier_id from our List Connected Carriers endpoint.
Response Body
The response object returned from successful requests to this endpoint will contain a list of services offered by a carrier. Each service will contain the parameters from the below table:
| Name | Type | Required | Description |
|---|---|---|---|
code |
string | ✔ | The code for the type of service offered by the carrier. |
features |
list | ✔ | This is a list of which endpoints where these accessorial services may be used. |
name |
string | ✔ | The name or short description of the service. |
Example Request & Response
GET /v-beta/ltl/carriers/:carrier_id/services
GET /v-beta/ltl/carriers/car_NJuhsfkKkuxChJNtX6X5kJKKY7/services HTTP/1.1
Example response:
{
"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"
}
]
}