Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

# Introduction
The Recommendations API allows users to promote and recommend items to their customers.  Users can get item recommendations from catalogs on their site using algorithms provided by installed apps. 

>**Note:** Currently, the Recommendations API is for use with Wix Stores only.

With the Recommendations API, you can:
* Get a [list of algorithms](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d9c288b-bebc-4735-aaa8-4ce311c4a76dslug::list-available-algorithms*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/list-available-algorithms) available for use on your site.
* Get a [list of recommended items](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d9c288b-bebc-4735-aaa8-4ce311c4a76dslug::get-recommendation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/get-recommendation) suggested by a given algorithm.


## Algorithms
Algorithms are programs that identify and return a set of item recommendations based on a catalog. There are different types of algorithms, identified by their `algorithmType` that calculate different kinds of recommendations. For example, Algorithms with the `algorithmType` of `RELATED_ITEMS` also take a list of items as input and use those to calculate recommendations.

For example, Wix Stores provides the following algorithms:
| Name                         | Description                                                                        | Algorithm Type  |
|------------------------------|------------------------------------------------------------------------------------|-----------------|
| “From the same categories”   | Returns items that share the most categories with items in the list provided.      | `RELATED_ITEMS` |
| “Frequently bought together” | Returns items that are frequently bought together with the first item in the list provided. | `RELATED_ITEMS` |
| “Frequently viewed together” | Returns items that are frequently viewed together with the first item in the list provided. | `RELATED_ITEMS` |
| “Best sellers”               | Returns the items from the catalog with the highest number of sales.               | `GLOBAL`        |



## Before you begin
* You must have a Wix app that provides algorithms installed on your site, and you must have a Wix app whose catalogs are supported by those algorithms installed on your site. For more information see the [List Available Algorithms](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d9c288b-bebc-4735-aaa8-4ce311c4a76dslug::list-available-algorithms*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/list-available-algorithms) method. Currently, the only app providing algorithms and their supported catalogs is Wix Stores.
* No caching is implemented, so repeat calls take the same time to complete as the first call.

## Use cases
[Show bestselling products from a Wix site in your app.](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d9c288b-bebc-4735-aaa8-4ce311c4a76dslug::sample-flow*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/sample-flow)

## Terminology
* **Catalog:** A set of products or services available for purchase in a Wix app. For example, a set of products in Wix Stores.
* **Algorithm:** A program implemented by a Wix app, such as Wix Stores, which returns a list of item recommendations.


# Sample Flows
This article shares a possible use case your app could support, as well as an example flow that could support the use case. You're certainly not limited to this use case, but it may be a helpful jumping-off point as you plan your app's implementation.


## Show bestselling products from a Wix site in your app
In this scenario, you are selling products through multiple channels, one of which is a website using Wix Stores. You want your app to showcase the bestselling items from each of your channels. To show the bestselling items from the Wix Stores catalog in your app, follow this basic flow:

1. Call [`List Available Algorithms`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d9c288b-bebc-4735-aaa8-4ce311c4a76dslug::list-available-algorithms*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/list-available-algorithms) to get the `algorithmId` of the "Best sellers" algorithm.
2. Call [`Get Recommendation`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d9c288b-bebc-4735-aaa8-4ce311c4a76dslug::get-recommendation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/get-recommendation) with the `algorithmId` from step 1. Use the Wix Stores app ID (`215238eb-22a5-4c36-9e7b-e7c08025e04e`) in the algorithm object.
3. For each item in the object returned by `Get Recommendation`, call [`Get Product`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::f4df6095-927c-469f-8541-d1dd0d33f547slug::get-product*fallback::https://dev.wix.com/docs/rest/api-reference/wix-stores/catalog/get-product) in the Wix Stores Catalog API using the recommended item’s `catalogItemId`.
4. Using the product information in the responses from `Get Product`, display the bestselling items in your app.


Used for grouping line items and is sent on add to cart

ID of the app providing the catalog. For items from Wix apps, the following values always apply:
+ Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
+ Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`

appId

ID of the item within its Wix or 3rd-party catalog. For example, `productId` for Wix Stores or `bookingId` for Wix Bookings.

catalogItemId

Additional info in key:value pairs. For example, to specify Wix Stores product options or variants:
+ `{"options": {"options": {"Size": "M", "Color": "Red"}}}`
+ `{"options": {"variantId": "<VARIANT_ID>"}}`

options

CatalogReference

values

ListValue

NullValue

value

StringValue

fields

Struct

Value

boolValue

listValue

nullValue

numberValue

stringValue

structValue

kind

Returns a list of recommendation algorithms that can be used on your Wix site or project. These algorithms can be used with [Get Recommendation](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/get-recommendation) 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 <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>.

Read eCommerce - all read permissions

ListAvailableAlgorithms

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

Get Recommendation determines which items to recommend based on the given recommendation algorithms.

Get Recommendation 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 [List Available Algorithms](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/list-available-algorithms).

Get Recommendation operates as follows:
1. Get Recommendation 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. Get Recommendation 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. Get Recommendation 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 Get Recommendation stops calling other apps.
5. If none of the algorithms run by the first app meet the minimum recommended items, Get Recommendation 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, Get Recommendations returns an empty array.