Promotion in ESG data model

Base entity from which all Industry Data Model entities are derived.

Traits

Traits for this entity are listed here.

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"4.3"	string	semantic version number of the entity

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Base entity from which all Industry Data Model entities are derived. en A planned activity or marketing activity to raise the visibility or increase sales of a product, service or concept.	entity	a reference to the constant entity holding the list of localized text

is.identifiedBy
Names a specific identity attribute to use with an entity.

Parameter	Value	Data type	Explanation
attribute	Promotion/(resolvedAttributes)/PromotionId	attribute

minimumObjectModelVersion
Minimum version of the object model required to fully understand the data schema used.

Parameter	Value	Data type	Explanation
versionNumber	"1.2.3"	string

is.IDM.modelVersion
Semantic version number of the IDM.

Parameter	Value	Data type	Explanation
versionNumber	"1.6.0"	string

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{5ABA7AA3-2F25-489C-8110-12A49FC091EA}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nativeTo.businessArea
The name of the business area from which the entity originates.

Parameter	Value	Data type	Explanation
name	"Marketing & Advertising"	string

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Promotion	entity	a reference to the constant entity holding the list of localized text

has.entitySchemaAbstractionLevel
A level of abstraction assigned to an Entity schema. Logical schema descriptions use complex dataTypes, inheritance, and entities as attributes. Resolved descriptions contain none of those things, only final trait and attribute sets are shown. A composition schema manipulates, guides or restates parts of logical schemas to produce one resolved schema.

Parameter	Value	Data type	Explanation
level	"resolved"	string	Possible values: logical, composition, resolved

Attributes

Name	Description	First Included in Instance
PromotionId	The unique identifier of a Promotion.	Promotion
PromotionName	The name of a Promotion.	Promotion
PromotionDescription	The description of a Promotion.	Promotion
PromotionStartDate	The start date of a Promotion.	Promotion
PromotionEndDate	The end date of a Promotion.	Promotion
PromotionEligibilityStatement	A statement that describes the eligibility to participate in the Promotion.	Promotion
PromotionRestrictionStatement	A statement of the restrictions that apply to access to or participation in the Promotion.	Promotion
PromotionDiscountPercentage	The percentage discount applied to a transaction in conjunction with the promotion.	Promotion
PromotionPerTransactionAmount	The amount of discount per transaction applied in conjunction with the promotion.	Promotion
MaximumApplicableAmount	The maximum amount of discount that may be applied to a transaction in conjunction with the promotion.	Promotion
MaximumAvailableAmount	The maximum amount of discount that is available to the promotion.	Promotion
PromotionClassificationTypeId	The unique identifier of a Promotion Classification Type.	Promotion
PromotionTypeId	The unique identifier of a Promotion Type.	Promotion
PromotingPartyId	The unique identifier of a Party.	Promotion
MaximumUnitsAvailable	The maximum number of units available to the promotion.	Promotion
FreeShippingIndicator	Indicates whether the promotion includes free shipping.	Promotion
ItemSku	The Stock Keeping Unit identifier, which is typically used for inventory-related activities.	Promotion
ItemCost	The cost associated with the item for the purpose of the promotion.	Promotion

PromotionId

The unique identifier of a Promotion.
First included in: Promotion (this entity)

Properties

Name	Value
displayName	Promotion ID
description	The unique identifier of a Promotion.
isPrimaryKey	true
dataFormat	int32

Traits

List of traits for the PromotionId attribute are listed here.

is.dataFormat.integer
is.identifiedBy
Names a specific identity attribute to use with an entity.

Parameter	Value	Data type	Explanation
attribute	Promotion/(resolvedAttributes)/PromotionId	attribute

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{33E88137-614C-4A14-82A1-4679ED3561E8}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Promotion ID	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The unique identifier of a Promotion.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

PromotionName

The name of a Promotion.
First included in: Promotion (this entity)

Properties

Name	Value
displayName	Promotion Name
description	The name of a Promotion.
dataFormat	string
maximumLength	256
isNullable	true

Traits

List of traits for the PromotionName attribute are listed here.

is.dataFormat.character
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{3ABB147A-CC01-4194-8204-0E2208F357F6}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Promotion Name	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The name of a Promotion.	entity	a reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

Parameter	Value	Data type	Explanation
maximumLength	"256"	integer

is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

PromotionDescription

The description of a Promotion.
First included in: Promotion (this entity)

Properties

Name	Value
displayName	Promotion Description
description	The description of a Promotion.
dataFormat	string
maximumLength	2048
isNullable	true

Traits

List of traits for the PromotionDescription attribute are listed here.

is.dataFormat.character
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{A96F43FB-1C35-44F4-8707-8A7D8203C3CB}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Promotion Description	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The description of a Promotion.	entity	a reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

