Item Options Subtab

The Item Options subtab consists of properties that control how item options and custom transaction line fields appear in your web store.

Show Only the Fields Listed In: Item Options and Custom Transaction Line Fields

This property works with:

  • SuiteCommerce Advanced – Elbrus and later

  • SuiteCommerce

This Boolean controls which item options and transaction line fields display in your web store. If you leave it unchecked (which is the default), all custom transaction line fields and item options display on your site. If you check it, only the fields listed in the Item Options and Custom Transaction Line Fields table on this subtab will appear.

More Information: Commerce Custom Fields

ID

ItemOptions.showOnlyTheListedOptions

UI location

Shopping Catalog > Item Options

JSON file

Item.Options.json

Item Options and Custom Transaction Line Fields

Note:

This set of properties is called Item Options in the Vinson release of SuiteCommerce Advanced.

This section explains how some custom fields show up in your web store. For SuiteCommerce and the Elbrus release of SuiteCommerce Advanced (SCA) and later, these properties include Item Options and Custom Transaction Line fields. For the SCA Vinson release and earlier, they only apply to Item Options. Each field listed in this table can contain the following properties:

  • Item Options ID (string) – the internal ID of the Custom Item Field being displayed. If you set it, this matches the ID field of the corresponding Custom Item Field record in NetSuite. This property is only valid for the Vinson release of SCA and earlier and isn't required.

  • Cart Option ID (string) – the internal ID of the Item Option you want to display. This matches the ID field of the Item Option record you want to display on your site. This property is required and used as the primary key.

  • Color Palette (string) – links a color label to its hexadecimal value. Item options and faceted navigation use this object.

  • Label (string) – sets the text of the item option displayed in the user interface.

  • URL Parameter Name (string) – sets the key of the option that appears in the URL. This property works with the Elbrus release and later.

  • Use Labels on URL (Boolean) – controls how the item option appears in the URL. If set to false (default), the URL displays the option’s Internal ID (for example, http://mysite.com/product/485?&color=1. If set to true, the URL contains the option's internal ID label. For example, http://mysite.com/product/485?&color=blue. This property works with the SCA Elbrus release and later.

  • Sort Index (integer) – sets where the option appears on the PDP. The lower the number, the sooner it displays in the custom field. If the Sort Index field is empty, its value is 0. This property works with the SCA Elbrus release and later.

  • Selector Template (string) – the template that displays the item option or transaction column field in the PDP and the Cart. This template provides the user with a means to select an option (for example, Item Color = Blue).

    The associated field uses this template instead of the default selector template (as defined in the Default Selector Templates by Item Option Type property defined elsewhere on this subtab).

  • Show Option in Item Lists (Boolean) – controls if the item option appears in the faceted search results page. This property works with the SCA Elbrus release and later.

  • Facet Cell Template (string) – sets the template used to display the item on the faceted search results page.

    The associated field uses this template instead of the default facet cell template (as defined in the Default Facet Cell Templates by Item Option Type property defined elsewhere on this subtab). This property works with the SCA Elbrus release and later.

  • Selected Template (string) – sets the template used to display the item option or transaction column field in Checkout and My Account.

    The associated field uses this template instead of the default selected template (as defined in the Default Selected Templates by Item Option Type property defined elsewhere on this subtab).

More Information: Commerce Custom Fields

IDs

ItemOptions.optionsConfiguration
ItemOptions.optionsConfiguration.cartOptionId
ItemOptions.optionsConfiguration.colors
ItemOptions.optionsConfiguration.label
ItemOptions.optionsConfiguration.urlParameterName
ItemOptions.optionsConfiguration.useLabelsOnUrl
ItemOptions.optionsConfiguration.index
ItemOptions.optionsConfiguration.templateSelector
ItemOptions.optionsConfiguration.showSelectorInList
ItemOptions.optionsConfiguration.templateFacetCell
ItemOptions.optionsConfiguration.templateSelected

IDs (Pre-Elbrus)

Note:

In the Vinson release of SCA, these properties are located on the Shopping tab and Item Options subtab.

itemOptions
itemOptions.itemOptionId
itemOptions.cartOptionId
itemOptions.colors
itemOptions.label
itemOptions.url
itemOptions.templateSelected

UI location

Shopping Catalog > Item Options

JSON file

Item.Options.json

Configuration file (pre-Vinson)

SC.Configuration.js

Related Topics

General Notices