NameDescriptionTypeAdditional information
Type

The specific type of promotion this PromotionType represents. Can be: 'CheapestMatchedForDollar', 'CheapestMatchedForPercentOff', 'CheapestMatchedForDollarOff'. Or 'MatchThenCheapestOtherForDollar', 'MatchThenCheapestOtherForDollarOff', 'MatchThenCheapestOtherForPercentOff'. Or 'BundleForTotalDollarDistributed', 'BundleForTotalDollarOffDistributed', 'BundleForPercentOff'. Or 'EachMatchedDollarOff', 'EachMatchedPercentOff'.

string

None.

DollarValueOfCheapest

Only populated for 'CheapestMatchedForDollar' promotions. Represents the dollar value the cheapest product applicable to this promotion should be charged at.

decimal number

None.

PercentOffOfCheapest

Only populated for 'CheapestMatchedForPercentOff' promotions. Represents the percentage of the line price that should be discounted for the cheapest product applicable to this promotion. Between 0.0 and 1.0

decimal number

None.

DollarOffOfCheapest

Only popualted for 'CheapestMatchedForDollarOff' promotions. Represents the dollar amount the line price should be reduced by for the cheapest product applicable to this promotion.

decimal number

None.

DollarValueOfOther

Only poulated for 'MatchThenCheapestOtherForDollar' promotions. Represents the dollar amount the cheapest product applicable to the 'Other' bucket should be charged at.

decimal number

None.

DollarOffOfOther

Only populated for 'MatchThenCheapestOtherForDollarOff' promotions. Represents the dollar amount the cheapest product applicable to the 'Other' bucket should be reduced by.

decimal number

None.

PercentOffOfOther

Only popualted for 'MatchThenCheapestOtherForPercentOff' promotions. Represents the percentage of the line price the cheapest product applicable to the 'Other' bucket should be discounted by. Between 0.0 and 1.0

decimal number

None.

DollarValueOfAll

Only populated for 'BundleForTotalDollarDistributed' promotions. Represents the sum total dollar amount all products applicable to this promotion should be charged at. The total price for all products in this bundle shold sum to this amount.

decimal number

None.

DollarOffOfAll

Only populated for 'BundleForTotalDollarOffDistributed' promotions. Represents the sum total dollar amount all products applicable to this promotion should be discounted by. The total discounted amount for all products in this bundle should sum to this amount.

decimal number

None.

PercentOffOfAll

Only populated for 'BundleForPercentOff' promotions. Represents the percentage of the line price each line item applicable to this promotion should be discounted by. Between 0.0 and 1.0

decimal number

None.

DollarOffOfEach

Only populated for 'EachMatchedDollarOff' promotions. Represents the dollar amount each item applicable to this promotion should be discounted by.

decimal number

None.

PercentOffOfEach

Only popualted for 'EachMatchedPercentOff' promotions. Represents the percentage of the line price each line item applicable to this promotion should be discounted by. Between 0.0 and 1.0

decimal number

None.

ItemsToMatch

Only populated for 'CheapestMatchedForDollar', 'CheapestMatchedForPercentOff', 'CheapestMatchedForDollarOff', 'EachMatchedDollarOff', and 'EachMatchedPercentOff' promotions. Represents a tree of conditions that a line item must meet in order to be applicable to this promotion.

ProductCondition

None.

OtherItemConditions

Only populated for 'MatchThenCheapestOtherForDollar', 'MatchThenCheapestOtherForDollarOff', and 'MatchThenCheapestOtherForPercentOff' promotions. Represents a tree of conditions that a line item must meet in order to be considered part of the 'Other' bucket for this promotion.

ProductCondition

None.

MatchConditions

Only populated for 'MatchThenCheapestOtherForDollar', 'MatchThenCheapestOtherForDollarOff', and 'MatchThenCheapestOtherForPercentOff' promotions. Represents a tree of conditions that a line item must meet in order to be applicable to this promotion.

ProductCondition

None.

BundleItemsToMatch

Only populated for 'BundleForTotalDollarDistributed', 'BundleForTotalDollarOffDistributed', and 'BundleForPercentOff' promotions. Represents a list of tree conditions that must be met for given quantity a line item must meed in order to be applicable to this promotion.

Collection of BundleMatch

None.

NumberToMatch

Only popualted for 'CheapestMatchedForDollar', 'CheapestMatchedForPercentOff', 'CheapestMatchedForDollarOff', 'MatchThenCheapestOtherForDollar', 'MatchThenCheapestOtherForDollarOff', and 'MatchThenCheapestOtherForPercentOff' promotions. Represents the each-based quantity of products matching the given `ItemsToMatch` or 'MatchConditions' condition tree required before this promotion can be applied.

integer

None.

GramsPerMatchUnit

Populated for all promotion types, except 'EachMatchedPercentOff' Represents the number of grams needed to be considered '1' unit of each-based quantity. Used to convert a gram-based product into each-based for use with the 'NumberToMatch' field

decimal number

None.

MaxApplicationCount

An optional field representing the maximum number of times this promotion can be applied to a single cart. When 'null' or '0', there is no limit.

integer

None.