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
Indicates the number of an item (SKU) that are used in the packaging of the Item.
Note: This contains packaging and supplementary items such as documentation, coupons and free items but does not include any base item items.
Note: Changes in packaging does not necessarily result in a changed GTIN, UPC, etc. The following are a few of the many examples where a new GTIN, UPC, etc. would be required for the packaged item:
change of over 20% to a physical dimension, on any axis, or gross weight
change in the case or pallet orientation (even when There's no change in the base item)
change in the number of base item included on the pallet
free trial item included even though this does not change the GTIN, UPC, etc. of the base item
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.
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
"{77C1C6EE-99E6-4EAD-83E9-FB2926A400A5}"
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
"Inventory"
string
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Item Packaging Item
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.
The Stock Keeping Unit identifier, which is typically used for inventory-related activities.
First included in: ItemPackagingItem (this entity)
Properties
Name
Value
displayName
Item SKU
description
The Stock Keeping Unit identifier, which is typically used for inventory-related activities.
isPrimaryKey
true
dataFormat
string
maximumLength
40
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.
is.identifiedBy
Names a specific identity attribute to use with an entity.
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.
a reference to the constant entity holding the list of entity references
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
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
"{B40DA67F-8E31-482D-B4BA-E475B04D6C70}"
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.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.
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.
a reference to the constant entity holding the list of entity references
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Item Packaging 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 an Item Packaging.
entity
a reference to the constant entity holding the list of localized text
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
"{BB4E1446-4785-4A27-BD37-1DF746597B45}"
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.
The Stock Keeping Unit identifier, which is typically used for inventory-related activities.
First included in: ItemPackagingItem (this entity)
Properties
Name
Value
displayName
Packing Item SKU
description
The Stock Keeping Unit identifier, which is typically used for inventory-related activities.
isPrimaryKey
true
dataFormat
string
maximumLength
40
Traits
List of traits for the PackingItemSku 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.
is.identifiedBy
Names a specific identity attribute to use with an entity.
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.
a reference to the constant entity holding the list of entity references
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Packing 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
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
"{B41921A6-CE64-4FEB-BAE2-B5163F9F4AFD}"
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.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.
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
"{F4CEEB43-BB00-4596-8DFF-22176DBAF1D7}"
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
Item Packaging Item 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 effective end date or last date that the item and quantity is used in the item packaging.
entity
a reference to the constant entity holding the list of localized text
The effective end date or last date that the item and quantity is used in the item packaging.
First included in: ItemPackagingItem (this entity)
Properties
Name
Value
displayName
Item Packaging Item End Date
description
The effective end date or last date that the item and quantity is used in the item packaging.
dataFormat
date
isNullable
true
Traits
List of traits for the ItemPackagingItemEndDate 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
"{E5E30193-8EA5-49AE-B1BA-1B30ECF7F2DA}"
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 Packaging Item 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 effective end date or last date that the item and quantity is used in the item packaging.
entity
a reference to the constant entity holding the list of localized text
The unique identifier of a Package Component Type.
First included in: ItemPackagingItem (this entity)
Properties
Name
Value
displayName
Package Component Type ID
description
The unique identifier of a Package Component Type.
dataFormat
int32
isNullable
true
Traits
List of traits for the PackageComponentTypeId attribute are listed here.
is.dataFormat.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
Package Component 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 Package Component Type.
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.
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
"{1154305F-5403-4878-AD28-923BBF5F09D2}"
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.
The number of items contained in an item packaging.
First included in: ItemPackagingItem (this entity)
Properties
Name
Value
displayName
Item Packaging Item Quantity
description
The number of items contained in an item packaging.
dataFormat
decimal
isNullable
true
Traits
List of traits for the ItemPackagingItemQuantity 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
"{48A14F49-9B91-47FA-B85E-66A5015D0CF0}"
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 Packaging Item Quantity
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 number of items contained in an item packaging.
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
The amount of the deposit associated with the item packaging item.
First included in: ItemPackagingItem (this entity)
Properties
Name
Value
displayName
Deposit Amount
description
The amount of the deposit associated with the item packaging item.
dataFormat
decimal
isNullable
true
Traits
List of traits for the DepositAmount 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
"{AC40C3EB-1625-48F7-88DC-98CBFE9227A4}"
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
Deposit 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 the deposit associated with the item packaging item.
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
The ISO 4217 currency code.
First included in: ItemPackagingItem (this entity)
Properties
Name
Value
displayName
ISO Currency Code
description
The ISO 4217 currency code.
dataFormat
string
maximumLength
3
isNullable
true
Traits
List of traits for the IsoCurrencyCode 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.
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
ISO Currency Code
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 ISO 4217 currency code.
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
"3"
integer
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.
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
"{32179E25-15D4-4109-AFE6-3BBD5CBE8FE4}"
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.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.
The unique identifier of a Unit Of Measure.
First included in: ItemPackagingItem (this entity)
Properties
Name
Value
displayName
Unit Of Measure ID
description
The unique identifier of a Unit Of Measure.
dataFormat
int32
isNullable
true
Traits
List of traits for the UnitOfMeasureId attribute are listed here.
is.dataFormat.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
Unit Of Measure 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 Unit Of Measure.
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.
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
"{6825BD8C-F056-4BCA-B2BB-B1BCF00C8BD5}"
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.
The unique identifier of a material.
First included in: ItemPackagingItem (this entity)
Properties
Name
Value
displayName
Material ID
description
The unique identifier of a material.
dataFormat
int32
isNullable
true
Traits
List of traits for the MaterialId attribute are listed here.
is.dataFormat.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
Material 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 material.
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.
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
"{A80B7540-1CA2-4B52-84AD-3CF9C50ECD80}"
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.
A note, comment or additional information regarding the item packaging.
First included in: ItemPackagingItem (this entity)
Properties
Name
Value
displayName
Item Packaging Note
description
A note, comment or additional information regarding the item packaging.
dataFormat
string
maximumLength
2048
isNullable
true
Traits
List of traits for the ItemPackagingNote 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
"{D20F9E66-CFC9-4BC2-850A-8B06531124C2}"
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 Packaging Note
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 note, comment or additional information regarding the item packaging.
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.