The basic concept of our API is to keep everything as simple as possible for you and to avoid any unnecessary backend work on your side.
From Developers, For Developers
To achieve this goal, we reduced the required fields in the API recommendation endpoint to a minimum and thereby circumvented the necessity for you to do any backend matching.
A product recommendation consists of two parts. First, you inform us which product is in the basket, and then we automatically provide you with a list of products that would be a great fit. This structured list of products includes all relevant information.
To get your first recommendation, please provide us the following information:
The amount of information is very limited — at this point, no personal information about your customer is necessary.
The basic setup of your account is stored and can be changed in the admin interface. However, you always have the ability to edit the basic information connected to your account during a recommendations request, including:
If you leave this information blank during your request, we will use the default values stored for your account.
To improve the recommendations, you can voluntarily provide more information such as:
None of this information is required, but if you include it, the customer-related information must be GDPR compliant.
Context-related information is a fully flexible tool you can use to give us any information about the shopping situation, including (but not limited to):
The more we know about the product in the basket, the better we can predict which cross-selling item best fits the profile. Therefore, you have the ability to provide us with more information about the product, such as:
In some cases, information about the customer is relevant for the product recommendation and is GDPR compliant. In this case, the following customer information can be provided to make the recommendation fit even better: