Request type.

Use the value multifetch.

Site origin.

To find out your site's origin, see Getting your site origin.

Information about what recommendation data to retrieve and, if appropriate, how to filter the returned data with parameters defined in the recommendation configuration.

You can retrieve the data for one or more recommendation configurations. You specify each configuration in its own recommendation configuration settings object using the JSON format.

Retrieve the data for one recommendation configuration:

recos=[{
  "name": "Most viewed products",
  "params": {
    "type": "Books"
  }
}]

Retrieve the data for two recommendation configurations:

recos=[{
  "name": "Most viewed products",
  "params": {
    "type": "Books"
  }
},{
  "name": "Products viewed together",
  "params": {
    "id": "123"
  }
}]

Define whether to also return the data for product variants.

If a product has one or more variants, the API returns the full product data for each variant in the variants array property of the recommended item object.

The possible values are:

• false: Do not return product variant data.
• true: Return product variant data.

The default value is false.

Define whether to return debugging information about the recommendation data.

The debugging information for a recommendation consists of:

• Selected details about the recommendation configuration that was used to generate the recommendation
• Raw recommendation data (dataPoints) that was used to build the final recommendation data
• For a product recommendation: Product API debugging information for the recommended products

The possible values are:

• false: Do not return debugging information.
• true: Return debugging information.

The default value is false.

Request parameters defined in the recommendation configuration. Use the parameters to filter which recommended items to return.

You can only include parameters defined in the recommendation configuration:

• If you want to filter the results by a given parameter, assign the parameter an exact field or segment value (case-insensitive).
• If you do not want to filter the results by a given parameter, either omit the parameter or set the parameter value to an empty string ("").

If the recommendation type is bundle_viewed, bundle_converted, or bundle_viewed_converted, only include a single parameter: the target field against which the recommendation is generated, as defined in the recommendation configuration. For example, if you're recommending products purchased together with a product the visitor just added to their shopping cart, include the product ID parameter with a valid product ID as its value, since the recommendation is based on a specific product. Do not include any other parameters.

If the recommendation type is most_viewed or most_converted, include zero or more of the parameters defined in the recommendation configuration. The order of the parameters does not matter in the request. In addition, if you're filtering by segment, you can only define one segment per request.

If you do not want to use any parameters to filter the recommendation results, omit this property from the request.

For a bundle recommendation whose configuration defines the id parameter:

"params": {
  "id": "123"
}   

For a most recommendation whose configuration defines the type parameter:

"params": {
  "type": "Books"
}

For a most recommendation whose configuration defines the type and language parameters:

# Filter by type and language.

"params": {
  "type": "Books",
  "language": "English"
}

# Filter by type only.

"params": {
  "type": "Books",
  "language": ""
}

# Filter by neither, return all results.

"params": {
  "type": "",
  "language": ""
}

# Omitting "params" from the request yields the same result as the empty values above.

Request parameter defined in the recommendation configuration. Use the parameter to filter which recommended items to return.

You can define either a single string or an array of strings as the parameter value. In the latter case, the recommendation results are filtered separately by each string value.

If the parameter corresponds to a source data field that has a Boolean or number value, such as product price, define the parameter value nonetheless as a string. For example, define the Boolean true as the string "true", and define the number 1 as the string "1".

If you do not want to filter the results by the parameter, set the parameter value to an empty string ("").

Filter for Books English:

"params": {
  "type": "Books",
  "language": "English"
}

Filter for Books English and Books Finnish:

"params": {
  "type": "Books",
  "language": [
    "English",
    "Finnish"
  ]
}

Filter for Books English, Books Finnish, Magazines English, and Magazines Finnish:

"params": {
  "type": [
    "Books",
    "Magazines"
  ],
  "language": [
    "English",
    "Finnish"
  ]
}

Filter by originally boolean and numeric values:

"params": {
  "isAvailable": "true",
  "price": "99.99"
}

No filtering:

"params": {
  "type": "",
  "language": ""
}

IDs of the products to exclude from the recommendation data.

Exclude products 123, 456, and 789 from the recommendation data:

"excludeIds": [
  "123",
  "456",
  "789"
]

Maximum number of recommended items to return.

By default, the platform uses the limit value defined in the recommendation configuration. If you want to set a different maximum for a request, define a limit in the request.

The minimum value is 1. The maximum value is 120.

Logic for mapping the IDs of the recommended items to source data in the Frosmo back end. This determines what data the recommendation actually returns for each item.

By default, the platform uses the map_ids value defined in the recommendation configuration. If you want to set a different mapping for a request, define a map_ids in the request.

The possible values are:

• datapoint: Do not map the item IDs to anything. Return the raw recommendation data (ID and recommendation weight) for each item.
• product: Map each item ID to a product ID. Return the full product data for each ID.

Use a valid site origin as the value of the origin query parameter.

To find out your site's origin, see Getting your site origin.

The <parameter_name> request parameter is an array that contains a value of the wrong type at the specified index. The API expects a string.

The invalid value is located at: recos[<recos_index>].params.<parameter_name>[<parameter_index>]

The value of the <parameter_name> request parameter is of the wrong type. The API expects a string or an array of strings.

The invalid value is located at: recos[<recos_index>].params.<parameter_name>

If you want to return product variant data, set the variants query parameter to either true or 1.

If you do not want to return product variant data, set the variants query parameter to either false or 0, or omit the parameter from the request URL.