By implementing the Recommendations Service Plugin (formerly SPI), you can integrate your service with Wix to provide advanced recommendation algorithms that allow Wix merchants to provide tailored product recommendations to their customers.
The integration process involves creating an app and configuring the Recommendations service plugin extension.
With this service plugin, you can design your app to deliver tailored recommendations across various content types, such as products, services, events, or any combination the above. For example, you can:
When your app implementing the Recommendations service plugin is installed on a Wix site, the recommendation algorithms it supports become accessible through the Recommendations API.
Learn more about service plugin extensions.
Algorithms select items to recommend from their supported catalogs. The apps providing these supported algorithms must be installed on the Wix site before you can start using the Recommendations service plugin on this site.
Follow these steps to begin implementing your service plugin.
You can implement this service plugin with the following frameworks:
To configure and customize your plugin, you need to provide important information in the service plugin configuration file. You can configure your plugin in the Wix Dev Center or CLI. For details, see Recommendations Extension Configuration.
| Name | Type | Description |
|---|---|---|
deploymentUri | string | Required. Base URI for your service's endpoints. Wix appends the endpoint path to the base URI. For example, to call the Get Recommendations endpoint at https://my-recommendation.com/v1/get-recommendations, the base URI you provide here is https://my-recommendation.com/. |
catalogAppIds | Array | Required. App IDs of supported catalogs. The following are Wix apps that provide catalogs and their app IDs: Wix Stores: "215238eb-22a5-4c36-9e7b-e7c08025e04e" Wix Bookings: "13d21c63-b5ec-5912-8397-c3a5ddb27a97" Wix Restaurants: "9a5d83fd-8570-482e-81ab-cfa88942ee60" |
supportedAlgorithms | Array | Required. Recommendation algorithms implemented by the app. See the table below for details on the structure of the supportedAlgorithms object. |
componentName | string | Required. A unique name for this component. This is an internal name that will only appear in the app dashboard. |
supportedAlgorithms properties| Property | Type | Description |
|---|---|---|
reserved | int | Reserved field with a value of 1. |
name | string | Required. Algorithm name. This value is not translatable. |
description | string | Required. 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. |
additionalInfo | google.protobuf.StringValue | 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. |
algorithmType | enum | 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. |
algorithmId | string | Required. 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. |
To configure and customize your service plugin, you need to provide important details in the plugin.json configuration file.
If you created your service plugin extension with the CLI, required fields are automatically populated for you.
App IDs of catalogs for which recommended items can be found.
URI where the application implementing the SPI is deployed.
The algorithms that this application can use to calculate item recommendations.