List Carrier Advanced Options

tip

Requirements

  • This lesson assumes you have know how to List Your Carriers.
  • You will need a carrier_id for this request.

Example

GET /v1/carriers/:carrier_id/options

For this example, we're using a UPS carrier account to show the options (since they have more to show).

curl -iX GET https://api.shipengine.com/v1/carriers/se-123890/options \
-H 'Content-Type: application/json' \
-H 'API-Key: __YOUR_API_KEY_HERE__'
{
  "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": ""
    }
  ]
}