/
v3.0.11Get access

getPromotion

Retrieve detailed information about a single promotion by its identifier

Request parameters:

Name
DescriptionTypeValuesDefault
promotionId
The unique identifier of the promotionnumber--
country
Country code used for global filteringstring--
useWebp
Whether to return WebP versions of imagesbooleantrue / false-
platform
Platform namestring"desktop" / "mobile"-

Parameters marked with must be included in the request

Call example:

getPromotion({
  promotionId: 14,
  country: 'AM',
  useWebp: false,
  platform: 'desktop'
})

Response parameters:

NameDescriptionTypeValues
id
Auto-increment unique identifier of the promotionnumber-
show_to
Visibility scope: 0 = all, 1 = authorized users only, 2 = guests onlynumber-
target
Link target attribute: "_blank", "_self", "_parent", or "_top"string-
opt_in
Opt-in identifier or value, or null if not applicablestring | null-
title
Display title of the promotionstring-
content
Full content body of the promotionstring-
src_type
Type of the media source (e.g. "image")string-
src
Path to the promotion image assetstring-
href
URL the promotion links to when clickedstring-