idCalculatorConfigurationstring
descriptionstring
Promotion internal description.
beginDateUtcstring
Promotion Begin Date (UTC).
endDateUtcstring
Promotion End Date (UTC).
lastModifiedstring
When the Promotion was last modified.
daysAgoOfPurchasesinteger
Number of days that are considered to add the purchase history.
isActiveboolean
If set as true the Promotion is activated. If set as false the Promotion is deactivated.
isArchivedboolean
If set as true the Promotion is archived. If set as false the Promotion is not archived.
isFeaturedboolean
Insert a flag with the promotion name used in the product's window display and page.
disableDealboolean
Indicates whether a deal is disabled (true) or not (false).
activeDaysOfWeekstring[]
Defines which days of the week the promotion will applied.
offsetinteger
Time offset from UTC in seconds.
activateGiftsMultiplierboolean
If set as true, it activates gifts Multiplier.
newOffsetnumber
New time offset from UTC in seconds.
maxPricesPerItemsstring[]
List of prices per items.
cumulativeboolean
Defines if a promotion can accumulate with another one. (true) or not (false).
effectTypestring
The type of effect that will apply to the promotion.
discountTypestring
The type of discount that will apply to the promotion.
nominalShippingDiscountValuenumber
Exact discount to be applied for the shipping value.
absoluteShippingDiscountValuenumber
Maximum value for the shipping.
nominalDiscountValuenumber
Exact discount to be applied for the total purchase value.
nominalDiscountTypestring
Controls the behavior of the NominalDiscount effect. This field only accepts two string values:
-item: applies the intended nominal discount on every item present on the cart.
-cart: keeps the behavior as it currently is: the whole order/cart receives a nominal discount that is distributed among the items.
maximumUnitPriceDiscountnumber
The maximum price for each item of the purchase will be the price set up.
percentualDiscountValuenumber
Percentage discount to be applied for total purchase value.
rebatePercentualDiscountValuenumber
Percentual Shipping Discount Value.
percentualShippingDiscountValuenumber
Percentage discount to be applied for shipping value.
percentualTaxnumber
Percentual tax over purchase total value.
shippingPercentualTaxnumber
Shipping Percentual tax over purchase total value.
percentualDiscountValueList1number
Valid discounts for the SKUs in listSku1BuyTogether, discount list used for Buy Together Promotions.
percentualDiscountValueList2number
Equivalent to percentualDiscountValueList1.
nominalRewardValuenumber
Nominal value for rewards program.
percentualRewardValuenumber
Percentage value for rewards program.
orderStatusRewardValuestring
Order status reward value.
maxNumberOfAffectedItemsinteger
The maximum number of affected items for a promotion.
maxNumberOfAffectedItemsGroupKeystring
The maximum number of affected items by group key for a promotion.
applyToAllShippingsboolean
Promotion will be applied to all kind of shipping.
idSellerIsInclusiveboolean
If set to true, this promotion will be applied to any seller present on the idSeller field. If set to false, sellers present on that field will make this promotion not to be applied.
idsSalesChannelstring[]
List of Trade Policies that activate this promotion.
areSalesChannelIdsExclusiveboolean
If set to false, this promotion will be applied to any trade policies present on the idsSalesChannel field. If set to true, trade policies present on that field will make this promotion not to be applied.
marketingTagsstring[]
Promotion Marketing tags.
marketingTagsAreNotInclusiveboolean
If set to false, this promotion will be applied to any marketing tag present on the marketingTags field. If set to true, marketing tags present on that field will make this promotion not to be applied.
campaignsstring[]
Campaign Audiences that activate this promotion.
conditionsIdsstring[]
Array with conditions IDs.
storesAreInclusiveboolean
If set to true, this promotion will be applied to any store present on the stores field. If set to false, stores present on that field will make this promotion not to be applied.
categoriesAreInclusiveboolean
If set to true, this promotion will be applied to any category present on the categories field. If set to false, categories present on that field will make this promotion not to be applied.
brandsAreInclusiveboolean
If set to true, this promotion will be applied to any brand present on the brands field. If set to false, brands present on that field will make this promotion not to be applied.
productsAreInclusiveboolean
If set to true, this promotion will be applied to any product present on the products field. If set to false, products present on that field will make this promotion not to be applied.
skusAreInclusiveboolean
If set to true, this promotion will be applied to any SKU present on the skus field. If set to false, SKUs present on that field will make this promotion not to be applied.
minimumQuantityBuyTogetherinteger
Minimum quantity for Buy Together promotion.
quantityToAffectBuyTogetherinteger
Quantity to affect Buy Together promotion.
enableBuyTogetherPerSkuboolean
Enable Buy Together per SKU.
totalValueFloornumber
Minimum chart value to activate the promotion.
totalValueCelingnumber
Maximum chart value to activate the promotion.
totalValueIncludeAllItemsboolean
Total value including all items.
totalValueModestring
If products that already are receiving a promotion, will be considered on the chart total value. There are three options available: IncludeMatchedItems, ExcludeMatchedItems, AllItems.
collectionsIsInclusiveboolean
If set to true, this promotion will be applied to any collection present on the collections field. If set to false, collections present on that field will make this promotion not to be applied.
restrictionsBinsstring[]
The discount will be granted if the card's BIN is given.
totalValuePurchasenumber
Total value a client must have in past orders to active the promotion.
slasIdsstring[]
The discount will be granted if the shipping method is the same as the one given.
isSlaSelectedboolean
Applies selected discount only when one of the defined shipping method is selected by the customer.
isFirstBuyboolean
Applies the discount only if it's a first buy.
firstBuyIsProfileOptimisticboolean
Applies the discount even if the user is not logged.
compareListPriceAndPriceboolean
If the List Price and Price are the same.
isDifferentListPriceAndPriceboolean
Applies the promotion only if the list price and price is different.
itemMaxPricenumber
Maximum price of the item.
itemMinPricenumber
Minimum price of the item.
isMinMaxInstallmentsboolean
Set if the promotion will be applied considering a minimum and maximum values for installments.
minInstallmentinteger
Minimum value for installment.
maxInstallmentinteger
Maximum value for installment.
clusterExpressionsstring[]
Criteria to select a customer cluster. Each item in this array should follow the format of an equality function ({propertyname}={value}) or the format of a contains function ({propertyname} contains {value}). In both options, {propertyname} must be replaced with the name of the field in the data entity, and {value} must be replaced with the value determined in Master Data. Find more information about these criteria in Filling in the Customer cluster field.
productsSpecificationsstring[]
List of product specifications.
maxUsageinteger
Defines how many times the promotion can be used.
maxUsagePerClientinteger
Defines if the promotion can be used multiple times per client.
shouldDistributeDiscountAmongMatchedItemsboolean
Should distribute discount among matched items.
multipleUsePerClientboolean
Defines if the promotion can be used multiple times per client.
accumulateWithManualPriceboolean
Allows the promotion to apply to products whose prices have been manually added by a call center operator.
useNewProgressiveAlgorithmboolean
Use new progressive algorithm.
percentualDiscountValueListnumber[]
Percentual discount value list.