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 Carrier Advanced Options

Use this endpoint to return a list of advanced options available for a specific carrier_id.

Requirements

  • You will need a carrier_id for this request.
    To retreive carrier IDs, use the List Carriers endpoint.

Example Request & Response

This example uses UPS as the carrier, to demonstrate a range of possible (but not exhaustive) list of advanced options.

GET /v1/carriers/:carrier_id/options

1
2
3
GET /v1/carriers/se-123890/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
{
"options": [
{
"name": "bill_to_account",
"default_value": "",
"description": ""
},
{
"name": "bill_to_country_code",
"default_value": "",
"description": ""
},
{
"name": "bill_to_party",
"default_value": "",
"description": ""
},
{
"name": "bill_to_postal_code",
"default_value": "",
"description": ""
},
{
"name": "contains_alcohol",
"default_value": "false",
"description": ""
},
{
"name": "non_machinable",
"default_value": "false",
"description": ""
},
{
"name": "saturday_delivery",
"default_value": "false",
"description": ""
},
{
"name": "delivered_duty_paid",
"default_value": "false",
"description": ""
}
]
}