Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes a new promotion item.

Hierarchy

  • NewPromotionItemObject

Index

Constructors

constructor

Properties

actionType

actionType: string

Determines if the item can be Added, Updated, or both. Option are: Add or Update or Add/Update.

cardinalityCheckScope

cardinalityCheckScope: string

Where to check the cardinality. Option are: Context Product Scope or Cart Scope.

contextEntityFilterId

contextEntityFilterId: string

The id of the Entity filters that provide a mechanism to run a set of objects through a set of filters.

contextProductId

contextProductId: string

If defined, will cause the action to be attempted inside this selection product.

description

description: string

The description of the promotion item.

effectiveFromDate

effectiveFromDate: string

The effective from date of the promotion item.

effectiveUntilDate

effectiveUntilDate: string

The effective to date of the promotion item.

hierarchyPath

hierarchyPath: string

The path that must be set on the promotion item for offers.

isActive

isActive: boolean

Determines if the promotion item is active.

isUndoable

isUndoable: boolean

Determines if the promotion item is undoable.

maxQuantity

maxQuantity: number

The maximum quantity that the item can be purchased in the promotion.

minQuantity

minQuantity: number

The minimum quantity that the item can be purchased in the promotion.

offerId

offerId: string

The id of the offer (if applicable) that the item will be applied to.

productHierarchyGlobalKeyPath

productHierarchyGlobalKeyPath: string

Hierarchy path of Global Key for the product

productHierarchyGroupKeyPath

productHierarchyGroupKeyPath: string

Hierarchy path of Group Key for the product

productId

productId: string

The id of the promotion item.

promotionId

promotionId: string

The id of the promotion (if applicable) that the promotion item will be applied to.

quantity

quantity: number

The default quantity of the item.

undoableMessage

undoableMessage: string

Message to display in the case that "Is Undoable" is selected.

updateScope

updateScope: string

Determines to either Update Item Only or Update Item and Child Items.

Generated using TypeDoc