19 Configure Wish Lists

This section provides an overview of the wish list features in Retail Digital Commerce.

It describes how to implement and maintain wish lists for your store.

Understand Wish List Features

Wish lists provide shoppers with the following:

  • A way to create and manage a list of products they are considering buying. Included is the ability to save items in wish lists and purchase easily from them later.
  • The ability to create and manage multiple wish lists so shoppers can better organize items they may want to purchase.
  • The ability to share their wish lists.
  • The opportunity for shoppers to add comments to items in their wish lists.
  • A social experience where shoppers can receive feedback and suggestions from friends and family members they invite to their wish lists.
  • Email notifications for key wish list-related activities.

Registered shoppers can participate in a variety of wish list activities, including:

  • Creating wish lists with personalized names; the wish list privacy settings can be private, group, or shared. For more information, see Understand private, group, and shared wish list privacy settings.
  • Viewing up-to-date availability, price, and associated offers for the products included in a wish list.
  • Using an Add to Wish List button or selector on a product details page to choose which wish list to add the product to; at this point, a new wish list can also be created.
  • Adding a product from a wish list to a shopping cart for purchase.
  • Editing and deleting owned wish lists.
  • As a wish list owner: creating, editing, and deleting posts and comments.
  • As a wish list member: adding a comment, deleting his or her comments, and deleting product posts he or she added along with all associated comments.
  • Setting the priority and quantity for each product in a wish list.
  • Sorting posts by date added and priority.
  • Inviting friends to be a part of a wish list to encourage collaboration and feedback, and the sharing of products and gift ideas.
  • Moving product posts from one wish list to another. When moving the post, the shopper can also create a new wish list for the post.
  • Sharing wish list links via Facebook, Twitter, Pinterest, and email.

    If the Pinterest icon is not visible on the shopper wish list pages, in the Wish List layout, upgrade to the newest version of the Wish List Header widget.

  • Subscribing or unsubscribing from wish list email notification in his or her storefront My Account settings. For more information, see Enable wish list email settings.
  • Adding and changing wish list owner profile pictures; the pictures are visible next to comments made by the owner or member.
  • Receiving price change notifications on the product post.
  • Email notifications indicating the product price in the currency chosen in the storefront.

Each shopper profile can have up to 50 wish lists. Each wish list can The number of product posts, text posts, and comments on an individual post is set to 100 per wish list.

Understand Private, Group, and Shared wish List Privacy Settings

A wish list owner can choose to designate a wish list as private, group, or shared.

A private wish list is visible only to the wish list owner.

A group wish list is visible to the wish list owner and people they invite as members. Owners and members can perform the following tasks in a group wish list:

  • View the wish list.
  • Add products to the wish list and delete any products they added. Deleting a product post deletes all its associated comments.
  • Comment, delete, and edit their comments on a wish list; in addition, owners can delete any comments.

A shared wish list can be viewed by anyone who receives a link via Facebook, Twitter, Pinterest, or email. A wish list owner can share the link to any of their wish lists by clicking the Share button for Facebook, Twitter, Pinterest, or email. Once a wish list is shared, anyone with the link, whether logged in or anonymous, can also view the wish list. However, only members of the wish list can view, comment, delete, and add products to the wish list.

The link to a shared wish list can be passed on in other ways (for example, via private email) to other people. Anyone with the link can view the wish list. Members’ comments on a group wish list, as well as their names, become public if the owner designates the wish list as shared. Oracle strongly recommends you add text to your Terms of Use notifying your customers about this behavior.

A wish list owner can edit the privacy mode of a wish list at any time. Changing the privacy setting from Shared or Group to Private makes the wish list viewable only by the owner.

To edit from Shared or Group to Private, the owner must first delete all members from the wish list. However, once changed to Private, the wish list content is retained. Member names are noted as being no longer a member, and a generic profile picture is displayed.

Share using Email, Facebook, Pinterest, or Twitter

