Wishlist Subtab

The Product Lists (Wishlists) feature lets users create and manage lists of items to be purchased from your Commerce website. The settings on the Wishlist subtab under Shopping specify properties related to product lists.

For information about product lists, see Product Lists.

Enable Modifications by Customers

This Boolean controls whether users can create custom lists.

  • By default this Boolean is enabled, letting users create custom lists by adding them on the product list pages or creating them when adding an item to a list. Users can edit and delete custom lists that they add.

  • When this Boolean is disabled, users cannot create custom lists. The only lists available are the predefined lists for your store. All stores have one default predefined list called My List.

ID

productList.additionEnabled

UI location

Shopping > Wishlist

JSON file

ProductList.json

Configuration file (pre-Vinson)

SC.Configuration.MyAccount.js

Note:

The logged in customer, as well as any contact attached to that customer, can view predefined and custom lists.

Login Required

This Boolean specifies if users must be logged in to edit a product list.

ID

productList.loginRequired

UI location

Shopping > Wishlist

JSON file

ProductList.json

Configuration file (pre-Vinson)

SC.Configuration.MyAccount.js

List Templates

This array specifies the predefined lists (templates) that are automatically available to your users. Product lists defined here are predefined by default, meaning the user cannot edit or delete them. By default, a single predefined list, My List, is available. Associated records are created when a user adds an item to the list.

Each product list contains the following properties:

  • Template ID (string) – specifies the internal identifier for this template. Ensure that this value is unique.

  • Name (string) – specifies the name of the list that appears in the user interface.

  • Description (string) – specifies a description of the list that appears in the user interface.

  • Scope ID (number) – specifies the internal scope ID.

  • Scope Name (string) – specifies whether the list is public or private. Currently, only private lists are supported, and each list is set to private by default.

  • Type ID (string) – specifies the internal type ID.

  • Type Name (string) – defines the list as default, predefined, later, or quote. All lists added by a user are automatically set to default. Predefined lists are automatically available to your users. Lists set to later let users add items to a list for a later purchase. Lists set to quote let users request a quote for a list of items.

For more information about the later and quote types, see Save For Later and Quotes for Commerce Websites.

IDs

productList.listTemplates
productList.listTemplates.templateId
productList.listTemplates.name
productList.listTemplates.description
productList.listTemplates.scopeId
productList.listTemplates.scopeName
productList.listTemplates.typeId
productList.listTemplates.typeName

UI location

Shopping > Wishlist

ID (pre-Vinson)

product_lists_templates

JSON file

ProductList.json

Configuration file (pre-Vinson)

SC.Configuration.MyAccount.js

Display Modalities for Product List Items

This array specifies display options for product list items in the My Account page. You can display items in various formats in a similar way to viewing items in the product display pages. For example, users can view items in a condensed list without images or in a list layout with images. By default, the condensed and list views are included. Each display modality contains the following properties:

  • ID (string) – specifies the display modality ID.

  • Name (string) – specifies the description of the modality.

  • Columns (number) – specifies the number of columns in the product list.

  • Icon (string) – specifies the item icon.

  • Is Default (Boolean) – specifies the default modality.

IDs

productList.templates
productList.templates.id
productList.templates.name
productList.templates.columns
productList.templates.isDefault

UI location

Shopping > Wishlist

ID (pre-Vinson)

product_lists_templates

JSON file

ProductList.json

Configuration file (pre-Vinson)

SC.Configuration.MyAccount.js

Related Topics

Shopping Tab
Quick Order Subtab
Reviews Subtab

General Notices