Order products for the best recommendation for a shopping cart

post https://{project_url}/webservice/rest-api/{api_interface}/{version}/recommendation-engine/shopping-cart/actions/order

The method returns the algorithm ordered products from the initial list (best first). Results depend on the customer shopping cart and his previous shopping behavior. If needed, the initial parameter might define the number of results.

Responses

Response body

object

data

object

recommended_products_list

array of objects

List of the recommended products.

recommended_products_list

object

product_id

string

The unique ID of the product.

plu_ids

array of objects

An array of all available pluIds from the particular product lists (default is Product ID from Global product list (consist cleaned data - unique ID of every product across all POS systems)).

plu_ids

object

list_code

string

required

Code of the particular product list (basic is code of Global product list (consist cleaned data - unique ID of every product across all POS systems)). For example, “GLOBAL”, “SKU”, “PLU”, etc.

code

string

required

Code of product from the product list (basic is Product ID from Global product list (consist cleaned data - unique ID of every product across all POS systems)).

total_items

integer

The number of all found product IDs.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/recommendation-engine/shopping-cart/actions/order \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json'


xxxxxxxxxx
16
 
1
{
2
  "data": {
3
    "recommended_products_list": [
4
      {
5
        "product_id": "85d6598db0bf3f62afd5db8507",
6
        "plu_ids": [
7
          {
8
            "list_code": "GLOBAL",
9
            "code": "abc"
10
          }
11
        ]
12
      }
13
    ],
14
    "total_items": 2
15
  }
16
}

200OK

400Bad input parameter. Error message specifies the detail.

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access non authorized property/resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.