Use this endpoint to return a list of advanced options available for a specific carrier_id.
- You will need a
carrier_idfor this request.
To retreive carrier IDs, use the List Carriers endpoint.
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
GET /v1/carriers/se-123890/options HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__Example Response
{
"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": ""
}
]
}