Introduction

The Recommendations API allows users to promote and recommend items to their customers. Items are selected from catalogs in installed Wix apps by algorithms also provided by installed Wix apps. Users can choose algorithms from among those available to get the types of recommendations they need. For example, an algorithm could provide a list of bestselling items, or items frequently bought together with some specified item/s.

With the Recommendations API, you can:

• Get a list of recommendation algorithms available for use on your Wix site or project.
• Get a list of recommended items given one or more algorithms

Before you begin

• You must have an app installed on your project that implements the Recommendations Provider SPI and provides algorithms. You must also have an app installed whose catalogs those algorithms can apply to. (Currently, in both cases, this is only Wix Stores.)
• Algorithms can only be applied to catalogs they support. To find out which catalogs an algorithm supports, call List Available Algorithms and check the catalogAppIds.

Terminology

• Algorithm: Code that is used to identify and return items from a catalog based on some defined criteria, such as which items have the highest number of sales. Algorithms may take a list of products as input and use them in their calculations.
• Catalog: A set of products or services defined in a Wix App. In this documentation, we refer to these products or services generally as “items”.

Setup

To use the Recommendations API, install the @wix/ecom package using npm or Yarn:

npm install @wix/ecom

or

yarn add @wix/ecom

Then import { recommendations } from @wix/ecom:

import { recommendations } from "@wix/ecom";