Receiving of sponsored content for category pages

get https://visitors-sp.retailrocket.net/v1/partners//categoryPlacements//impressions

Integration via YML-file

In the YML-file, a category tree has integer category IDs, so products have integer category IDs as well, which allows you to use such IDs for recommendation requests.

You must use the categoryId parameter in the query params with this type of integration.

Integration via Product API

While using the product API, the category is passed as categoryPath and must be passed in the same way while viewing the category page.

You must use the categoryPath parameter in the query params with this type of integration.

Impression

Contains data for displaying sponsored content. Can take different forms, depending on the value of acceptContent, that passed in request.

Values of acceptContent:

  • string
  • productIds
  • banners
  • sharedBanners

📘

sessionExternalId parameter

In case of using sessionExternalId parameter in integration, instead of using link.name and link.value parameters it's necessary to use sessionExternalId parameter in this way:

?sessionExternalId=<value>

Language
Click Try It! to start a request and see the response here!