{"id":"6e7703f6-a1cb-4c11-b6af-be9547f3de18","createdDate":"2023-12-25T07:37:58.015Z","updatedDate":"2023-12-25T07:37:58.015Z","resourceId":"4d9c288b-bebc-4735-aaa8-4ce311c4a76d","api":{"schema":{"object":{"displayName":"Recommendation Object","description":"","slug":"recommendation-object","$ref":"#/components/schemas/com.wix.ecom.recommendations.v1.Recommendation","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/ecom.git"},"methods":[{"summary":"List Available Algorithms","description":"Returns a list of recommendation algorithms that can be used on your Wix site or project. These algorithms can be used with [Get Recommendation](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/get-recommendation) to provide item recommendations to the customer.\n\nAlgorithms are run by the apps that provide them, and can only be used on catalogs they support.\nApps may provide algorithms for use with their own catalogs and/or catalogs from other apps.\n\nThe app which provides an algorithm is referenced by that algorithm’s `appId`.\nThe apps whose catalogs are supported by an algorithm are referenced by the IDs in that algorithm’s `catalogAppIds` array.\n\nFor an algorithm to be considered “Available” and returned in this method’s response, the algorithm must meet the following conditions:\n1. The algorithm’s `appId` must match the ID of an installed Wix app.\n2. At least 1 of the IDs in `catalogAppIds` must match the ID of an installed Wix app.\n\nWix app IDs are listed here.","operationId":"com.wix.ecom.recommendations.v1.RecommendationsService.ListAvailableAlgorithms","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.ecom.recommendations.v1.ListAvailableAlgorithmsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/v1/recommendations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/v1/recommendations","destinationPath":"/v1/recommendations","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/ecom/v1/recommendations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/recommendations","destinationPath":"/v1/recommendations","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.ecom.recommendations.v1.RecommendationsService","errors":[],"exposure":"PUBLIC","permissions":["RECOMMENDATIONS.READ"],"externalPermissionScopes":[{"name":"Read eCommerce - all read permissions","scopeId":"SCOPE.DC-ECOM-MEGA.READ-ECOM"}],"protoArtifactId":"com.wixpress.ecom.recommendations:recommendations-service","serviceArtifactId":"com.wixpress.ecom.recommendations.recommendations-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.recommendations.v1.ListAvailableAlgorithmsRequest","responseMessage":"com.wix.ecom.recommendations.v1.ListAvailableAlgorithmsResponse"},"legacyExamples":[{"name":"ListAvailableAlgorithms","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl GET 'www.wixapis.com/ecom/v1/recommendations/algorithms' \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"availableAlgorithms\": [\n {\n \"config\": {\n \"id\": \"e33f5e32-d1a2-4944-b38f-d29b7d5ef4ef\",\n \"name\": \"Frequently bought together\",\n \"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.\",\n \"algorithmType\": \"RELATED_ITEMS\"\n },\n \"appId\": \"72454cb3-90b5-4cef-bbff-cc61aea02584\",\n \"catalogAppIds\": [\n \"d4bc3347-5a0a-4303-81d9-27293be54aa3\",\n \"8fb80dea-fcd5-410b-a0f3-af553d0bd85e\"\n ]\n },\n {\n \"config\": {\n \"id\": \"6768b44a-6130-46b8-89af-4222e15ba765\",\n \"name\": \"Frequently viewed together\",\n \"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.\",\n \"algorithmType\": \"RELATED_ITEMS\"\n },\n \"appId\": \"72454cb3-90b5-4cef-bbff-cc61aea02584\",\n \"catalogAppIds\": [\n \"d4bc3347-5a0a-4303-81d9-27293be54aa3\",\n \"8fb80dea-fcd5-410b-a0f3-af553d0bd85e\"\n ]\n },\n {\n \"config\": {\n \"id\": \"115518d6-3dbb-41cd-86fd-7b6841433da2\",\n \"name\": \"Best sellers\",\n \"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.\",\n \"algorithmType\": \"GLOBAL\"\n },\n \"appId\": \"72454cb3-90b5-4cef-bbff-cc61aea02584\",\n \"catalogAppIds\": [\n \"d4bc3347-5a0a-4303-81d9-27293be54aa3\",\n \"8fb80dea-fcd5-410b-a0f3-af553d0bd85e\"\n ]\n },\n {\n \"config\": {\n \"id\": \"17635deb-6a7d-412f-aeb6-3f8c8507800a\",\n \"name\": \"From the same collections\",\n \"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.\",\n \"additionalInfo\": \"We’ll display products that share the most collections with the existing products on the page.\",\n \"algorithmType\": \"RELATED_ITEMS\"\n },\n \"appId\": \"72454cb3-90b5-4cef-bbff-cc61aea02584\",\n \"catalogAppIds\": [\n \"d4bc3347-5a0a-4303-81d9-27293be54aa3\",\n \"8fb80dea-fcd5-410b-a0f3-af553d0bd85e\"\n ]\n }\n ]\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v1/recommendations/algorithms","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.ecom.recommendations.v1.RecommendationsService","errors":[],"exposure":"PUBLIC","permissions":["RECOMMENDATIONS.READ"],"externalPermissionScopes":[{"name":"Read eCommerce - all read permissions","scopeId":"SCOPE.DC-ECOM-MEGA.READ-ECOM"}],"protoArtifactId":"com.wixpress.ecom.recommendations:recommendations-service","serviceArtifactId":"com.wixpress.ecom.recommendations.recommendations-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.recommendations.v1.ListAvailableAlgorithmsRequest","responseMessage":"com.wix.ecom.recommendations.v1.ListAvailableAlgorithmsResponse"},"legacyExamples":[{"name":"ListAvailableAlgorithms","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl GET 'www.wixapis.com/ecom/v1/recommendations/algorithms' \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"availableAlgorithms\": [\n {\n \"config\": {\n \"id\": \"e33f5e32-d1a2-4944-b38f-d29b7d5ef4ef\",\n \"name\": \"Frequently bought together\",\n \"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.\",\n \"algorithmType\": \"RELATED_ITEMS\"\n },\n \"appId\": \"72454cb3-90b5-4cef-bbff-cc61aea02584\",\n \"catalogAppIds\": [\n \"d4bc3347-5a0a-4303-81d9-27293be54aa3\",\n \"8fb80dea-fcd5-410b-a0f3-af553d0bd85e\"\n ]\n },\n {\n \"config\": {\n \"id\": \"6768b44a-6130-46b8-89af-4222e15ba765\",\n \"name\": \"Frequently viewed together\",\n \"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.\",\n \"algorithmType\": \"RELATED_ITEMS\"\n },\n \"appId\": \"72454cb3-90b5-4cef-bbff-cc61aea02584\",\n \"catalogAppIds\": [\n \"d4bc3347-5a0a-4303-81d9-27293be54aa3\",\n \"8fb80dea-fcd5-410b-a0f3-af553d0bd85e\"\n ]\n },\n {\n \"config\": {\n \"id\": \"115518d6-3dbb-41cd-86fd-7b6841433da2\",\n \"name\": \"Best sellers\",\n \"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.\",\n \"algorithmType\": \"GLOBAL\"\n },\n \"appId\": \"72454cb3-90b5-4cef-bbff-cc61aea02584\",\n \"catalogAppIds\": [\n \"d4bc3347-5a0a-4303-81d9-27293be54aa3\",\n \"8fb80dea-fcd5-410b-a0f3-af553d0bd85e\"\n ]\n },\n {\n \"config\": {\n \"id\": \"17635deb-6a7d-412f-aeb6-3f8c8507800a\",\n \"name\": \"From the same collections\",\n \"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.\",\n \"additionalInfo\": \"We’ll display products that share the most collections with the existing products on the page.\",\n \"algorithmType\": \"RELATED_ITEMS\"\n },\n \"appId\": \"72454cb3-90b5-4cef-bbff-cc61aea02584\",\n \"catalogAppIds\": [\n \"d4bc3347-5a0a-4303-81d9-27293be54aa3\",\n \"8fb80dea-fcd5-410b-a0f3-af553d0bd85e\"\n ]\n }\n ]\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"List Available Algorithms","slugifiedName":"list-available-algorithms"},"permissionScopes":[{"name":"Read eCommerce - all read permissions","scopeId":"SCOPE.DC-ECOM-MEGA.READ-ECOM"}]},{"summary":"Get Recommendation","description":"Returns a recommendation object containing a list of items to recommend to the customer.\n\nGet Recommendation determines which items to recommend based on the given recommendation algorithms.\n\nGet Recommendation doesn’t run the algorithms. It calls the installed apps that provide them.\n\nApps may provide algorithms for use with their own catalogs, or for use with catalogs from other apps.\nFor example, Wix Stores provides algorithms that can only be used on its own catalogs.\nTo run an algorithm, the app providing it must be installed, and an app providing a supported catalog must be installed.\nFor more information and to see which algorithms are available on your site or project, call [List Available Algorithms](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/list-available-algorithms).\n\nGet Recommendation operates as follows:\n1. Get Recommendation receives as input a list of algorithms as an array. These algorithms can be provided by different apps and can apply to different catalogs.\n2. Get Recommendation calls the app that corresponds to the `appId` of the first algorithm in the list of algorithms. It passes that algorithm’s ID and the IDs of any subsequent algorithms in the array for the same app.\n3. The app runs the algorithms.\n4. Get Recommendation returns items recommendations from the first algorithm (according to its position in the `algorithms` array) that meets the minimum number of recommendations. At that point Get Recommendation stops calling other apps.\n5. If none of the algorithms run by the first app meet the minimum recommended items, Get Recommendation finds the next algorithm in the array with a new `appId` (an ID of an app that has not yet been called), and repeats the process.\n6. If no algorithms in the `algorithms` array recommend at least the minimum recommended items, Get Recommendations returns an empty array.","operationId":"com.wix.ecom.recommendations.v1.RecommendationsService.GetRecommendation","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.ecom.recommendations.v1.GetRecommendationResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/v1/recommendations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/v1/recommendations","destinationPath":"/v1/recommendations","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/ecom/v1/recommendations","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/recommendations","destinationPath":"/v1/recommendations","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"GetRecommendationRequest","description":"","properties":{"items":{"title":"items","description":"The set of items for which to get recommendations. Required if the `algorithmType` is `RELATED_ITEMS`.","maxItems":300,"type":"array","items":{"$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.CatalogReference"},"x-wix-docs":{"exposure":"PUBLIC"}},"algorithms":{"title":"algorithms","description":"A list of algorithms checked in a specific order determined by their `appID` and their position in the `algorithms` array.\nSee the method description for more information.\n\nIf no algorithm is able to return at least `minimumRecommendedItems` items, an empty array is returned.","minItems":1,"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.recommendations.v1.Algorithm"},"x-wix-docs":{"exposure":"PUBLIC"}},"minimumRecommendedItems":{"title":"minimumRecommendedItems","description":"The minimum number of items that must be recommended by the algorithm for those items to be returned in the response.\n\nMax: `100`","minimum":0,"maximum":100,"type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["algorithms","algorithms.id","algorithms.appId","items.appId","items.catalogItemId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.ecom.recommendations.v1.RecommendationsService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ITEM_APP_ID_NOT_SUPPORTED","errorSchemaName":"com.wix.ecom.recommendations.v1.ItemAppIdNotSupportedByProvider"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ALGORITHM_NOT_SUPPORTED","errorSchemaName":"com.wix.ecom.recommendations.v1.RecommendationAlgorithmNotSupported"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"RECOMMENDATIONS_PROVIDER_NOT_FOUND"}],"exposure":"PUBLIC","permissions":["RECOMMENDATIONS.READ"],"externalPermissionScopes":[{"name":"Read eCommerce - all read permissions","scopeId":"SCOPE.DC-ECOM-MEGA.READ-ECOM"}],"protoArtifactId":"com.wixpress.ecom.recommendations:recommendations-service","serviceArtifactId":"com.wixpress.ecom.recommendations.recommendations-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.recommendations.v1.GetRecommendationRequest","responseMessage":"com.wix.ecom.recommendations.v1.GetRecommendationResponse"},"legacyExamples":[{"name":"GetRecommendation","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl POST 'www.wixapis.com/ecom/v1/recommendations/get' \\\n-H 'Content-Type: application/json;charset=UTF-8' \\\n-H 'Authorization: ' \\\n--data-binary '{\n \"items\": [\n {\n \"catalogItemId\": \"ec7914e8-208b-0069-5850-1a965643508d\",\n \"appId\": \"f29c9b39-1090-4d9b-8e3a-a3a681a57970\"\n }\n ],\n \"algorithms\": [\n {\n \"id\": \"e33f5e32-d1a2-4944-b38f-d29b7d5ef4ef\",\n \"appId\": \"72454cb3-90b5-4cef-bbff-cc61aea02584\"\n },\n {\n \"id\": \"09dc98e8-8696-49f7-833a-bab57f516f88\",\n \"appId\": \"b0933968-e643-4835-a403-de8e1eb4d33c\"\n }\n ],\n \"minimumRelatedItems\": 1\n}'\n~~~","response":"~~~json\n{\n \"recommendation\": {\n \"items\": [\n {\n \"catalogItemId\": \"1ce6198f-5fad-5ac9-5b36-ecb2175929ef\",\n \"appId\": \"f29c9b39-1090-4d9b-8e3a-a3a681a57970\"\n },\n {\n \"catalogItemId\": \"efd0b233-8f8e-b6b8-b5f3-66903caa8558\",\n \"appId\": \"f29c9b39-1090-4d9b-8e3a-a3a681a57970\"\n },\n {\n \"catalogItemId\": \"58a7ab15-5c65-d836-7934-86f78b17996b\",\n \"appId\": \"f29c9b39-1090-4d9b-8e3a-a3a681a57970\"\n },\n {\n \"catalogItemId\": \"040528a7-7256-7875-c8e4-8976d949f66b\",\n \"appId\": \"f29c9b39-1090-4d9b-8e3a-a3a681a57970\"\n },\n {\n \"catalogItemId\": \"11e2ffb7-2520-3c21-051e-1f05486b9061\",\n \"appId\": \"f29c9b39-1090-4d9b-8e3a-a3a681a57970\"\n },\n {\n \"catalogItemId\": \"e8f9c6d5-4ddd-36dd-f595-fe7bfd7891e2\",\n \"appId\": \"f29c9b39-1090-4d9b-8e3a-a3a681a57970\"\n },\n {\n \"catalogItemId\": \"16694dd9-ab43-7c5b-974e-e15a4297f235\",\n \"appId\": \"f29c9b39-1090-4d9b-8e3a-a3a681a57970\"\n },\n {\n \"catalogItemId\": \"593c5cd0-4996-2a8a-ad34-7669f266c42e\",\n \"appId\": \"f29c9b39-1090-4d9b-8e3a-a3a681a57970\"\n },\n {\n \"catalogItemId\": \"51c819a7-9380-1748-d761-b0bb25d175c2\",\n \"appId\": \"f29c9b39-1090-4d9b-8e3a-a3a681a57970\"\n }\n ],\n \"algorithm\": {\n \"id\": \"e33f5e32-d1a2-4944-b38f-d29b7d5ef4ef\",\n \"appId\": \"72454cb3-90b5-4cef-bbff-cc61aea02584\"\n }\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/recommendations/get","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.ecom.recommendations.v1.RecommendationsService","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ITEM_APP_ID_NOT_SUPPORTED","errorSchemaName":"com.wix.ecom.recommendations.v1.ItemAppIdNotSupportedByProvider"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ALGORITHM_NOT_SUPPORTED","errorSchemaName":"com.wix.ecom.recommendations.v1.RecommendationAlgorithmNotSupported"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"RECOMMENDATIONS_PROVIDER_NOT_FOUND"}],"exposure":"PUBLIC","permissions":["RECOMMENDATIONS.READ"],"externalPermissionScopes":[{"name":"Read eCommerce - all read permissions","scopeId":"SCOPE.DC-ECOM-MEGA.READ-ECOM"}],"protoArtifactId":"com.wixpress.ecom.recommendations:recommendations-service","serviceArtifactId":"com.wixpress.ecom.recommendations.recommendations-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.recommendations.v1.GetRecommendationRequest","responseMessage":"com.wix.ecom.recommendations.v1.GetRecommendationResponse"},"legacyExamples":[{"name":"GetRecommendation","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl POST 'www.wixapis.com/ecom/v1/recommendations/get' \\\n-H 'Content-Type: application/json;charset=UTF-8' \\\n-H 'Authorization: ' \\\n--data-binary '{\n \"items\": [\n {\n \"catalogItemId\": \"ec7914e8-208b-0069-5850-1a965643508d\",\n \"appId\": \"f29c9b39-1090-4d9b-8e3a-a3a681a57970\"\n }\n ],\n \"algorithms\": [\n {\n \"id\": \"e33f5e32-d1a2-4944-b38f-d29b7d5ef4ef\",\n \"appId\": \"72454cb3-90b5-4cef-bbff-cc61aea02584\"\n },\n {\n \"id\": \"09dc98e8-8696-49f7-833a-bab57f516f88\",\n \"appId\": \"b0933968-e643-4835-a403-de8e1eb4d33c\"\n }\n ],\n \"minimumRelatedItems\": 1\n}'\n~~~","response":"~~~json\n{\n \"recommendation\": {\n \"items\": [\n {\n \"catalogItemId\": \"1ce6198f-5fad-5ac9-5b36-ecb2175929ef\",\n \"appId\": \"f29c9b39-1090-4d9b-8e3a-a3a681a57970\"\n },\n {\n \"catalogItemId\": \"efd0b233-8f8e-b6b8-b5f3-66903caa8558\",\n \"appId\": \"f29c9b39-1090-4d9b-8e3a-a3a681a57970\"\n },\n {\n \"catalogItemId\": \"58a7ab15-5c65-d836-7934-86f78b17996b\",\n \"appId\": \"f29c9b39-1090-4d9b-8e3a-a3a681a57970\"\n },\n {\n \"catalogItemId\": \"040528a7-7256-7875-c8e4-8976d949f66b\",\n \"appId\": \"f29c9b39-1090-4d9b-8e3a-a3a681a57970\"\n },\n {\n \"catalogItemId\": \"11e2ffb7-2520-3c21-051e-1f05486b9061\",\n \"appId\": \"f29c9b39-1090-4d9b-8e3a-a3a681a57970\"\n },\n {\n \"catalogItemId\": \"e8f9c6d5-4ddd-36dd-f595-fe7bfd7891e2\",\n \"appId\": \"f29c9b39-1090-4d9b-8e3a-a3a681a57970\"\n },\n {\n \"catalogItemId\": \"16694dd9-ab43-7c5b-974e-e15a4297f235\",\n \"appId\": \"f29c9b39-1090-4d9b-8e3a-a3a681a57970\"\n },\n {\n \"catalogItemId\": \"593c5cd0-4996-2a8a-ad34-7669f266c42e\",\n \"appId\": \"f29c9b39-1090-4d9b-8e3a-a3a681a57970\"\n },\n {\n \"catalogItemId\": \"51c819a7-9380-1748-d761-b0bb25d175c2\",\n \"appId\": \"f29c9b39-1090-4d9b-8e3a-a3a681a57970\"\n }\n ],\n \"algorithm\": {\n \"id\": \"e33f5e32-d1a2-4944-b38f-d29b7d5ef4ef\",\n \"appId\": \"72454cb3-90b5-4cef-bbff-cc61aea02584\"\n }\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Recommendation","slugifiedName":"get-recommendation"},"permissionScopes":[{"name":"Read eCommerce - all read permissions","scopeId":"SCOPE.DC-ECOM-MEGA.READ-ECOM"}]}],"webhooks":[],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Introduction\nThe 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. \n\n>**Note:** Currently, the Recommendations API is for use with Wix Stores only.\n\nWith the Recommendations API, you can:\n* Get a [list of algorithms](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d9c288b-bebc-4735-aaa8-4ce311c4a76dslug::list-available-algorithms*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/list-available-algorithms) available for use on your site.\n* Get a [list of recommended items](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d9c288b-bebc-4735-aaa8-4ce311c4a76dslug::get-recommendation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/get-recommendation) suggested by a given algorithm.\n\n\n## Algorithms\nAlgorithms 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.\n\nFor example, Wix Stores provides the following algorithms:\n| Name | Description | Algorithm Type |\n|------------------------------|------------------------------------------------------------------------------------|-----------------|\n| “From the same categories” | Returns items that share the most categories with items in the list provided. | `RELATED_ITEMS` |\n| “Frequently bought together” | Returns items that are frequently bought together with the first item in the list provided. | `RELATED_ITEMS` |\n| “Frequently viewed together” | Returns items that are frequently viewed together with the first item in the list provided. | `RELATED_ITEMS` |\n| “Best sellers” | Returns the items from the catalog with the highest number of sales. | `GLOBAL` |\n\n\n\n## Before you begin\n* 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](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d9c288b-bebc-4735-aaa8-4ce311c4a76dslug::list-available-algorithms*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/list-available-algorithms) method. Currently, the only app providing algorithms and their supported catalogs is Wix Stores.\n* No caching is implemented, so repeat calls take the same time to complete as the first call.\n\n## Use cases\n[Show bestselling products from a Wix site in your app.](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d9c288b-bebc-4735-aaa8-4ce311c4a76dslug::sample-flow*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/sample-flow)\n\n## Terminology\n* **Catalog:** A set of products or services available for purchase in a Wix app. For example, a set of products in Wix Stores.\n* **Algorithm:** A program implemented by a Wix app, such as Wix Stores, which returns a list of item recommendations.\n","sourceRepo":"git@github.com:wix-private/ecom.git","path":"proto/docs/README.md"},{"displayName":"Sample Flow","slugifyName":"sample-flow","content":"# Sample Flows\nThis 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.\n\n\n## Show bestselling products from a Wix site in your app\nIn 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:\n\n1. Call [`List Available Algorithms`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d9c288b-bebc-4735-aaa8-4ce311c4a76dslug::list-available-algorithms*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/list-available-algorithms) to get the `algorithmId` of the \"Best sellers\" algorithm.\n2. Call [`Get Recommendation`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d9c288b-bebc-4735-aaa8-4ce311c4a76dslug::get-recommendation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/get-recommendation) with the `algorithmId` from step 1. Use the Wix Stores app ID (`215238eb-22a5-4c36-9e7b-e7c08025e04e`) in the algorithm object.\n3. For each item in the object returned by `Get Recommendation`, call [`Get Product`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::f4df6095-927c-469f-8541-d1dd0d33f547slug::get-product*fallback::https://dev.wix.com/docs/rest/api-reference/wix-stores/catalog/get-product) in the Wix Stores Catalog API using the recommended item’s `catalogItemId`.\n4. Using the product information in the responses from `Get Product`, display the bestselling items in your app.\n","sourceRepo":"git@github.com:wix-private/ecom.git","path":"proto/docs/sample-flow.md"}],"components":{"schemas":{"com.wix.ecom.recommendations.v1.Recommendation":{"type":"object","properties":{"items":{"title":"items","description":"Recommended items.","maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.CatalogReference"},"x-wix-docs":{"exposure":"PUBLIC"}},"algorithm":{"$ref":"#/components/schemas/com.wix.ecom.recommendations.v1.Algorithm","summary":"algorithm","description":"The algorithm used to provide the recommendation.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Recommendation","description":""},"com.wix.ecommerce.catalog_spi.api.v1.CatalogReference":{"type":"object","properties":{"catalogItemId":{"title":"catalogItemId","description":"ID of the item within its Wix or 3rd-party catalog. For example, `productId` for Wix Stores or `bookingId` for Wix Bookings.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"appId":{"title":"appId","description":"ID of the app providing the catalog. For items from Wix apps, the following values always apply:\n+ Wix Stores: `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n+ Wix Bookings: `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`","minLength":1,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"options":{"title":"options","description":"Additional info in key:value pairs. For example, to specify Wix Stores product options or variants:\n+ `{\"options\": {\"options\": {\"Size\": \"M\", \"Color\": \"Red\"}}}`\n+ `{\"options\": {\"variantId\": \"\"}}`","type":"object","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CatalogReference","description":"Used for grouping line items and is sent on add to cart"},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"title":"fields","description":"","type":"object","format":"map","properties":{"key:value":{"type":"object","description":"\"key\" of type string, \"value\" of type object","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"title":"nullValue","description":"","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC"}},"numberValue":{"title":"numberValue","description":"","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"stringValue":{"title":"stringValue","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"boolValue":{"title":"boolValue","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"structValue":{"title":"structValue","description":"","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"listValue":{"title":"listValue","description":"","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"title":"values","description":"","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListValue","description":""},"com.wix.ecom.recommendations.v1.Algorithm":{"type":"object","properties":{"id":{"title":"id","description":"Algorithm ID defined by the app providing the algorithm.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"appId":{"title":"appId","description":"App ID of the Wix or 3rd-party app providing the algorithm.\n\nWix app IDs are listed here.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Algorithm","description":""},"com.wix.ecom.recommendations.v1.ListAvailableAlgorithmsRequest":{"type":"object","properties":{},"title":"ListAvailableAlgorithmsRequest","description":""},"com.wix.ecom.recommendations.v1.ListAvailableAlgorithmsResponse":{"type":"object","properties":{"availableAlgorithms":{"title":"availableAlgorithms","description":"Algorithms available for use on your Wix site or project. See the method description for more information.","maxItems":500,"type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.recommendations.v1.AlgorithmInfo"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListAvailableAlgorithmsResponse","description":""},"com.wix.ecom.recommendations.v1.AlgorithmInfo":{"type":"object","properties":{"config":{"$ref":"#/components/schemas/com.wix.ecom.recommendations.spi.AlgorithmConfig","summary":"config","description":"How the algorithm is configured.","x-wix-docs":{"exposure":"PUBLIC"}},"appId":{"title":"appId","description":"The app ID of the application providing the algorithm.\n\nWix app IDs are listed here.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"catalogAppIds":{"title":"catalogAppIds","description":"App IDs of catalogs to which the algorithm can be applied.\n\nWix app IDs are listed here.","minItems":1,"maxItems":100,"minLength":1,"maxLength":36,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AlgorithmInfo","description":""},"com.wix.ecom.recommendations.spi.AlgorithmConfig":{"type":"object","properties":{"id":{"title":"id","description":"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.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"title":"name","description":"Algorithm name. This value is not translatable.","minLength":1,"maxLength":50,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"description":{"title":"description","description":"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.","minLength":1,"maxLength":500,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"additionalInfo":{"title":"additionalInfo","description":"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.","minLength":1,"maxLength":300,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"algorithmType":{"title":"algorithmType","description":"Algorithms may have the following types:\n* `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.\n* `GLOBAL` - This type of algorithm provides general recommendations based on site or project statistics. For example, bestsellers or new arrivals.","type":"string","$ref":"#/components/schemas/com.wix.ecom.recommendations.spi.AlgorithmType","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AlgorithmConfig","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StringValue","description":""},"com.wix.ecom.recommendations.spi.AlgorithmType":{"type":"string","description":"","title":"AlgorithmType","enum":["UNSPECIFIED","RELATED_ITEMS","GLOBAL"]},"com.wix.ecom.recommendations.v1.GetRecommendationRequest":{"type":"object","properties":{"items":{"title":"items","description":"The set of items for which to get recommendations. Required if the `algorithmType` is `RELATED_ITEMS`.","maxItems":300,"type":"array","items":{"$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.CatalogReference"},"x-wix-docs":{"exposure":"PUBLIC"}},"algorithms":{"title":"algorithms","description":"A list of algorithms checked in a specific order determined by their `appID` and their position in the `algorithms` array.\nSee the method description for more information.\n\nIf no algorithm is able to return at least `minimumRecommendedItems` items, an empty array is returned.","minItems":1,"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.recommendations.v1.Algorithm"},"x-wix-docs":{"exposure":"PUBLIC"}},"minimumRecommendedItems":{"title":"minimumRecommendedItems","description":"The minimum number of items that must be recommended by the algorithm for those items to be returned in the response.\n\nMax: `100`","minimum":0,"maximum":100,"type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetRecommendationRequest","description":""},"com.wix.ecom.recommendations.v1.GetRecommendationResponse":{"type":"object","properties":{"recommendation":{"$ref":"#/components/schemas/com.wix.ecom.recommendations.v1.Recommendation","summary":"recommendation","description":"An object containing a list of items recommended by 1 of the specified algorithms. The recommendation is empty if none of the specified algorithms recommended enough items.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetRecommendationResponse","description":""},"com.wix.ecom.recommendations.v1.ItemAppIdNotSupportedByProvider":{"type":"object","properties":{"items":{"title":"items","description":"Items with an App ID not supported by the provider. Supported App IDs can be found in the provider config in the Dev Center.","minItems":1,"maxItems":300,"type":"array","items":{"$ref":"#/components/schemas/com.wix.ecommerce.catalog_spi.api.v1.CatalogReference"},"x-wix-docs":{"exposure":"PUBLIC"}},"algorithms":{"title":"algorithms","description":"Algorithms that don't support the requested items.","minItems":1,"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.recommendations.v1.Algorithm"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ItemAppIdNotSupportedByProvider","description":""},"com.wix.ecom.recommendations.v1.RecommendationAlgorithmNotSupported":{"type":"object","properties":{"unsupportedAlgorithms":{"title":"unsupportedAlgorithms","description":"Algorithms not supported by the provider.","minItems":1,"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.recommendations.v1.Algorithm"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"RecommendationAlgorithmNotSupported","description":""}}},"title":"Recommendation","description":"","fqdn":"wix.ecom.recommendations.v1.recommendation"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Introduction\nThe 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. \n\n>**Note:** Currently, the Recommendations API is for use with Wix Stores only.\n\nWith the Recommendations API, you can:\n* Get a [list of algorithms](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d9c288b-bebc-4735-aaa8-4ce311c4a76dslug::list-available-algorithms*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/list-available-algorithms) available for use on your site.\n* Get a [list of recommended items](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d9c288b-bebc-4735-aaa8-4ce311c4a76dslug::get-recommendation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/get-recommendation) suggested by a given algorithm.\n\n\n## Algorithms\nAlgorithms 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.\n\nFor example, Wix Stores provides the following algorithms:\n| Name | Description | Algorithm Type |\n|------------------------------|------------------------------------------------------------------------------------|-----------------|\n| “From the same categories” | Returns items that share the most categories with items in the list provided. | `RELATED_ITEMS` |\n| “Frequently bought together” | Returns items that are frequently bought together with the first item in the list provided. | `RELATED_ITEMS` |\n| “Frequently viewed together” | Returns items that are frequently viewed together with the first item in the list provided. | `RELATED_ITEMS` |\n| “Best sellers” | Returns the items from the catalog with the highest number of sales. | `GLOBAL` |\n\n\n\n## Before you begin\n* 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](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d9c288b-bebc-4735-aaa8-4ce311c4a76dslug::list-available-algorithms*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/list-available-algorithms) method. Currently, the only app providing algorithms and their supported catalogs is Wix Stores.\n* No caching is implemented, so repeat calls take the same time to complete as the first call.\n\n## Use cases\n[Show bestselling products from a Wix site in your app.](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d9c288b-bebc-4735-aaa8-4ce311c4a76dslug::sample-flow*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/sample-flow)\n\n## Terminology\n* **Catalog:** A set of products or services available for purchase in a Wix app. For example, a set of products in Wix Stores.\n* **Algorithm:** A program implemented by a Wix app, such as Wix Stores, which returns a list of item recommendations.\n"},{"displayName":"Sample Flow","slugifyName":"sample-flow","content":"# Sample Flows\nThis 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.\n\n\n## Show bestselling products from a Wix site in your app\nIn 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:\n\n1. Call [`List Available Algorithms`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d9c288b-bebc-4735-aaa8-4ce311c4a76dslug::list-available-algorithms*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/list-available-algorithms) to get the `algorithmId` of the \"Best sellers\" algorithm.\n2. Call [`Get Recommendation`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d9c288b-bebc-4735-aaa8-4ce311c4a76dslug::get-recommendation*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/recommendations/get-recommendation) with the `algorithmId` from step 1. Use the Wix Stores app ID (`215238eb-22a5-4c36-9e7b-e7c08025e04e`) in the algorithm object.\n3. For each item in the object returned by `Get Recommendation`, call [`Get Product`](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::f4df6095-927c-469f-8541-d1dd0d33f547slug::get-product*fallback::https://dev.wix.com/docs/rest/api-reference/wix-stores/catalog/get-product) in the Wix Stores Catalog API using the recommended item’s `catalogItemId`.\n4. Using the product information in the responses from `Get Product`, display the bestselling items in your app.\n"}]},"reviewStatus":"APPROVED","isLocked":true}