Introduction

The Recommendations API allows you to promote and recommend items to site visitors. You can retrieve item recommendations from catalogs on a site using algorithms provided by apps installed on the site.

With the Recommendations API, you can:

Algorithms

Algorithms are programs that analyze catalog data and return a list of recommended items.

How algorithms and catalogs work together

For the Recommendations API, there are two key concepts:

  • Algorithms - Programs that generate recommendations.
  • Catalogs - Collections of items, such as store products or booking services.

An algorithm can support catalogs from the same app that provides it, or it can support catalogs from other apps. For example, an algorithm provided by App A could generate recommendations for items in App B's catalog, as long as both apps are installed on the site.

Note: Currently, Wix Stores is the only app built by Wix that provides algorithms, and its algorithms only support Wix Stores catalogs.

When you call List Available Algorithms, each algorithm in the return value includes:

  • appId: The app that provides the algorithm.
  • catalogAppIds: The apps whose catalogs this algorithm can work with.
  • config: The algorithm's configuration. This includes the ID, name, type, description, and any additional information.

Algorithms have an algorithmType that determines what parameters you need to specify in the Get Recommendation request:

  • RELATED_ITEMS: Requires at least 1 catalog item in the items array, such as a product the visitor is currently viewing. Returns recommendations related to those items. For example, products frequently bought together with the provided product.
  • GLOBAL: No catalog items required. Returns recommendations based on site-wide data. For example, best-selling products across the entire catalog.

Wix Stores provides the following algorithms:

NameIDAlgorithm Type
"From similar categories"68ebce04-b96a-4c52-9329-08fc9d8c1253RELATED_ITEMS
"Frequently bought together"d5aac1e1-2e53-4d11-85f7-7172710b4783RELATED_ITEMS
"Frequently viewed together"5dd69f67-9ab9-478e-ba7c-10c6c6e7285fRELATED_ITEMS
"Best sellers"ba491fd2-b172-4552-9ea6-7202e01d1d3cGLOBAL

Call List Available Algorithms to get the full description of each algorithm.

Before you begin

  • The Wix user must install an app built by Wix that provides algorithms on their site.
  • The Wix user must install an app whose catalog is supported by the algorithm.
  • No caching is implemented. This means repeat calls take the same time to complete as the initial call.

Use cases

Terminology

  • Catalog: A set of products or services available for purchase in a Wix site. For example, a set of products in Wix Stores.
  • Algorithm: A program implemented by an app that returns a list of item recommendations.
Did this help?