Get recommendations

Retrieve recommended products

Body Params
string

Use the configured Recommendation by identifier of the Makaira UI.

Get recommendation relatated to one or multiple products. Note the these ids are exluded from the responses.

string

Only search in the specified shop.

string

Language used in this query. Use the same langunge abbreviation as in the makaira backend index-manager.

boolean

Use stock information to filter search results. If true, only onstock:true products will be returned.

string

Required if you want to use Machine Learning on your Recommendations. Contains the user agent of the current user

string

Required if you want to use Machine Learning on your Recommendations. Contains the user ip of the current user

string

Required if you want to use Machine Learning on your Recommendations. Contains the timezone of the current user

integer

How many recommendation should be returned.

boolean

Normally not necessary, but can override the default loaded by recommendationId. Determine if the recommendation is active or not

boolean

Normally not necessary, but can override the default loaded by recommendationId. The recommendation type that you want to use. Choose one of pictureSimilarity, textSimilarity, boughtTogether, behaviourHistoryCartBased, behaviourHistoryUserBased or none

boolean

Normally not necessary, but can override the default loaded by recommendationId. Adds more products based on Recommendation Type "Text Similarity" if not enough results can be retrieved by original Recommendation Type (not applicable for Recommendation Types "Text Similarity" and "None")

string

Normally not necessary, but can override the default loaded by recommendationId. Return only products that match all filter conditons.

string

Normally not necessary, but can override the default loaded by recommendationId. Prefer product that match the filter conditon. The boostingStrength value changes the importance of this attribute (logarithmic scale).

boolean

Normally not necessary, but can override the default loaded by recommendationId. Determine if we should use Randomize feature to effect the result.

boolean

Normally not necessary, but can override the default loaded by recommendationId. Determine if we should use Machine Learning feature to effect the result.

boolean

Normally not necessary, but can override the default loaded by recommendationId. Determine if we should use Ranking Mix feature to effect the result.

string

Arbitrary Id to assign the request.

string

List of fields that should be returned.

boolean

Boosts Recommended items depending on simillar attributes.

boolean

Decide if the filters and boostings sent from the client should be merged with the one stored in the database.

boolean

If set to false, the search query hook will be disabled. Default value is true(if not specify)

Headers
string
required

Makaira Instance ID

Response
200

OK

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!