There is the possibility to recommend the customer the most related product or service based on customer purchasing behavior. The product recommendation helps you guide customers on the products they should buy based on his previous shopping tendencies or shopping cart content. CareCloud Recommendation engine enables the personalization of content by listing the most likely items of high value to the customer based on his previous shopping behaviour or actual shopping cart content. The most typical use cases are recommendations at any customer touchpoint, such as POS, e-shop, e-mail, mobile app etc.
Available methods for the resource recommendation-engine.
| HTTP method | Endpoint | Description |
|---|---|---|
| [badge-blue GET] | /recommendation-engine/product/actions/eliminate | Use this method to select the most related products recommended to the customer from the initial list (best matching products first). The results depend on the customer's previous shopping behaviour. It excludes all products that do not match the customer preferences (depending on the customer's previous shopping behaviour). This method may return less product IDs than in the initial list or no products depending on the initial list (if less or no product matches the customer's preferences). |
| [badge-blue GET] | /recommendation-engine/product/actions/order | Use this method to get the most related products from the initial list sorted by the algorithm (best matching products first). The results depend on the customer's previous shopping behaviour. You can limit the result's number by the count parameter. |
| [badge-blue GET] | /recommendation-engine/product/actions/combined | This is a combination of the previous eliminate and order methods. Use the method to select and sort the most relevant products recommended to the customer from the initial list and complement it with the best sellers, if necessary.The method always returns the required number of products, so it may complete the result with products with the highest score (the best sellers) without a relation to the customer's purchasing behavior. |
| [badge-blue GET] | /recommendation-engine/shopping-cart/actions/eliminate | Use this method to select the most related products to the customer's shopping cart content from the initial list (best matching products first). The results depend on the customer's actual shopping cart content and his previous shopping behaviour. It excludes all products that do not match the customer preferences (depending on the customer's previous shopping behaviour). This method may return less product IDs than in the initial list or no products depending on the initial list (if less or no product matches the customer's preferences). |
| [badge-blue GET] | /recommendation-engine/shopping-cart/actions/order | Use this method to get the most related products to the customer's shopping cart content from the initial list sorted by the algorithm (best matching products first). The results depend on the customer's actual shopping cart content and his previous shopping behaviour. You can limit the result's number by the count parameter. |
| [badge-blue GET] | /recommendation-engine/shopping-cart/actions/combined | This is a combination of the previous eliminate and order methods. Use the method to select and sort the most relevant products to the customer's shopping cart content from the initial list and complement it with the best sellers, if necessary. The method always returns the required number of products, so it may complete the result with products with the highest score (the best sellers) without a relation to the customer's purchasing behavior. |
Use this method to select the most related products recommended to the customer from the initial list (best matching products first). The results depend on the customer's previous shopping behaviour. It excludes all products that do not match the customer preferences (depending on the customer's previous shopping behaviour). The method may not return any results depending on the initial list (if no product matches the customer's preferences).
[badge-blue GET ] /recommendation-engine/product/actions/eliminate
| Parameter name | Type | Description | Mandatory (Yes/No) |
|---|---|---|---|
| customer_id | string | The unique id of the customer | Yes |
| product_id_list | string[] | List of the product ids. Initial product list for the recommendation engine | No |
Status code: 200 OK
Output structure : object
| Parameter name | Type | Description |
|---|---|---|
| recommended_products_list | string[] | List of the recommended product ids |
| total_items | integer | Count of all found product ids |
GET https://<projectURL>/rest-api/enterprise-interface/v1.0/recommendation-engine/product/actions/eliminate?customer_id=8fa5cf3b281e5317fd3a5a9a
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6NDU3NDJhMDAxNmEyZjc1NDI3YWUwMTM0NmMyOWQxNmE4NzI1MWZlzZmMzcwNmI2MDJmDfN2Q2Mw==HTTP/1.1 200 OK
Date: Tue, 20 Oct 2020 13:57:32 GMT
Content-Type: application/json; charset=utf-8
{
"data": {
"recommended_products_list": [
"80af10a712ce31a8ed0e2f68a0",
"84b6d6ba0f1b0fadc6e73a2608",
"8bb7f47a2743d4a7494dfee1c0"
],
"total_items": 3
}
}Use this method to get the most related products from the initial list sorted by the algorithm (best matching products first). The results depend on the customer's previous shopping behaviour. You can limit the result's number by the count parameter.
[badge-blue GET ] /recommendation-engine/product/actions/order
| Parameter name | Type | Description | Mandatory (Yes/No) |
|---|---|---|---|
| customer_id | string | The unique id of the customer | Yes |
| product_id_list | string[] | List of the product ids. Input products for the recommendation engine | No |
| count | integer | Count of the expected results | No |
Status code: 200 OK
Output structure : object
| Parameter name | Type | Description |
|---|---|---|
| recommended_products_list | string[] | List of the recommended product ids |
| total_items | integer | Count of all found product ids |
GET https://<projectURL>/rest-api/enterprise-interface/v1.0/recommendation-engine/product/actions/order?customer_id=8fa5cf3b2f6e5317fd3a5a9a
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6NDU3NDJhMDAxNmEyZjc1NDI3YWUwMTmMyOWQxNmE4NzI1MWZlzZmMzcwNmI2MDJmDfN2Q2Mw==HTTP/1.1 200 OK
Date: Tue, 20 Oct 2020 13:58:12 GMT
Content-Type: application/json; charset=utf-8
{
"data": {
"recommended_products_list": [
"8aaef9a016101a94f27264a926",
"80af10a712ce31a8ed0e2f68a0",
"84b6d6ba0f1b0fadc6e73a2608",
"8bb7f47a2743d4a7494dfee1c0"
],
"total_items": 4
}
}This is a combination of the previous eliminate and order methods. Use the method to select and sort the most relevant products recommended to the customer from the initial list and complement it with the best sellers, if necessary. The method always returns the required number of products, so it may complete the result with products with the highest score (the best sellers) without a relation to the customer's purchasing behavior.
[badge-blue GET ] /recommendation-engine/product/actions/combined
| Parameter name | Type | Description | Mandatory (Yes/No) |
|---|---|---|---|
| customer_id | string | The unique id of the customer | Yes |
| product_id_list | string[] | List of the product ids. Input products for the recommendation engine | No |
| count | integer | Count of the expected results | No |
Status code: 200 OK
Output structure : object
| Parameter name | Type | Description |
|---|---|---|
| recommended_products_list | string[] | List of the recommended product ids |
| total_items | integer | Count of all found product ids |
GET https://<projectURL>/rest-api/enterprise-interface/v1.0/recommendation-engine/product/actions/combined?customer_id=8fa5cf3b281fe5317fd3a5a9a
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6NDU3NDJhMDAxNmEyZjc1NDI3YWUwMTM0NmMyOWmE4NzI1MWZlzZmMzcwNmI2MDJmDfN2Q2Mw==HTTP/1.1 200 OK
Date: Tue, 20 Oct 2020 14:00:52 GMT
Content-Type: application/json; charset=utf-8
{
"data": {
"recommended_products_list": [
"8aaef9a016101a94f27264a926",
"80af10a712ce31a8ed0e2f68a0",
"84b6d6ba0f1b0fadc6e73a2608",
"8bb7f47a2743d4a7494dfee1c0"
],
"total_items": 4
}
}Use this method to select the most related products to the customer's shopping cart content from the initial list (best matching products first). The results depend on the customer's actual shopping cart content and his previous shopping behaviour. It excludes all products that do not match the customer preferences (depending on the customer's previous shopping behaviour). The method may not return any results depending on the initial list (if no product matches the customer's preferences).
[badge-blue GET ] /recommendation-engine/shopping-cart/actions/eliminate
| Parameter name | Type | Description | Mandatory (Yes/No) |
|---|---|---|---|
| customer_id | string | Id of the customer | Yes |
| cart_product_ids | string[] | List of the product ids in customer's shopping cart | No |
| product_id_list | string[] | List of the product ids. Input products for the recommendation engine | No |
Status code: 200 OK
Output structure : object
| Parameter name | Type | Description |
|---|---|---|
| recommended_products_list | string[] | List of the recommended product ids |
| total_items | integer | Count of all found product ids |
GET https://<projectUrl>/rest-api/enterprise-interface/v1.0/recommendation-engine/shopping-cart/actions/eliminate?customer_id=80aafeca2bd1871b77c061e50&card_product_ids=86e05affc7a7abefcd13ab400
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6NjFlNmUyNGU4YzMxZDA5YmM4Mjc4MG2Y2ZhNmU4YmY4NWJlYWZjMzg3NGxMzMxZWU1MjQwNmJhNDk3NWExMA==HTTP/1.1 200 OK
Date: Tue, 20 Apr 2021 16:51:59 GMT
Content-Type: application/json; charset=utf-8
{
"data": {
"recommended_products_list": ["8bed991c68a470e7aaefbf048"],
"total_items": 1
}
}
Use this method to get the most related products to the customer's shopping cart content from the initial list sorted by the algorithm (best matching products first). The results depend on the customer's actual shopping cart content and his previous shopping behaviour. You can limit the result's number by the count parameter.
[badge-blue GET ] /recommendation-engine/shopping-cart/actions/order
| Parameter name | Type | Description | Mandatory (Yes/No) |
|---|---|---|---|
| cart_product_ids | string[] | List of the product ids in customer's shopping cart | Yes |
| product_id_list | string[] | List of the product ids. Input products for the recommendation engine | No |
| count | integer | Count of the expected results | No |
Status code: 200 OK
Output structure : object
| Parameter name | Type | Description |
|---|---|---|
| recommended_products_list | string[] | List of the recommended product ids |
| total_items | integer | Count of all found product ids |
GET https://<projectURL>/rest-api/enterprise-interface/v1.0/recommendation-engine/shopping-cart/actions/order?cart_product_ids=8da53cd9169d987b1332deb89&product_id_list=81b0625a210bb3050f6d2683d
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6YzQ5OTYwZWIxZDBhYWM5ZTI5ZDQ0N2Q4NjJhNzkxMzAxNmQ1NjAyNDdmYzQ4ZGEODI5OGJjNjRkZTgyN2ExYQ==HTTP/1.1 200 OK
Date: Tue, 20 Apr 2021 16:51:59 GMT
Content-Type: application/json; charset=utf-8
{
{
"data": {
"recommended_products_list": [
"81b0625a210bb3050f6d2683d",
"8da53cd9169d987b1332deb89"
],
"total_items": 2
}
}
}This is a combination of the previous eliminate and order methods. Use the method to select and sort the most relevant products to the customer's shopping cart content from the initial list and complement it with the best sellers, if necessary. The method always returns the required number of products, so it may complete the result with products with the highest score (the best sellers) without a relation to the customer's purchasing behavior.
[badge-blue GET ] /recommendation-engine/shopping-cart/actions/combined
| Parameter name | Type | Description | Mandatory (Yes/No) |
|---|---|---|---|
| customer_id | string | Id of the customer | Yes |
| cart_product_ids | string[] | List of the product ids in customer's shopping cart | No |
| product_id_list | string[] | List of the product ids. Input products for the recommendation engine | No |
| count | integer | Count of the expected results | No |
Status code: 200 OK
Output structure : object
| Parameter name | Type | Description |
|---|---|---|
| recommended_products_list | string[] | List of the recommended product ids |
| total_items | integer | Count of all found product ids |
GET https://<projectURL>/rest-api/enterprise-interface/v1.0/recommendation-engine/shopping-cart/actions/combined?customer_id=86ae806b29ae109c233bf2a5f5&cart_product_ids=8da53cd9169d987b133e2deb89
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6YzQ5OTYwZWIxZDBhYWM5ZTI5ZDQ0N2Q4NjJhNzkxMzAxNmQ1NjAyNDdmYzQ4ZGExODI5OGJjNjRkZTgyN2ExYQ==HTTP/1.1 200 OK
Date: Wed, 21 Apr 2021 11:49:34 GMT
Content-Type: application/json; charset=utf-8
{
"data": {
"recommended_products_list": [
"8da53cd9169d987b133e2deb89"
],
"total_items": 0
}
}