listAvailableAlgorithms( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Returns a list of recommendation algorithms that can be used on your Wix site or project. These algorithms can be used with 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.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read eCommerce - all read permissions
Learn more about permission scopes.
Method Declaration
This method does not take any parameters
Return Type:Promise<ListAvailableAlgorithmsResponse>
Was this helpful?