Wishlist Subtab

The Product Lists (Wishlists) feature lets customers create and manage shopping lists on your site. The settings on the Wishlist subtab let you set up options for product lists.

For information about product lists, see Product Lists.

Enable Modifications by Customers

This Boolean controls whether users can make their own lists.

  • By default this Boolean is enabled, so customers can create, edit, and delete their own lists on product list pages or when adding an item.

  • After this Boolean is disabled, customers can't create their own lists. They'll only see your store's predefined lists, including the default My List.

ID

productList.additionEnabled

UI location

Shopping > Wishlist

JSON file

ProductList.json

Configuration file (pre-Vinson)

SC.Configuration.MyAccount.js

Note:

Logged-in customers and their contacts can view both predefined and custom lists.

Login Required

This Boolean controls whether users need to 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 lets you set up predefined lists (templates) that are automatically available to your customers. Customers can't edit or delete these lists. By default, all customers receive a predefined list called My List. When a customer adds an item to the list, the system creates the required records.

Each product list contains the following properties:

  • Template ID (string) – the internal ID for this template. Make sure it's unique.

  • Name (string) – the list name as it appears to customers.

  • Description (string) – the list description in the user interface.

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

  • Scope Name (string) – indicates 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) – the internal type ID.

  • Type Name (string) – sets the list as default, predefined, later, or quote. All lists added by a customer are automatically set to default. Predefined lists are available to all customers. Lists set to Save for later let customers add items to a list for a later purchase. Lists set to Quote let customers request a quote for a list of items.

For more information about save for 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 lets you choose how product list items display on the My Account page. You can display items in different formats, like a condensed list without images or a list with images. By default, both condensed and list views are included. Each display modality contains the following properties:

  • ID (string) – the display modality ID.

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

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

  • Icon (string) – the item icon.

  • Is Default (Boolean) – sets 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

General Notices