Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

A list of algorithms checked in a specific order determined by their `appID` and their position in the `algorithms` array.
See the method description for more information.

If no algorithm is able to return at least `minimumRecommendedItems` items, an empty array is returned.

algorithms

options

GetRecommendationOptions

Returns a recommendation object containing a list of items to recommend to the customer.

`getRecommendation()` determines which items to recommend based on the given recommendation algorithms.

`getRecommendation()` doesn’t run the algorithms. It calls the installed apps that provide them.

Apps may provide algorithms for use with their own catalogs, or for use with catalogs from other apps.
For example, Wix Stores provides algorithms that can only be used on its own catalogs.
To run an algorithm, the app providing it must be installed, and an app providing a supported catalog must be installed.
For more information and to see which algorithms are available on your site or project, call [`listAvailableAlgorithms()`](#listavailablealgorithms).

`getRecommendation()` operates as follows:
1. `getRecommendation()` receives as input a list of algorithms as an array. These algorithms can be provided by different apps and can apply to different catalogs.
2. `getRecommendation()` calls the app that corresponds to the `appId` of the first algorithm in the list of algorithms. It passes that algorithm’s ID and the IDs of any subsequent algorithms in the array for the same app.
3. The app runs the algorithms.
4. `getRecommendation()` returns items recommendations from the first algorithm (according to its position in the `algorithms` array) that meets the minimum number of recommendations. At that point `getRecommendation()` stops calling other apps.
5. If none of the algorithms run by the first app meet the minimum recommended items, `getRecommendation()` finds the next algorithm in the array with a new `appId` (an ID of an app that has not yet been called), and repeats the process.
6. If no algorithms in the `algorithms` array recommend at least the minimum recommended items, `getRecommendation()` returns an empty array.

import { createClient, OAuthStrategy } from '@wix/sdk';
import { recommendations } from '@wix/ecom';

const wixClient = createClient({
  modules: { recommendations } ,
  auth: OAuthStrategy({ clientId: 'MY-CLIENT-ID' })
});

async function getRecommendation(algorithms, options) {
  const response = await wixClient.recommendations.getRecommendation(algorithms, options);
}

getRecommendation() with visitor/member access

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { recommendations } from '@wix/ecom';

const wixClient = createClient({
  modules: { recommendations },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function getRecommendation(algorithms, options) {
  const response = await wixClient.recommendations.getRecommendation(algorithms, options);
}

getRecommendation() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { recommendations } from '@wix/ecom';

const wixClient = createClient({
  modules: { recommendations },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function getRecommendation(algorithms, options) {
  const response = await wixClient.recommendations.getRecommendation(algorithms, options);
}

getRecommendation() with Dashboard app access

getRecommendation

GetRecommendationResponse

Returns a list of recommendation algorithms that can be used on your Wix site or project. These algorithms can be used with [`getRecommendation()`](#getRecommendation) to provide item recommendations to the customer.

Algorithms are run by the apps that provide them, and can only be used on catalogs they support. Apps may provide algorithms for use with their own catalogs and/or catalogs from other apps.

The app which provides an algorithm is referenced by that algorithm’s `appId`. The apps whose catalogs are supported by an algorithm are referenced by the IDs in that algorithm’s `catalogAppIds` array.


For an algorithm to be considered “Available” and returned in this method’s response, the algorithm must meet the following conditions:
1. The algorithm’s `appId` must match the ID of an installed Wix app.
2. At least 1 of the IDs in `catalogAppIds` must match the ID of an installed Wix app.

Wix app IDs are [listed here](https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions).

import { createClient, OAuthStrategy } from '@wix/sdk';
import { recommendations } from '@wix/ecom';

const wixClient = createClient({
  modules: { recommendations } ,
  auth: OAuthStrategy({ clientId: 'MY-CLIENT-ID' })
});

async function listAvailableAlgorithms() {
  const response = await wixClient.recommendations.listAvailableAlgorithms();
}

listAvailableAlgorithms() with visitor/member access

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { recommendations } from '@wix/ecom';

const wixClient = createClient({
  modules: { recommendations },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function listAvailableAlgorithms() {
  const response = await wixClient.recommendations.listAvailableAlgorithms();
}

listAvailableAlgorithms() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { recommendations } from '@wix/ecom';

const wixClient = createClient({
  modules: { recommendations },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function listAvailableAlgorithms() {
  const response = await wixClient.recommendations.listAvailableAlgorithms();
}

listAvailableAlgorithms() with Dashboard app access

listAvailableAlgorithms

ListAvailableAlgorithmsResponse

# Introduction

<br/>

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”.


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

or

```console
yarn add @wix/ecom
```

Then import `{ recommendations }` from `@wix/ecom`:

```js
import { recommendations } from '@wix/ecom'
```
  

ecom_recommendations

Algorithm

Algorithm ID defined by the app providing the algorithm.

string

App ID of the Wix or 3rd-party app providing the algorithm.

Wix app IDs are <a href="https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions" target="_blank">listed here</a>.

appId

AlgorithmConfig

Algorithm ID. This must be unique for a specific app but does not have to be unique across all apps on the site or in the project.

A supplemental `description`. It can be used to help break up and organize information. You can, for example, display this information as a tooltip or as an additional section that is collapsed by default.

additionalInfo

Algorithms may have the following types:
* `RELATED_ITEMS` - This type of algorithm provides recommendations based on 1 or more other provided items. For example, when an item is added to a cart, the algorithm can suggest other items frequently bought together with that item.
* `GLOBAL` - This type of algorithm provides general recommendations based on site or project statistics. For example, bestsellers or new arrivals.

algorithmType

AlgorithmType

Algorithm description. This describes how the algorithm works and if it has any limitations regarding site content, number of items in the catalog, site traffic, and so on. This value is not translatable.

description

Algorithm name. This value is not translatable.

name

AlgorithmInfo

The app ID of the application providing the algorithm.

Wix app IDs are <a href="https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions" target="_blank">listed here</a>.

App IDs of catalogs to which the algorithm can be applied.

Wix app IDs are <a href="https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions" target="_blank">listed here</a>.

catalogAppIds

config

CatalogReference

ID of the app providing the catalog.

You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).

For items from Wix catalogs, the following values always apply:
+ Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
+ Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
+ Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`

ID of the item within the catalog it belongs to.

catalogItemId

Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.

For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).

Algorithms available for use on your Wix site or project. See the method description for more information.

Setup