Parameter	Value	Data type	Explanation
maximumLength	"2048"	integer

is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

PromotionStartDate

The start date of a Promotion.
First included in: Promotion (this entity)

Properties

Name	Value
displayName	Promotion Start Date
description	The start date of a Promotion.
dataFormat	date
isNullable	true

Traits

List of traits for the PromotionStartDate attribute are listed here.

is.dataFormat.date
means.measurement.date
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{5AEA85CF-23DA-4BBB-8916-60377D0FCEA1}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Promotion Start Date	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The start date of a Promotion.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.date

PromotionEndDate

The end date of a Promotion.
First included in: Promotion (this entity)

Properties

Name	Value
displayName	Promotion End Date
description	The end date of a Promotion.
dataFormat	date
isNullable	true

Traits

List of traits for the PromotionEndDate attribute are listed here.

is.dataFormat.date
means.measurement.date
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{01DAF9F8-1144-441A-A920-89E2BD3B6E53}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Promotion End Date	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The end date of a Promotion.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.date

PromotionEligibilityStatement

A statement that describes the eligibility to participate in the Promotion.
First included in: Promotion (this entity)

Properties

Name	Value
displayName	Promotion Eligibility Statement
description	A statement that describes the eligibility to participate in the Promotion.
dataFormat	string
maximumLength	2048
isNullable	true

Traits

List of traits for the PromotionEligibilityStatement attribute are listed here.

is.dataFormat.character
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{39DE2B50-7252-4DD5-9BEB-AE55B54651D3}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Promotion Eligibility Statement	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en A statement that describes the eligibility to participate in the Promotion.	entity	a reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

Parameter	Value	Data type	Explanation
maximumLength	"2048"	integer

is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

PromotionRestrictionStatement

A statement of the restrictions that apply to access to or participation in the Promotion.
First included in: Promotion (this entity)

Properties

Name	Value
displayName	Promotion Restriction Statement
description	A statement of the restrictions that apply to access to or participation in the Promotion.
dataFormat	string
maximumLength	2048
isNullable	true

Traits

List of traits for the PromotionRestrictionStatement attribute are listed here.

is.dataFormat.character
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{127ABE11-982B-4164-9C6A-BB1538EC2AAC}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Promotion Restriction Statement	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en A statement of the restrictions that apply to access to or participation in the Promotion.	entity	a reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

Parameter	Value	Data type	Explanation
maximumLength	"2048"	integer

is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

PromotionDiscountPercentage

The percentage discount applied to a transaction in conjunction with the promotion.
First included in: Promotion (this entity)

Properties

Name	Value
displayName	Promotion Discount Percentage
description	The percentage discount applied to a transaction in conjunction with the promotion.
dataFormat	decimal
isNullable	true

Traits

List of traits for the PromotionDiscountPercentage attribute are listed here.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

Parameter	Value	Data type	Explanation
precision	"18"	integer	the total number of significant digits
scale	"8"	integer	the number of digits to the right of the decimal place

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{910FF9A5-4641-44E7-901C-99076E02D264}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Promotion Discount Percentage	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The percentage discount applied to a transaction in conjunction with the promotion.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

PromotionPerTransactionAmount

The amount of discount per transaction applied in conjunction with the promotion.
First included in: Promotion (this entity)

Properties

Name	Value
displayName	Promotion Per Transaction Amount
description	The amount of discount per transaction applied in conjunction with the promotion.
dataFormat	decimal
isNullable	true

Traits

List of traits for the PromotionPerTransactionAmount attribute are listed here.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

Parameter	Value	Data type	Explanation
precision	"18"	integer	the total number of significant digits
scale	"2"	integer	the number of digits to the right of the decimal place

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{23638F13-1800-493D-832B-E7AA5C34BF15}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Promotion Per Transaction Amount	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The amount of discount per transaction applied in conjunction with the promotion.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

MaximumApplicableAmount

The maximum amount of discount that may be applied to a transaction in conjunction with the promotion.
First included in: Promotion (this entity)

Properties

Name	Value
displayName	Maximum Applicable Amount
description	The maximum amount of discount that may be applied to a transaction in conjunction with the promotion.
dataFormat	decimal
isNullable	true

Traits

List of traits for the MaximumApplicableAmount attribute are listed here.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

Parameter	Value	Data type	Explanation
precision	"18"	integer	the total number of significant digits
scale	"2"	integer	the number of digits to the right of the decimal place

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{6938543F-07BE-4151-B95A-355E6D214C3B}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Maximum Applicable Amount	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The maximum amount of discount that may be applied to a transaction in conjunction with the promotion.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

MaximumAvailableAmount

The maximum amount of discount that is available to the promotion.
First included in: Promotion (this entity)

Properties

Name	Value
displayName	Maximum Available Amount
description	The maximum amount of discount that is available to the promotion.
dataFormat	decimal
isNullable	true

Traits

List of traits for the MaximumAvailableAmount attribute are listed here.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

Parameter	Value	Data type	Explanation
precision	"18"	integer	the total number of significant digits
scale	"2"	integer	the number of digits to the right of the decimal place

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{06323299-F497-4049-97FE-9C528DEF478A}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Maximum Available Amount	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The maximum amount of discount that is available to the promotion.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

PromotionClassificationTypeId

The unique identifier of a Promotion Classification Type.
First included in: Promotion (this entity)

Properties

Name	Value
displayName	Promotion Classification Type ID
description	The unique identifier of a Promotion Classification Type.
dataFormat	int32
isNullable	true

Traits

List of traits for the PromotionClassificationTypeId attribute are listed here.

is.dataFormat.integer
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{1640277B-40D0-4343-92D1-26066953486E}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Promotion Classification Type ID	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The unique identifier of a Promotion Classification Type.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

PromotionTypeId

The unique identifier of a Promotion Type.
First included in: Promotion (this entity)

Properties

Name	Value
displayName	Promotion Type ID
description	The unique identifier of a Promotion Type.
dataFormat	int32
isNullable	true

Traits

List of traits for the PromotionTypeId attribute are listed here.

is.dataFormat.integer
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{1EACD440-59F5-4182-B2EF-6F1F3D4CCC9E}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Promotion Type ID	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The unique identifier of a Promotion Type.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

PromotingPartyId

The unique identifier of a Party.
First included in: Promotion (this entity)

Properties

Name	Value
displayName	Promoting Party ID
description	The unique identifier of a Party.
dataFormat	int64
isNullable	true

Traits

List of traits for the PromotingPartyId attribute are listed here.

is.dataFormat.integer
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Promoting Party ID	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The unique identifier of a Party.	entity	a reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference Party.cdm.json/Party PartyId	entity	a reference to the constant entity holding the list of entity references

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{34794DDB-7421-4997-A58D-4A8234719443}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.dataFormat.integer
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

MaximumUnitsAvailable

The maximum number of units available to the promotion.
First included in: Promotion (this entity)

Properties

Name	Value
displayName	Maximum Units Available
description	The maximum number of units available to the promotion.
dataFormat	decimal
isNullable	true

Traits

List of traits for the MaximumUnitsAvailable attribute are listed here.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

Parameter	Value	Data type	Explanation
precision	"18"	integer	the total number of significant digits
scale	"2"	integer	the number of digits to the right of the decimal place

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{1DC01548-13F9-4C2D-846F-8D431CA9D5DF}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Maximum Units Available	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The maximum number of units available to the promotion.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

FreeShippingIndicator

Indicates whether the promotion includes free shipping.
First included in: Promotion (this entity)

Properties

Name	Value
displayName	Free Shipping Indicator
description	Indicates whether the promotion includes free shipping.
dataFormat	boolean
isNullable	true

Traits

List of traits for the FreeShippingIndicator attribute are listed here.

is.dataFormat.boolean
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{3F3CFCE0-B4DA-4925-B3F0-4A008D88A44B}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Free Shipping Indicator	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Indicates whether the promotion includes free shipping.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.boolean

ItemSku

The Stock Keeping Unit identifier, which is typically used for inventory-related activities.
First included in: Promotion (this entity)

Properties

Name	Value
displayName	Item SKU
description	The Stock Keeping Unit identifier, which is typically used for inventory-related activities.
dataFormat	string
maximumLength	40
isNullable	true

Traits

List of traits for the ItemSku attribute are listed here.

is.dataFormat.character
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{0FFE86E2-061B-4407-998E-AB8D498154B3}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Item SKU	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The Stock Keeping Unit identifier, which is typically used for inventory-related activities.	entity	a reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

Parameter	Value	Data type	Explanation
maximumLength	"40"	integer

is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

ItemCost

The cost associated with the item for the purpose of the promotion.
First included in: Promotion (this entity)

Properties

Name	Value
displayName	Item Cost
description	The cost associated with the item for the purpose of the promotion.
dataFormat	decimal
isNullable	true

Traits

List of traits for the ItemCost attribute are listed here.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

Parameter	Value	Data type	Explanation
precision	"18"	integer	the total number of significant digits
scale	"2"	integer	the number of digits to the right of the decimal place

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{02BDDE60-BDFA-4598-BFAD-A12DC417ED32}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Item Cost	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The cost associated with the item for the purpose of the promotion.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values