Predbasket

Operations for predictive basket

Get predictions

get

Required Roles: ApiPublicQueries

Authorizations

basicAuthoAuth2apiKey

AuthorizationstringRequired

Path parameters

channelstringRequired

The channel

Query parameters

blackliststring[]Optional

IDs of products to exclude from predictions.

filterstring[]Optional

Filters for field values of returned records.

idsOnlybooleanOptional

If the value true is passed, then only the record IDs will be returned, streamlining the results. Additionally, if the Geo module is enabled, the IDs of all markets the product is mapped to will be also included. If you do not need the other information in the results, this will help you to improve performance.

Default: false

maxResultsinteger · int32Optional

Limit for the amount of predictions to return.

Default: 0

purchaserIdstringOptional

Use this parameter to pass the purchaser ID. This ID is only needed, if the 'Customer-Specific Info' module is active. Otherwise it will be ignored.

userIdstringRequired

This parameter contains a unique user identifier. It is essential for predictive basket results.

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

get

/rest/v5/predictivebasket/{channel}

HTTPcURLJavaScriptPython

GET /fact-finder/rest/v5/predictivebasket/{channel}?userId=text HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Accept: */*

{
  "hits": [
    {
      "id": "text",
      "values": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ]
}