To accommodate social sharing on your site, do the following:

  1. Click the Settings icon, then click Setup.
  2. Click the URL Patterns tab.
  3. This step is optional if your URL patterns are correctly configured. On the URL Patterns page, for the Product Page URL, double-click the link in the Value column to open the New Value dialog. Edit the URL pattern using the available properties.

    URL patterns let you customize the URL structure for the different types of pages on your store. Select a page type and replace the components in the default pattern with values for a new custom pattern. For more information, see Enter basic store information.

    The new value will be applied to your product details pages once you click the check mark at the top of the dialog. Click the x to cancel.

  4. To add the social sharing links to your product details pages, in the administration interface, click Design.
  5. Click the Select Layout tab. Click Product, and then click Product Layout.
  6. Click the Grid View tab. In grid view, hover over the Product Details widget, and click the settings icon.
  7. Depending on the types of social sharing you want to make available to your shoppers, add the following elements to the page:
    • To add email, Facebook, and Twitter icon links to product detail pages, add the Social Sharing element.
    • To add email, Facebook, Twitter, and Pinterest icon links to the product detail pages, add the Social Sharing 2 element.
  8. Save your changes

For more information, see Work with layout components.

Shoppers can share a wish list link using email, Facebook, Pinterest, or Twitter by doing the following:

  1. If you have not already done so, set the privacy setting for the wish list to Shared. Make this change by doing one of the following:
    • Click the lock icon (Edit Wish List Settings) under the wish list name.
    • Click the Wish list actions arrow at the right side of the page, and click Edit.

    Privacy settings are made per wish list. Setting the privacy setting for one wish list does not affect the privacy setting for any other wish list.

  2. On the right-hand side of the page across from the Wish List Owner name, click the Share by email, Share on Facebook (if available), Share on Pinterest, or Share on Twitter icon.

    If the Facebook icon is absent to your shoppers, you must add a Facebook App Id by logging into the Commerce administration interface. See Configure Facebook access and announcements for more information. To display the Pinterest icon, place the latest version of the Wish List Header widget in the Wish List layout.

  3. Follow the instructions to log into the email service, Facebook, Pinterest, or X to send the link.

Understand Localization

Wish lists are localized as a part of the storefront localization. For more information, see Localize Your Store.

Implement Wish Lists

To use all the functionality of wish lists for your site, it is recommended you complete the following activities:

  • Tailor your wish list appearance to match the rest of your storefront, using the Design page in the administration interface. For example, wish lists inherit the global style settings for color, font, and page layout. For more information, see Design Your Store Layout.
  • Add a Facebook App ID.
  • Update the Wish List Header widget and Wish List Content widget in the Wish List layout.
  • To include the Pin It on Pinterest icon, on the Product layout, update the Add Product to Wish List widget. Include the Social Sharing 2 element in the Product Details widget.
  • To have price formatting and currency appear in email notifications, include the latest version of the Add Product to Wish List widget in the Product layout.
  • Enable email settings.
  • Update your email templates.
  • Edit and use wish list widget content (optional).

Configure Facebook Access and Announcements

Wish list owners and members can share links to products and invite friends via Facebook using their Facebook accounts.

To enable the Share Wish List on Facebook and Invite Facebook Friends features for your shoppers, do the following:

  1. Make sure you have a Facebook App ID. To obtain a Facebook App ID, you must have a Facebook account and register to become a Facebook developer.

    Facebook provides information on how to set up your site to allow sharing to Facebook. For more information, visit developers.facebook.com.

  2. Once you obtain a Facebook App ID, log into the Commerce administration interface.
  3. Click the Settings icon, then select Social Settings.
  4. In the Facebook App ID field, enter your ID, and click Save.
  5. To configure your Facebook app as a Canvas app, log into your Facebook merchant account.
  6. Create or edit your Canvas app, and enter the URL—https://[your storefront host name]/facebook/—as the Secure Canvas URL.

