Site Logo

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.

CodeDescription
APTDAppointment required at delivery.
APTPAppointment required at pickup.
CBFCross Border Fee (Response only).
CCSCA Compliance Surcharge (Response only).
CNSTDConstruction site delivery.
CNSTPConstruction site pickup.
CODCollect on delivery.
EBDTradeshow delivery.
EBPTradeshow pickup.
FSCFuel surcharge (Response only)Poisonous material
GTDGuaranteed service. (Response only)
HAZHazardous material.
HCDAHigh Cost Delivery Area (Response only).
HCPAHigh Cost Pickup Area (Response only).
IDLInside delivery.
INBDIn bond shipment.
INSAdditional insurance/excess value.
IPUInside pickup.
LFTDLift gate required at delivery.
LFTPLift gate required at pickup.
LTDADLimited access delivery.
LTDAPLimited access pickup.
MARKMarked or tagged.
MISCMiscellaneous charge. Represents any carrier accessorial charges not mapped to a standardized code (Response only).
MNCMust notify consignee.
OVROver dimension/excessive length.
PPDPerishables (food).
PSCProtective from cold.
PSHProtective from heat.
PSNPoisonous material.
REPResidential pickup.
RESResidential delivery.
SLTDADSecured Limited access delivery.
SLTDAPSecured Limited access pickup.
SRTSort and segregate.
SSSingle 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.

NameTypeRequiredDescription
attributesobjectSome carriers require additional supplemental information about an accessorial service like name or phone. These requirements are outlined here.
codestringThe code for the accessorial service offered.
featureslistThis is a list of which endpoints where these accessorial services may be used.
namestringThe name or short description of the accessorial service.

Example Request

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

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

Example Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
{
"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"
}
]
}