allowMultiple
(display name: Give to a customer more than once)

boolean

true or false

Determines whether the promotion can be given to a customer only once. If set to false, the system allows the promotion to be granted to the customer only once. If set to true, the system adds a copy of the promotion to the customer’s profile every time the customer is granted the promotion.

Note: This property is ignored if the global property is set to true. The default is false.

beginUsable
(display name: Usage start date)

timestamp

Any date

The date that the promotion becomes effective. Used when relativeExpiration property is set to false.

Together with the endUsable date, defines the period within which the promotion is valid, including global promotions. If both values are null, the promotion is always valid.

closeness
Qualifier
(display name: Promotion upsells)

set

Set of qualifiers

Identifies the closeness qualifiers associated with this promotion.

creationDate
(display name: Creation date)

timestamp

Any date

Read-only. The date when the promotion was created.

description
(display name: Description)

string

Any string

Provides a short description of the promotion.

discount
Description
(display name: Discount description)

string

Any string

Description of the discount. The value is a derived setting generated as a readable version of the pmdlRule property value.

displayName
(display name: Name)

string

Any string

Required. Specifies the name visible in the user interface.

enabled
(display name: Enabled)

boolean

true or false

Specify true to enable the promotion. If enabled, the promotion takes effect according to the specified usage period. If disabled, the promotion never takes effect regardless of the usage period.

Note: As a general rule, you should never delete promotions and instead disable them by setting the enabled property to false. This approach eliminates the possibility of deleting a promotion that has been used in an order, which produces errors. The default is true.

endDate
(display name: Distribute through)

timestamp

Any date

The date that the promotion stops being delivered to people, if the collection filtering feature is implemented to use this property.

endUsable
(display name: Usage end date)

timestamp

Any date

The date that the promotion stops being effective. Used when the relativeExpiration property is set to false.

Together with the beginUsable date, defines the period within which the promotion is valid. If both values are null, the promotion is always valid.

evaluateTarget
ItemsFirst

boolean

true or false

This sets the system to evaluate target items first. The default is false.

If set to true, the system evaluates the offer rules to find target items for discount before evaluating the condition rules.

evaluationLimit
(display name: Evaluation limit)

int

Any integer

This identifies how many sets of qualifiers and targets the promotion will evaluate. The default is set to -1, which sets this property to no limit. Note that this is used only with ‘For Next’ type promotions.

excluded
Promotions
(display name: Promotions to exclude)

set

Set of promotions

Identifies a set of promotions that are mutually exclusive with this promotion. For example, if this promotion fires, then none of the excluded promotions can fire.

giveToAnonymous
Profiles
(display name: Give to anonymous customers)

boolean

true or false

If true, this promotion can be granted to anonymous customers.

Note: This property is ignored if the global property is set to true. The default is true.

global
(display name: Automatically apply to all orders)

boolean

true or false

Setting the global property to true indicates that this promotion will be applied an unlimited number of times, to all visitors (including anonymous visitors), for use on an unlimited number of orders, during the specified usage period, regardless of the values set for the following properties:

-- allowMultiple
-- beginUsable
-- endUsable
-- giveToAnonymousProfiles
-- relativeExpiration
-- timeUntilExpire
-- uses

The promotion must be successfully granted to the customer to become available. The default is false.

included
Promotions

(Display name: Promotions to include)

set

Set of promotions

This property overrides stacking rule behavior to explicitly allow this set of promotions to remain inclusive of this promotion.

isSiteRestricted

(Display name: Site restrictions)

boolean

true or false

A derived property based on the sites and siteGroups properties. If true, the promotion is specifically tied to one or more sites.

lastModified

(Display name: Last modified date)

timestamp

Read only. The last time that the promotion was modified.

media
(display name: Media)

map

Map of string tags to media items

The media, such as promotional banners, associated with this discount.

parentFolder
(display name: Parent Folder)

promotion
Folder

Any promotion folder item

The parent folder of this promotion

paymentTypes

(display name: Condition – Tender Type)

set

Sets of enumerated string payment types that are configured in the Payment
Manager

Represents a set of names of payment types that the order must be associated with for the promotion to apply. For payment types with variations, such as credit cards, the variation is included in this property, for example, creditCard:Visa

