API

General concepts

To receive product recommendations from the Retail Rocket system, you need to access the resource, corresponding to the type of recommendations.The product recommendation API follows the general principles of API integration.

πŸ“˜

Product parameters

stockId parameter is needed for recommendations which contain only available products in a specific stock (region). A value of this parameter, like all product parameters, must match the values that are passed to Retail Rocket with product base.

πŸ“˜

Limits

By default the site (each partnerId) is limited to 200 requests per second. If necessary, it is possible to increase the limit with the help of an account manager or through the support form in your personal account.

🚧

Cache control

API responses contain a Cache-control header, that must be followed for caching responses.

Response

Any well-formed request will receive a response HTTP-status 200 OK, and a string containing a JSON object in the request body.

{
    "recommendations":
    [
        {
            "productId": 53242
        },
        {
            "productId": 65424
        },
    ]
}

{
    "$schema": "https://json-schema.org/draft/2019-09/schema",
    "type": "object",
    "properties": {
        "recommendations": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "productId": {
                        "type": "array",
                        "items": {
                            "type": "integer"
                        }
                    }
                }
            }
        }
    }
}

In the case of a request for recommendations for a non-existent product, the response will return empty array.