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:

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:

NameDescriptionAlgorithm 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 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.

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.
Did this help?

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 to get the algorithmId of the "Best sellers" algorithm.
  2. Call 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 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.
Did this help?