pmdlRule
(display name: Discount rule)

big string

Any valid pmdlRule

This is the PMDL rule describing the conditions under which this promotion should take effect.

pmdlVersion
(display name: Pmdl version)

int

1 or 2

This property is hidden. The value in this field identifies whether the PMDL is pre-Oracle Commerce 10 (version 1), or Oracle Commerce 10 or later (version 2).

priority
(display name: Order of application)

int

Any integer. Note that lower numbers are higher priority

The priority of the promotion. Promotions are applied in order of priority, with low priority numbers applied first. Engines sort the promotions by the value of this property.

Note that this property functions within the context of a particular promotion type. For example, you can specify how a given Item Discount promotion is applied compared to other Item Discount promotions, but not the order in which Item Discounts are applied compared to Shipping Discounts. This property is required.

qualifierService

(display name: Qualifier service)

string

String Nucleus path to the Qualifier service to use

The path of the qualifier service used with this promotion. By default, this property is set to null, indicating that the global Qualifier service is used.

relative
Expiration
(display name: Usage Period)

boolean

true or false

Determines whether the usage period for the promotion is fixed or relative.

If false, the promotion’s usage period is determined by the dates set in the beginUsable and endUsable properties. If true, the promotion’s usage period is set according to the date it is received by the user (that is, when the promotion is added to the user’s activePromotions profile property). The start date and time is set when the user receives the promotion. The end date and time is set by the start date/time and the value of the timeUntilExpire property. The default is false.

siteGroups
(display name: Site Groups)

set

set of siteGroups items

The siteGroup or groups with which the promotion is associated. Pricing engines should only evaluate promotions whose siteGroups properties include the current site context or where sites and siteGroups are null.

sites
(display name: Sites)

set

set of site configuration items

The ID of the siteConfiguration item or items with which the promotion is associated. Pricing engines should only evaluate promotions that include the current site context, or where both the sites and siteGroups properties are null.

stackingRule
(display name: Stacking rule)

stackingRule

stackingRule

Identifies the stacking rule that is used with this promotion.

startDate
(display name: Distribute starting)

timestamp

Any date

The date that the promotion begins to be able to be delivered to people, if the collection filtering feature is implemented to use this property.

template
(display name: Template)

string

Any template name string

The template with which the promotion is associated. Promotions templates are used in Oracle Commerce Merchandising; see the Merchandising Guide for Business Users.

templateValues
(display name: Template values)

map

Map of template place holder values

Placeholder values are used to build the PMDL from a template; see Adding New Promotions Templates. This property is hidden.

timeUntilExpire
(display name: Redeemable for)

int

Any integer

Determines the usage period in minutes for the promotion. Used when the relativeExpiration property is set to true.

The promotion becomes active as soon as the user is granted the promotion; that is, the promotion is added to the list of promotions in the user’s activePromotions profile property. The expiration date and time is then determined by the number of minutes in timeUntilExpire to the current time.

Note: This property is ignored when the global property is set to true.

type

enum

Version 10 and later:

Item Discount
Shipping Discount
Order Discount

Read-only. The type of promotion: Item, Order or Shipping.

Note that prior to Version 10, the promotion type also specified the type of discount: Amount off, Percent off, or Fixed price.

This property is hidden.

uiAccessLevel
(display name: UI access level)

enum

0 or 1

The value in this field identifies whether or not the promotion is read-only (0) or writeable (1) in the Merchandising UI. This property is hidden.

upsell
(display name: Enable promotion upsells)

boolean

true or false

Indicates that the promotion’s closeness qualifiers (upsells) will be evaluated if the promotion does not apply. The default is true.

uses
(display name: Number of uses allowed per customer)

int

0 or any positive integer

The number of orders for a given customer to which the promotion can be applied. If this number hits zero, the promotion can no longer be applied.

Note: A promotion can sometimes discount a single order multiple times. This is still considered one “use.” For shipping promotions only, you can prevent the promotion from discounting a single order multiple times by setting the oneUsePerOrder property to true.

Note: This property is ignored when the global property is set to true.

version

int

Any integer

Hidden. Used by the SQL Repository to protect against data corruption caused by two different threads attempting to modify the same item at the same time.