Sponsored Product API spec

This document describes how to construct an ad request for the Sponsored Product Creative Form.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Textual identifier for the website or service. Remove "www." from the beginning and convert dots to underscore in your domain shop, and it will fit. For www.example.com it would be example_com

string
required

Information about website, on which we want to show the Ad – Used for Retail Media Network integration

string
required

List of offer IDs, comma separated, for which we want to show context Ad – Used for Retail Media Network integration

string
enum
required
Defaults to other

Textual identifier for a specific location or section within the website or service. It typically corresponds to the site's navigation structure and categorization. By providing the area parameter, you can give the ad management system more contextual information about the content surrounding the AdSlot.

Allowed:
string
enum
required

Specific name of an AdSlot

Allowed:
string

Any information tag / keyword

string
enum
required
Defaults to 1

Flag to return impression link in response

Allowed:
string
enum
Defaults to 1

Flag to return DSA (Digital Services Act) link in response (required if shop meets definition of DSA platform)

Allowed:
string

Test ad creative

Responses

400

Bad Request

404

Not Found

500

Internal Server Error

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

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