A recommendation engine is a tool that uses algorithms to personalize customer content. It does this by predicting the most likely items to the customer. It does base on his previous shopping behavior. The ideal use cases are recommendations at any customer touchpoint, such as POS, e-shop, e-mail, or mobile app.
Available methods for resource recommendation-engine.
| HTTP method | Endpoint | Description |
|---|---|---|
| [badge-blue GET] | /recommendation-engine/product/actions/eliminate | It selects the best products from an initial list for the customer. Eliminates all products that don't match future customer preferences (depends on his previous shopping behavior). The method doesn't have to return any results depending on the initial list (no product match future customer preferences). |
| [badge-blue GET] | /recommendation-engine/product/actions/order | The method returns the algorithm ordered products from the initial list (best first). Results depend on the customer and his previous shopping behavior. If needed, the initial parameter might define the number of results. |
| [badge-blue GET] | /recommendation-engine/product/actions/combined | It selects the best products from an initial list for the customer. Eliminates all products that don't match future customer preferences (depends on his previous shopping behavior). If needed, it fills the missing number of results from the best products depends on the prediction algorithms. |
| [badge-blue GET] | /recommendation-engine/shopping-cart/actions/eliminate | It selects the best products from an initial list for the customer shopping cart. Eliminates all products that don't match future customer preferences (depends on other customers' shopping behavior with the same products). The method doesn't have to return any results depending on the initial list (no product match future customer preferences). |
| [badge-blue GET] | /recommendation-engine/shopping-cart/actions/order | The method returns the algorithm ordered products from the initial list (best first). Results depend on the customer's shopping cart and his previous shopping behavior. If needed, the initial parameter might define the number of results. |
| [badge-blue GET] | /recommendation-engine/shopping-cart/actions/combined | It selects the best products from an initial list for the customer shopping cart. Eliminates all products that don't match future customer preferences (depends on other customers' shopping behavior with the same products). If needed, it fills the missing number of results from the best products depends on the prediction algorithms. |
It selects the best products from an initial list for the customer. Eliminates all products that don't match future customer preferences (depends on his previous shopping behavior). The method doesn't have to return any results depending on the initial list (no product match future customer preferences).
[badge-blue GET ] /recommendation-engine/product/actions/eliminate
| Parameter name | Type | Description | Mandatory (Yes/No) |
|---|---|---|---|
| customer_id | string | Id of the customer. | Yes |
| product_id_list | string[] | List of the product ids. Initial 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. |
The method returns the algorithm ordered products from the initial list (best first). Results depend on the customer and his previous shopping behavior. If needed, the initial parameter might define the number of results.
[badge-blue GET ] /recommendation-engine/product/actions/order
| Parameter name | Type | Description | Mandatory (Yes/No) |
|---|---|---|---|
| customer_id | string | 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 |
It selects the best products from an initial list for the customer. Eliminates all products that don't match future customer preferences (depends on his previous shopping behavior). If needed, it fills the missing number of results from the best products depends on the prediction algorithms.
[badge-blue GET ] /recommendation-engine/product/actions/combine
| Parameter name | Type | Description | Mandatory (Yes/No) |
|---|---|---|---|
| customer_id | string | 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 |
It selects the best products from an initial list for the customer shopping cart. Eliminates all products that don't match future customer preferences (depends on other customers' shopping behavior with the same products). The method doesn't have to return any results depending on the initial list (no product match future customer 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 |
The method returns the algorithm ordered products from the initial list (best first). Results depend on the customer's shopping cart and his previous shopping behavior. If needed, the initial parameter might define the number of results.
[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 |
It selects the best products from an initial list for the customer shopping cart. Eliminates all products that don't match future customer preferences (depends on other customers' shopping behavior with the same products). If needed, it fills the missing number of results from the best products depends on the prediction algorithms.
[badge-blue GET ] /recommendation-engine/shopping-cart/actions/combine
| 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 |