Enable Wish List Email Settings

For wish lists to function properly, enable wish list email types in the administration interface.

To enable wish list emails, see Configure Email Settings.

Upon initial setup, emails sent by wish lists are text only. However, you can download any of the wish list email templates, update them, use HTML, and then re-upload them to fit with your business environment and strategies. For more information, see Customize Email Templates.

Shoppers can opt to receive email notifications by doing one of the following:

  • Click the I want to get email updates check box when creating an account.
  • Click My Account > My Details, click Edit and select the I Want to Get Email checkbox. Click Save. My Wish List Setting is displayed. Under Email Notification Settings, click Yes for those emails they want to receive.

At any time, shoppers can edit the email notification settings in My Account.

The following table describes the types of email that are available for wish lists:

Email Type Description
Wish List New Comment Sent to all other members of a wish list when a member adds a comment to a product post. An email is not sent to the commenter.
Wish List New Member Sent to all current members of a wish list to introduce a new member; this email is not sent to the new member.
Wish List New Post

Sent to all other members of a wish list when a new product post is added to the wish list or a product is moved to an established or new wish list. If the product is already in the destination wish list, no email is sent.

A product post is added when a shopper clicks the Add to Wish List button or selector on a product details page. An email is not sent to the poster.

Additional Notification Email Template Properties

You can optionally use sections to add and organize related content if another section heading is needed.

Additional properties are available in the wish list notification email templates should you want to customize your emails. For details about accessing the templates, see Customize Email Templates.

You can make template changes for the following:

  • New comment email
    • Wish list owner profile image URL
    • Profile image URL of shopper who added a comment
    • Product title
    • Image URL of the product associated with the comment
    • First and last name of the shopper who created the post associated with the comment
    • Full name of the email recipient
  • New product post email

Ensure that the latest version of the Add Product to Wish List widget is added to the Product layout.

  • Current price (list price or sale price as applicable)
  • Profile image URL of shopper who added the product; if a profile image has not been selected, an image called no image is sent.
  • Profile image of wish list owner
  • Full name of the email recipient
  • New member email
  • Profile image URL of new member
  • Profile image URL of wish list owner
  • Full name of the email recipient

Note:

If no profile image has been set by the shopper, a generic image URL is displayed.

Additional Email Properties

You can add properties to the following wish list email templates:

  • Wish List New Comment
  • Wish List New Member
  • Wish List New Post

See Customize Email Templates to learn how to download and edit email templates.

Set up Wish Lists in a Multiple Site Environment

Wish lists are not shared among sites and must be configured on a per-site basis.

If your environment supports multiple sites where wish lists are configured, a registered shopper can create wish lists on more than one site, but each wish list can be accessed only from the store where it was created.

Note:

When you delete a site, its associated wish list environment is also deleted, along with its shopper content.

Follow these steps to configure a wish list for an existing site. (To learn how to create a site, see Define a site.)

  1. Click Settings icon, then select Setup.
  2. Select a site from the drop-down list.
  3. Click Save.
    This action connects the site to the Retail Digital Commerce servers hosting the site wish lists.
  4. (Optional) Click the Settings icon, then select Email Settingsto configure the Wish List New Comment, Wish List New Member, and Wish List New Post email notifications. For more information, see Enable wish list email settings.

Configure Wish Lists for OSF Applications

Retail Digital Commerce includes Open Storefront Application (OSF) widgets that let you add wish lists to your OSF applications.

Wish list plug-ins are included with Retail Digital Commerce, but they are not enabled and are not available by default in the reference application.

This section describes how to add wish list functionality to an OSF application. This section is intended for developers who want to use OSF to create Commerce storefront applications. The procedures in this section assume that you have set up a working OSF development environment and have created an application where you will add wish lists. For more information, see Understand the Open Storefront Framework.

Add Wishlist Package Dependencies to your Application

