Accessing Product Campaigns



There are several types of product campaigns, depending on the display location. Product detail page and shopping basket are predefined but there is also a placeholder definition. It can be used to define campaigns for custom display locations (e.g. homepage).

These campaigns must be fetched explicitly by invoking a FACT-Finder API call. The parameters to fetch detail-page campaigns are the channel and article number of the product being displayed. The parameters for the shopping-basket campaigns are the channel and a list of the article numbers of the products in the shopping basket. The call to fetch the placeholder campaigns needs the channel and the id of the page, for which the campaigns should be fetched. All endpoints possess a parameter named sid which contains the session identifier of the user for whom to personalize pushed product sets. If the session parameter was absent such product sets are returned without personalization.

REST-Interface

The search application contains the technical documentation for the REST-Interfaceand can be accessed via this URL:

Methods are documented under records. In addition to viewing the parameter documentation, you can also test a query and view the results. The documentation was created with Swagger, so you can use Swagger Codegen to generate a client to use in your code.

Please use the campaign method to retrieve campaigns.

Page Contents