Get campaign audience configuration

Retrieves a specific campaign audience configuration by its ID.

❗️

Attention

This API uses the campaign ID, not the campaign name.

Response object has the following properties:

Attribute

Type

Description

beginDateUtc

string

Campaign begin date (UTC)

endDateUtc

string

Campaign end date (UTC)

id

string

Campaign ID

name

string

Campaign Name

isActive

boolean

Shows if the Campaign is active

isArchived

boolean

Shows if the Campaign is archived

lastModified

object

Shows when the Campaign was last modified

dateUtc

string

Date when the Campaign was last modified

user

string

Last user who saved the Campaign

targetConfigurations

object

Target audience configurations

featured

boolean

Shows if the Campaign is featured

beginDateOfPurchasesUtc

string

Campaign begin date (UTC)

endDateOfPurchasesUtc

string

Campaign expiration date (UTC)

id

string

Target configurations ID

name

string

Target configurations name

daysAgoOfPurchases

integer

Number of days that are considered to add the purchase history

origin

string

Shows the Campaign origin, Marketplace or Selller

idSellerIsInclusive

boolean

Shows if at least one of the sellers must be valid to active the Campaign

idsSalesChannel

array

Shows the Sales Channels (Trade Policys) that active the Campaign

areSalesChannelIdsExclusive

boolean

Shows if the Sales Channel IDs are exclusive

marketingTags

array

Campaign marketing tags

marketingTagsAreNotInclusive

boolean

Shows if marketing tags are not inclusive

paymentsMethods

array

Campaign payments methods

stores

array

Campaign stores (Deprecated)

campaigns

array

conditionsIds

array

storesAreInclusive

boolean

Shows if stores are inclusive (Deprecated)

categories

array

Shows the categories that active the Campaign

categoriesAreInclusive

boolen

Shows if the categories will active or deactive the Campaign

brands

array

Shows the brands that active the Campaign

brandsAreInclusive

boolean

Shows if the categories will active or deactive the Campaign

products

array

Shows the products that active the Campaign

productsAreInclusive

boolean

Shows if the products will active or deactive the Campaign

skus

array

Shows the SKUs that active the Campaign

skusAreInclusive

boolean

Shows if the SKUs will actived or deactived the Campaign

collections1BuyTogether

object

id

string

Collectionn ID

name

string

Collection Name

collections2BuyTogether

deprecated

Deprecated

idTypeDiscountBuyTogether

integer

minimumQuantityBuyTogether

integer

Define the minimum quantity for Buy Together Campaign

quantityToAffectBuyTogether

integer

Define the quantity to affect buy Together Campaign

enableBuyTogetherPerSku

boolean

Enable Buy Together per SKU

listSku1BuyTogether

array

SKU first list for a Campaign Buy Together

listSku2BuyTogether

array

SKU second list for a Campaign Buy Together

listBrand1BuyTogether

array

Brand first list for a Campaign Buy Together

listCategory1BuyTogether

array

Category first list for a Campaign Buy Together

coupon

array

Deprecated

totalValueFloor

integer

Minimum chart value to active the Campaign

totalValueCeling

integer

Maximum chart value to active the Campaign

totalValueIncludeAllItems

deprecated

Deprecated

totalValueMode

string

collections

object

Shows the collections that will active or deactive the Campaign

collectionsIsInclusive

boolean

Shows if the collections will actived or deactived the Campaign

restrictionsBins

array

Shows the Payment BINs (Bank Identification Number) that will active or deactive the Campaign

cardIssuers

array

totalValuePurchase

decimal

Total value purchase to active a Campaign

slasIds

array

Shows the carriers that will active or deactive the Campaign

isSlaSelected

boolean

Shows if the carriers will actived or deactived the Campaign

isFirstBuy

boolean

Active the Campaign only if it is a First Buy

firstBuyIsProfileOptimistic

boolean

Active the Campaign even if the user is not logged

compareListPriceAndPrice

boolean

Active the Campaign only if List Price is equal to Price

isDifferentListPriceAndPrice

boolean

Active the Campaign only if List Price is different to Price

zipCodeRanges

array of objects

Defines what is the range of the ZipCode that applies the Campaign

zipCodeFrom

string

Inicial ZIP Code range

zipCodeTo

string

Final ZIP Code range

inclusive

boolean

Shows if the ZIP Code range will active or deactive the Campaign

itemMaxPrice

decimal

Maximum Price of an item

itemMinPrice

decimal

Minimum Price of an item

installment

integer

Deprecated

isMinMaxInstallments

boolean

Sets if the Campaign will be applied considering a minimum and maximum values for installments

minInstallment

integer

Minimum value for installment

maxInstallment

integer

Maximum value for installment

merchants

array

Deprecated

clusterExpressions

array

Defines an expression to use with clusters

clusterOperator

string

paymentsRules

array

Deprecated

giftListTypes

array

Defines Gift List types

productsSpecifications

array

Deprecated

affiliates

array

Defines the Affiliates

maxUsage

integer

Defines how many times the Campaign can be used

maxUsagePerClient

integer

Defines how many times the Campaign can be used per client

multipleUsePerClient

boolean

Defines if the Campaign can be used multiple times per client

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