Retail Digital Commerce provides a read-only npm (Node Package Manager) registry that you can access to obtain OSF packages and their dependencies.

  1. Navigate to your <workspace-dir>/packages/apps/<appname> folder.
  2. Run the following commands:

    yarn add @oracle-cx-commerce/wishlist-endpoints

    yarn add @oracle-cx-commerce/wishlist-actions

    yarn install

  3. Ensure wishlist dependencies are installed to your local node_modules/@oracle-cx-commerce folder.

Add Wish List Plug-in Exports to your Application

You must export references that enable the application's endpoints to be accessed using dynamic imports.

  1. Navigate to your <workspace-dir>/packages/apps/<appname>/src/plugins/actions/index.js file and add the following line. Make sure this line appears above default exports:

    export * from '@oracle-cx-commerce/wishlist-actions'; //

  2. Navigate to your <workspace-dir>/packages/apps/<appname>/src/plugins/actions/meta.js file and add the following line. Make sure this line appears above default exports:

    export * from '@oracle-cx-commerce/wishlist-actions/meta'; //

  3. Navigate to <workspace-dir>/packages/apps/<appname>/src/plugins/endpoints/index.js file and add the following line. Make sure this line appears above default exports:

    export * from '@oracle-cx-commerce/wishlist-endpoints'; //

  4. Navigate to <workspace-dir>/packages/apps/<appname>/src/plugins/endpoints/meta.js file and add the following line. Make sure this line appears above default exports:

    export * from '@oracle-cx-commerce/wishlist-endpoints/meta'; //

Allow Shoppers to Move Items to a Wish List from the Cart

Once your OSF application has been built and deployed to the Retail Digital Commerce server environment, you can use the administration interface's Design page to enable the Move to Wish list functionality on the Cart page.

  1. Log into Retail Digital Commerce and click the Design icon in the main menu. In the top-right corner of the Design page, you should see a dropdown menu where you can select a deployed OSF application.
  2. Select your OSF application from the dropdown menu.
  3. Use the Filter Layouts field to search for the Cart Page layout and then open the Cart container.
  4. Click on Settings icon on the Cart Item Details layout.
  5. Click the Move to Wish List checkbox.
  6. Publish your changes.

Understand Wish List Layouts and Widgets

The wish list widgets let shoppers create and manage multiple wish lists. The OSF wish list widgets make use of the Retail Digital Commerce wish list service and interface with the corresponding Social Wish Lists API endpoints.

The wish list widgets let shoppers do the following tasks:

  • Create, edit, and delete wish lists with different privacy settings: Private (Only the owner can see and add to the list.), Group (Only the owner and people they invite can see, comment on, and add items to the list.), and Shared (Anyone with a link can see the list, but only the owner and people they invite can comment on and add items to the list.)
  • Add items from a product's Product Details Page to a new or existing wish list. (The default widgets do not support adding items to a wish list from the Product Listing Page, but you can extend them in your OSF workspace to add this functionality.)
  • Move items from a wish list to the cart or from the cart to a wish list.
  • Move items from one wish list to another.
  • Edit or delete wish list items.
  • Add comments to wish list items.
  • Share wish lists with other people via a link or invite them to a wish list, where they can also edit and comment on the list.

Note:

The default widgets do not support sharing via Facebook, Pinterest, or X, or receiving automatic price change notifications for products in a wish list. Default wish lists also do not show item availability (stock status). However, you can extend the widgets in your OSF workspace to add this functionality. The out-of-the-box OSF wish list implementation also does not currently allow the wish list owner to manage wish list settings.

Retail Digital Commerce includes the following wish list layouts:

  • Wish Lists
  • Wish List Details
  • Retail Digital Commerce includes the following wish list widgets:
  • Add to Wish List (Add this to the Product Details container)
  • Wish List Details
  • Wish Lists
  • Wish List Breadcrumbs

Detailed information about each widget's code, including actions, selectors, fetchers, and endpoints, is available in the JS API documentation that you can download from Oracle Customer Connect.