GET

List Available Algorithms


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 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 listed here.

Permissions
Manage eCommerce - all permissions
Read eCommerce - all read permissions
Manage Stores - all permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/v1/recommendations/algorithms

Request
This endpoint does not take any parameters.
Response Object
availableAlgorithmsArray <AlgorithmInfo>maxItems 500

Algorithms available for use on your Wix site or project. See the method description for more information.

List Available Algorithms Example 1
Request
cURL
curl GET 'www.wixapis.com/ecom/v1/recommendations/algorithms' \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "availableAlgorithms": [ { "config": { "id": "e33f5e32-d1a2-4944-b38f-d29b7d5ef4ef", "name": "Frequently bought together", "description": "This gallery works best when added to the product page, cart and thank you page. \n\nIf there’s not enough data about products frequently bought together, we’ll display other related products instead.", "algorithmType": "RELATED_ITEMS" }, "appId": "72454cb3-90b5-4cef-bbff-cc61aea02584", "catalogAppIds": [ "d4bc3347-5a0a-4303-81d9-27293be54aa3", "8fb80dea-fcd5-410b-a0f3-af553d0bd85e" ] }, { "config": { "id": "6768b44a-6130-46b8-89af-4222e15ba765", "name": "Frequently viewed together", "description": "This gallery works best when added to the product page, cart and thank you page.\n\nIf there’s not enough data about products frequently viewed together, we’ll display other related products instead.", "algorithmType": "RELATED_ITEMS" }, "appId": "72454cb3-90b5-4cef-bbff-cc61aea02584", "catalogAppIds": [ "d4bc3347-5a0a-4303-81d9-27293be54aa3", "8fb80dea-fcd5-410b-a0f3-af553d0bd85e" ] }, { "config": { "id": "115518d6-3dbb-41cd-86fd-7b6841433da2", "name": "Best sellers", "description": "We’ll automatically display your store’s best selling products.\n\nIf there’s not enough data about your best selling products, we’ll show related products or your All Products collection.", "algorithmType": "GLOBAL" }, "appId": "72454cb3-90b5-4cef-bbff-cc61aea02584", "catalogAppIds": [ "d4bc3347-5a0a-4303-81d9-27293be54aa3", "8fb80dea-fcd5-410b-a0f3-af553d0bd85e" ] }, { "config": { "id": "17635deb-6a7d-412f-aeb6-3f8c8507800a", "name": "From the same collections", "description": "This gallery works best when added to the product page, cart and thank you page.\n\nIf there’s not enough data about products that share the same collections, we’ll display your All Products collection instead.", "additionalInfo": "We’ll display products that share the most collections with the existing products on the page.", "algorithmType": "RELATED_ITEMS" }, "appId": "72454cb3-90b5-4cef-bbff-cc61aea02584", "catalogAppIds": [ "d4bc3347-5a0a-4303-81d9-27293be54aa3", "8fb80dea-fcd5-410b-a0f3-af553d0bd85e" ] } ] }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?