Skip to main content

This complex type contains information about a shipping option that can be purchased in addition to the base shipping cost of a recommended rate. Additional options for each rate are defined, named, and offered by the selected shipping carrier. Examples include shipping insurance or the requirement for a recipient signature.

Types that use AdditionalOption

CreateShipmentFromQuoteRequestPurchasedRateRate

Calls that use AdditionalOption

POST
/shipment/{shipmentId}/cancel
POST
/shipment/create_from_shipping_quote
GET
/shipment/{shipmentId}
POST
/shipping_quote
GET
/shipping_quote/{shippingQuoteId}

Fields

Field
Type
Description
additionalCost
Amount
The monetary cost of the additional shipping option identified by the optionType field.
optionType
string
The name of a shipping option that can be purchased in addition to the base shipping cost of this rate. The value supplied in this field must match exactly the option name as supplied by the selected rate.