Get All Promotions

Retrieves all promotions from an account.

Response object has the following properties:

Attribute

Type

Description

limitConfigurationMaxPrice

object

List limit configuration Max Price

activesCount

integer

Number of actives benefits by max price

limit

integer

Limit of benefits by Max Price

limitConfiguration

object

List limit configuration

items

array of objects

List all benefits

idCalculatorConfiguration

string

Calculator Configuration ID

lastModifiedUtc

string

When the Benefit was last modified

name

string

Benefits Name

beginDate

string

Benefit Begin Date

endDate

string

Benefit End Date

isActive

boolean

Shows if the benefit is active

description

string

Benefit Description

type

string

Shows what is the type of the benefit

utmSource

string

Benefit utm Source

utmCampain

string

Benefit utm Campaign

utmiCampaign

string

Benefit utmi Campaign

status

string

Shows the Benefit Status

percentualTax

decimal

Percentual Tax over purchase total value

isArchived

boolean

Shows if the benefit is archived

hasMaxPricePerItem

array

Deprecated

isTax

boolean

Shows if it is a tax

Campaigns

array

Shows the campaigns associated to the Benefit

id

string

Campaign ID

name

string

Campaign Name

activateGiftsMultiplier

boolean

Activate gifts Multiplier

effectType

string

Shows the Benefit effect type

scope

object

Shows the benefit scope

allCatalog

boolean

Shows if the Benefit applies for all catalog

skus

integer

Shows for how many skus the Benefit applies

products

integer

Shows for how many products the Benefit applies

collections

integer

Shows for how many collections the Benefit applies

categories

integer

Shows for how many categories the Benefit applies

brands

integer

Shows for how many brands the Benefit applies

maxUsage

integer

Shows how many times the benefit can be used

disabledItems

array

archivedItems

array

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