API
Start typing to search…

Receiving of sponsored content for grouped products pages

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

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
Path Params
string
required

Identifire of online-store

string
required

Identifier of placement. Requested from Retail Rocket employee.

Query Params
string

ApiKey

productIds
array of int64s
required

List of productIds, separated be comma, array of strings or integers

productIds*
json
required
Defaults to sp-577

Pointer to the visitor - the name of the link parameter, from a pair of string-key and string-value (for example, the key is “user session”, the value is “session identifier”), or another identifier

json
required
Defaults to SP4050

Pointer to the visitor - the value of the link parameter, from a pair of string-key and string-value (for example, the key is “user session”, the value is “session identifier”), or another identifier

string
required

Types of content

string

Identifier of the stock to which products belongs

string
Defaults to value

An additional parameter for receiving sponsored content, the parameter name is not case-insensitive, the value is case-sensitive. You can pass any number of arbitrary parameters in the format custom.<name>=<value>, with different values 'name' and 'value'

boolean

You must specify true if the IDs passed to the request are lowercase. If the IDs are numeric, then you need to either pass a parameter with the value false, or not pass this parameter at all.

Response

Updated 11 months ago

Language
Request
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago