ItemOption

This object represents an option on an item.  See item configuration for details about options.

Local currency fields are only available to the REST API.

Field

Type

Description

name

string

Option name

selectedValue

string

Seleted value on the option

 

costIfSpecified

costIfSpecifiedLocalized

costIfSpecifiedLocalizedFormatted

number

number

string

Fee if specified

costPerLetter

costPerLetterLocalized

costPerLetterLocalizedFormatted

number

number

string

Fee per letter specified in a single or multiline option

costPerLine

costPerLineLocalized

costPerLineLocalizedFormatted

number

number

string

Fee per line of text specified in a multiline option

ignoreIfDefault

boolean

True if option will be ignored on the order if the default value is selected

optionOid

integer

A unique option object identifier. This is provided to easy debugging with UltraCart premium support.

oneTimeFee

boolean

True if the fee is only applied once (irregardless of quantity)

label

string

Option display label

required

boolean

True if required

type

string

Type of option. See OPTION_TYPE_ constants in the checkoutapi.js for a list of valid values.

values

ItemOptionValue[ ]

Values that the customer can select from for radio or drop down style options