ItemOptionValue

This object represents an option value on one of the items in the shopping cart.  Option values are usually used to provide a dropdown list of choices for the customer to select when choosing item options.  See item configuration for instruction on setting up item options.

Local currency fields are only available in the REST API.

Field

Type

Description

value

string

Value of the option

 
baseCurrencyCodestringThe default currency of the merchant.

additionalCost

additionalCostLocalized

additionalCostLocalizedFormatted

number

Additional cost the customer will pay if they select this option

additionalWeight

Weight

Additioanl weight included in the order if they select this option

currencyCodestringThe current currency of the shopping cart.

defaultValue

boolean

True if this option value should be the default

displayOrder

integer

Order in quick the options should be displayed. Lower display orders should come first.