List Accessorial Services

This API endpoint can be used to retrieve a list of accessorial services for a particular carrier. Accessorial services include things like providing a lift gate or performing an inside pickup. These extra services are referred to as options in ShipEngine API to streamline the terminology used across different types of shipping carriers.

Carrier IDs

Each of your LTL carriers has a unique carrier_id in ShipEngine. You can use this carrier_id for many other ShipEngine endpoints to indicate which account to use. For this endpoint, you may optionally pass the carrier_id to get details on a single carrier.

Example Request

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

GET /v-beta/ltl/carriers/car_NJuhsfkKkuxChJNtX6X5kJKKY7/options HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Example Response

{
  "options": [
    {
      "code": "haz",
      "name": "Hazardous material",
      "attributes": {
        "name": {
          "type": "string",
          "title": "Emergency Contact Name"
        },
        "phone": {
          "type": "string",
          "title": "Emergency Contact Phone Number",
          "pattern": "([0-9]{10})"
        }
      }
    },
    {
      "code": "ipu",
      "name": "Inside pickup"
    },
    {
      "code": "lftp",
      "name": "Lift gate required at pickup"
    },
    {
      "code": "rep",
      "name": "Residential pickup"
    }
  ]
}