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.
Common Accessorial Services
In the table below you will find accessorial services listed by their code. Support for accessorial services varies by carrier.
Code | Description |
---|---|
APTD | Appointment required at delivery. |
APTP | Appointment required at pickup. |
CBF | Cross Border Fee (Response only). |
CCS | CA Compliance Surcharge (Response only). |
CNSTD | Construction site delivery. |
CNSTP | Construction site pickup. |
COD | Collect on delivery. |
EBD | Tradeshow delivery. |
EBP | Tradeshow pickup. |
FSC | Fuel surcharge (Response only)Poisonous material |
GTD | Guaranteed service. (Response only) |
HAZ | Hazardous material. |
HCDA | High Cost Delivery Area (Response only). |
HCPA | High Cost Pickup Area (Response only). |
IDL | Inside delivery. |
INBD | In bond shipment. |
INS | Additional insurance/excess value. |
IPU | Inside pickup. |
LFTD | Lift gate required at delivery. |
LFTP | Lift gate required at pickup. |
LTDAD | Limited access delivery. |
LTDAP | Limited access pickup. |
MARK | Marked or tagged. |
MISC | Miscellaneous charge. Represents any carrier accessorial charges not mapped to a standardized code (Response only). |
MNC | Must notify consignee. |
OVR | Over dimension/excessive length. |
PPD | Perishables (food). |
PSC | Protective from cold. |
PSH | Protective from heat. |
PSN | Poisonous material. |
REP | Residential pickup. |
RES | Residential delivery. |
SLTDAD | Secured Limited access delivery. |
SLTDAP | Secured Limited access pickup. |
SRT | Sort and segregate. |
SS | Single Shipment. |
Response Body
The response object returned from sucessful requests to this endpoint will contain a list of options provided by a carrier. Each option will contain the parameters listed in the table below. To see a sample of a full response, see the Example Response section below.
Name | Type | Required | Description |
---|---|---|---|
attributes | object | Some carriers require additional supplemental information about an accessorial service like name or phone . These requirements are outlined here. | |
code | string | ✔ | The code for the accessorial service offered. |
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 accessorial service. |
Example Request
GET /v-beta/ltl/v1/carriers/:carrier_id/options