Dela via


Shipment Item 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

ParameterValueData typeExplanation
versionNumber"4.3"stringsemantic version number of the entity

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBase entity from which all Industry Data Model entities are derived.
enThe lines on a shipment each consisting of one item.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
attributeShipmentItem/(resolvedAttributes)/ShipmentItemNumberattribute

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

ParameterValueData typeExplanation
versionNumber"1.2.3"string

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

ParameterValueData typeExplanation
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.

ParameterValueData typeExplanation
identifier"{5E4A0C20-7D9D-4906-98AF-73E54494647A}"stringThe 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.

ParameterValueData typeExplanation
name"Shipping"string

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enShipment Item
entitya 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.

ParameterValueData typeExplanation
level"resolved"stringPossible values: logical, composition, resolved

Attributes

Name Description First Included in Instance
ShipmentId The unique identifier of a Shipment. ShipmentItem
ShipmentItemNumber The shipment line number. ShipmentItem
PackingInstructions Packing instructions for the associated shipped item. ShipmentItem
HandlingInstructions Written instructions provided by the shipper/manufacturer and designed toensure proper handling of the cargo. This can be in the form of marks (see Cautionary Markings) on the cargo or packaging itself or in a separate document such as the bill of lading. ShipmentItem
CountryOfManufactureName The country of manufacture of the item. ShipmentItem
ShippedItemQuantity The quantity of items shipped. ShipmentItem
OrderId The unique number that identifies an Order. ShipmentItem
OrderLineNumber The number that identifies the Order Line Item. ShipmentItem
TransactionId The unique identifier of a Transaction. ShipmentItem
TransactionLineItemId The unique identifier that identifies the Transaction Line Item. ShipmentItem
ItemNetWeight The weight of the Item. ShipmentItem
WeightUnitOfMeasureId The unique identifier of a Unit Of Measure. ShipmentItem
ItemLength The length of the Item. ShipmentItem
ItemWidth The width of the Item. ShipmentItem
ItemHeight The height of the Item. ShipmentItem
LengthWidthHeightUnitOfMeasureId The unique identifier of a Unit Of Measure. ShipmentItem
Volume The volume of the shipment item. ShipmentItem
VolumeUnitOfMeasureId The unique identifier of a Unit Of Measure. ShipmentItem
PerItemWeight The individual or per item weight of an item. ShipmentItem
TotalQuantityItemWeight The total weight of all the items without additional packaging weights added. ShipmentItem
PerItemPackagedWeight The weight of each item packaged for shipment. ShipmentItem
TotalQuantityPackagedWeight The total weight of all items packaged for shipment. ShipmentItem
PerItemDimensionalWeight The per item dimensional weight, which is the conversion of the cubic space of a shipment into pounds. Commonly referred to as dim weight. The international term is volume weight. ShipmentItem
TotalQuantityDimensionalWeight The dimensional weight of all items, which is the conversion of the cubic space of a shipment into pounds. Commonly referred to as dim weight. T ShipmentItem
ActualGrossShipmentWeight The weight of the shipment including all packing, blocking, platforms, special bracing, etc., if required. (includes weight of unit load device, when applicable.) ShipmentItem
TotalItemChargeableWeight The weight of the shipment used in determining airfreight charges. The chargeable weight may be the dimensional weight, or on container shipments, the gross weight of the shipment less the tare weight of the container. ShipmentItem
TotalItemsDensity Density is weight per unit of volume. Density is computer by dividing a shipments weight by its cubic volume. Generally expressed in pounds per cubic foot in the U.S. ShipmentItem
TotalItemsDimensionalWeight A computed weight based on a minimum density requirement. It's used to determine the freight charges for low dense shipments. It's computed by dividing the shipment volume by the minimum density requirement. The Dimensional Weight Rule was developed to insure fair compensation for low-density shipments. When a given shipment falls below the minimum density requirement, dimensional weight rather than actual weight is used to calculate the transportation charged. Minimum density requirements vary from carrier to carrier. Some carriers give discounts for shipments of high-density goods. ShipmentItem
ShipmentItemNetWeight Weight of the goods alone without any immediate wrappings, e.g., the weight of the contents of a tin can without the weight of the can. ShipmentItem
PerUnitDeclaredValueForCarriageAmount The value of goods declared to the carrier by the shipper for the purposes of determining charges of or establishing the limit of the carrier's liability for loss, damage, or delay. See Valuation Charges.The value of goods declared to the carrier by the shipper for the purposes of determining charges or establishing the limit of the carrier's liability for loss, damage, or delay. ShipmentItem
PerUnitDeclaredValueForCustomsAmount Declared Value for Customs The selling price of the contents or the replacement cost if the contents are not for resale. The amount mush be equal to or greater than the declared value. ShipmentItem
SpecialHandlingStatement A statement regarding any special handling requirements. ShipmentItem
EstimatedValue The estimated value of the shipment item(s). ShipmentItem
WarningInformationText The text of the warning label, if any, appearing upon the shipment item. ShipmentItem
AwkwardCargoIndicator Cargo of irregular size that can either be containerized (packed in container) or non-containerized (without equipment associated with) during transportation. It requires prior approval on a case by case basis before confirmation of booking. ShipmentItem
BreakBulkCargoIndicator Goods shipped loose in the vessel's hold and not in a container. ShipmentItem
PerishableCargoIndicator Cargo subject to decay or deterioration. ShipmentItem
BreakBulkItemIndicator Cargo which is not containerized due to its weight and/or size e.g. steel pipes, boats etc. ShipmentItem
DangerousGoodsIndicator Items capable of presenting a risk to the health or safety of people or property when shipped.The term used by I.M.C.O. for hazardous materials which are capable of posing a significant risk to health, safety or property while being transported.The United Nation's official term for Hazardous Materials. Articles or substances which are capable of posing a significant risk to the health or safety of the general public when transported by air and which are classified according to the most current editions of the ICAO Technical Instructions for the Safe Transport of Dangerous Goods by Air and the IATA Dangerous Goods Regulations. See Hazardous Materials. ShipmentItem
HazardousMaterialHazmatIndicator Hazardous materials (Hazmat) The U.S. Government's official term for Dangerous Goods. Items of freight that are inherently harmful and classified under Title 49, Code of Federal Regulations (CFR). Hazardous Materials may only be transported under certain conditions relative to packaging, quantity carried, airplane type, location on board the airplane, etc., and in conformance with applicable rules. Also see Dangerous Goods. ShipmentItem
OversizedCargoIndicator Unusually large or heavy cargo that will not fit in the cargo areas of standard-body freighters or passenger airplanes. Cargo the exceeds the standard dimensions of common ULDs ShipmentItem
BulkCargoIndicator Loose cargo, not unitized, not loaded in containers or on pallets.Air Cargo: Cargo loaded as loose pieces into airplane compartments. ShipmentItem
ArticlesOfExtraordinaryValueIndicator Commodities identified as high value items.Commodities identified as high-value items that require advance arrangements and special handling. ShipmentItem
AttractiveMerchandiseIndicator Commodities such as cameras, radios, electronic equipment, etc., that are handled as high-value shipments but not rated the same. ShipmentItem
PerishableItemIndicator A commodity possessing a quality or condition making it conducive to deterioration, spoilage, or death. Examples of this are seafood, flowers, fruits, vegetables and other perishable foodstuff. ShipmentItem
SerializedItemIndicator Indicates that the Item is serialized. ShipmentItem
TrackSerialNumberIndicator Indicates that the Item must be tracked by Serial Number. ShipmentItem
HoldForPickUpAtDestinationIndicator Freight to be held at the carrier's destination location for pick-up by the recipient. See also Notify on Arrival. ShipmentItem
CyCfsCargoIndicator Cargo loaded in a full container by a shipper at origin, delivered to pier facility at destination, and then devanned by the carrier for loose pick up. ShipmentItem
CyCyCargoIndicator Cargo loaded by the shipper in a full container at origin and delivered to the carrier's terminal at destination for pick up intact by consignee. ShipmentItem
DryCargoIndicator Cargo that does not require temperature control. ShipmentItem
PersonalEffectivesItemsIndicator Shipments of used personal goods not for resale. ShipmentItem
BondedFreightIndicator Freight moving under a bond to U.S. Customs or to the Internal Revenue Service, and to be delivered only under stated conditions. ShipmentItem
BulkCargoShipmentItemIndicator Not in packages or containers; shipped loose in the hold of a ship without mark and count." Grain, coal and sulfur are usually bulk freight. ShipmentItem
ControlledAtmosphereRequiredIndicator An atmosphere in which oxygen, carbon dioxide and nitrogen concentrations are regulated, as well as temperature and humidity. ShipmentItem
ContainerizableCargoIndicator Cargo that will fit into a container and result in an economical shipment. ShipmentItem
DangerousAndHazardousCargoIndicator Abbreviation for "Dangerous and Hazardous" cargo. ShipmentItem
LoosePackingShipmentItemIndicator Without packing. ShipmentItem
OverheightCargoIndicator Cargo more than eight feet high which thus cannot fit into a standard container. ShipmentItem
LooseCargoIndicator Air cargo delivered to an airline as separate packages and loaded and unloaded onto airplanes (or ULDs) by airline employees, and then delivered as separate pieces to the consigned. See Bulk Cargo. ShipmentItem
BandedPackingIndicator Cargo wrapped and/or secured with metal or plastic strips ShipmentItem
GuaranteedFreightIndicator Freight charges which are not paid to the carrier in advance of shipment but which the shipper promises to pay within a specified period of time. Guaranteed freight is considered earned by the carrier at the time of shipment and must be paid even if the cargo is undelivered or delivered damaged. Guaranteed freight is not refundable by the carrier even if they do not deliver the cargo except through subrogation proceedings. ShipmentItem
ItemSafetyClassificationId The unique identifier of an Item Safety Classification. ShipmentItem
IdentificationMethodId The unique identifier of the Identification Method. ShipmentItem
FreightConditionId The unique identifier of an descriptive Freight Condition. ShipmentItem
HazardSeverityCategoryId The unique identifier of a Hazard Severity Category. ShipmentItem
CommodityTypeId The unique identifier of a Commodity Type. ShipmentItem
HtsScheduleBCode The unique code identifying items within the HTS Schedule B. ShipmentItem
HarmonizedTariffScheduleCode The unique identifier of an HTS Code. ShipmentItem
EccnNumber The unique identifier of a ECCN. ShipmentItem
ItemSku The Stock Keeping Unit identifier, which is typically used for inventory-related activities. ShipmentItem
CargoTypeId The unique identifier of a Cargo Type. ShipmentItem
LandedCost The total cost of the item once it has arrived at the buyer's door. ShipmentItem
PalletTypeId The unique identifier of a Pallet Type. ShipmentItem
PalletSerialNumber The serial number of the Pallet. ShipmentItem
IncotermId The unique identifier of a Incoterm. ShipmentItem
ContainerId The unique identifier of the container.This would be the 'serial number' of the container if It's serialized. ShipmentItem
PoNumber The unique identifier of a Purchase Order. ShipmentItem
PoLineItemNumber The unique identifier of a PO line item. ShipmentItem

ShipmentId

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

Properties

NameValue
displayNameShipment ID
descriptionThe unique identifier of a Shipment.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the ShipmentId attribute are listed here.

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

ParameterValueData typeExplanation
attributeShipmentItem/(resolvedAttributes)/ShipmentIdattribute

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
Shipment.cdm.json/ShipmentShipmentId
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enShipment ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Shipment.
entitya 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.

ParameterValueData typeExplanation
identifier"{9275E253-FB90-41C0-91E9-6345ED316691}"stringThe 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

ShipmentItemNumber

The shipment line number.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameShipment Item Number
descriptionThe shipment line number.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the ShipmentItemNumber attribute are listed here.

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

ParameterValueData typeExplanation
attributeShipmentItem/(resolvedAttributes)/ShipmentItemNumberattribute

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.

ParameterValueData typeExplanation
identifier"{2D5EA12D-F5EC-4EFA-A702-046FC0B82A9B}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enShipment Item Number
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe shipment line number.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

PackingInstructions

Packing instructions for the associated shipped item.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNamePacking Instructions
descriptionPacking instructions for the associated shipped item.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

List of traits for the PackingInstructions 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.

ParameterValueData typeExplanation
identifier"{7108C5F6-3C65-4355-A298-9761D6A0907C}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPacking Instructions
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPacking instructions for the associated shipped item.
entitya reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

ParameterValueData typeExplanation
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.

HandlingInstructions

Written instructions provided by the shipper/manufacturer and designed to ensure proper handling of the cargo. This can be in the form of marks (see Cautionary Markings) on the cargo or packaging itself or in a separate document such as the bill of lading.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameHandling Instructions
descriptionWritten instructions provided by the shipper/manufacturer and designed to ensure proper handling of the cargo. This can be in the form of marks (see Cautionary Markings) on the cargo or packaging itself or in a separate document such as the bill of lading.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

List of traits for the HandlingInstructions 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.

ParameterValueData typeExplanation
identifier"{54BFD191-5C67-44A9-A7E3-C54CA3DBA0A3}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enHandling Instructions
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enWritten instructions provided by the shipper/manufacturer and designed to ensure proper handling of the cargo. This can be in the form of marks (see Cautionary Markings) on the cargo or packaging itself or in a separate document such as the bill of lading.
entitya reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

ParameterValueData typeExplanation
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.

CountryOfManufactureName

The country of manufacture of the item.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameCountry Of Manufacture Name
descriptionThe country of manufacture of the item.
dataFormatstring
maximumLength256
isNullabletrue

Traits

List of traits for the CountryOfManufactureName 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.

ParameterValueData typeExplanation
identifier"{31F50BCC-E05B-4DE6-B790-7FD6DC60967A}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCountry Of Manufacture Name
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe country of manufacture of the item.
entitya reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

ParameterValueData typeExplanation
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.

ShippedItemQuantity

The quantity of items shipped.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameShipped Item Quantity
descriptionThe quantity of items shipped.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the ShippedItemQuantity attribute are listed here.

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

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"2"integerthe 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.

ParameterValueData typeExplanation
identifier"{0F202E22-0F72-4B77-8A5D-EF98B7A3D4D1}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enShipped Item Quantity
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe quantity of items shipped.
entitya 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

OrderId

The unique number that identifies an Order.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameOrder ID
descriptionThe unique number that identifies an Order.
dataFormatint64
isNullabletrue

Traits

List of traits for the OrderId 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.

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.

ParameterValueData typeExplanation
identifier"{17D47D6D-4666-4EA5-ADA2-AD037B2AEEE6}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOrder ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique number that identifies an Order.
entitya reference to the constant entity holding the list of localized text

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.

OrderLineNumber

The number that identifies the Order Line Item.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameOrder Line Number
descriptionThe number that identifies the Order Line Item.
dataFormatint32
isNullabletrue

Traits

List of traits for the OrderLineNumber 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.

ParameterValueData typeExplanation
identifier"{10B5BE31-61A7-446D-96A9-B2329E213A03}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOrder Line Number
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe number that identifies the Order Line Item.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

TransactionId

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

Properties

NameValue
displayNameTransaction ID
descriptionThe unique identifier of a Transaction.
dataFormatint64
isNullabletrue

Traits

List of traits for the TransactionId 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.

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.

ParameterValueData typeExplanation
identifier"{4A2DA06A-6776-419A-B683-C6959D24F520}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTransaction ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Transaction.
entitya reference to the constant entity holding the list of localized text

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.

TransactionLineItemId

The unique identifier that identifies the Transaction Line Item.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameTransaction Line Item ID
descriptionThe unique identifier that identifies the Transaction Line Item.
dataFormatint32
isNullabletrue

Traits

List of traits for the TransactionLineItemId 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.

ParameterValueData typeExplanation
identifier"{1139C343-DF0A-4F9F-B9F0-B52FBE33E528}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTransaction Line Item ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier that identifies the Transaction Line Item.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

ItemNetWeight

The weight of the Item.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameItem Net Weight
descriptionThe weight of the Item.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the ItemNetWeight attribute are listed here.

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

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"8"integerthe 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.

ParameterValueData typeExplanation
identifier"{2A559A2F-1C39-429B-9490-68F1065E1BC9}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enItem Net Weight
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe weight of the Item.
entitya 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

WeightUnitOfMeasureId

The unique identifier of a Unit Of Measure.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameWeight Unit Of Measure ID
descriptionThe unique identifier of a Unit Of Measure.
dataFormatint32
isNullabletrue

Traits

List of traits for the WeightUnitOfMeasureId 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enWeight Unit Of Measure ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Unit Of Measure.
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
UnitOfMeasure.cdm.json/UnitOfMeasureUnitOfMeasureId
entitya 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.

ParameterValueData typeExplanation
identifier"{65395D00-C822-4956-9D5C-7A7B904C9AC2}"stringThe 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

ItemLength

The length of the Item.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameItem Length
descriptionThe length of the Item.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the ItemLength attribute are listed here.

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

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"8"integerthe 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.

ParameterValueData typeExplanation
identifier"{111367E0-D1C3-4FD5-9BF9-B9F572E055C0}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enItem Length
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe length of the Item.
entitya 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

ItemWidth

The width of the Item.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameItem Width
descriptionThe width of the Item.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the ItemWidth attribute are listed here.

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

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"8"integerthe 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.

ParameterValueData typeExplanation
identifier"{0546B834-64A7-4625-9D5A-139B6CD1F2E3}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enItem Width
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe width of the Item.
entitya 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

ItemHeight

The height of the Item.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameItem Height
descriptionThe height of the Item.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the ItemHeight attribute are listed here.

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

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"8"integerthe 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.

ParameterValueData typeExplanation
identifier"{0D438C51-B286-4590-B30A-75411771796C}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enItem Height
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe height of the Item.
entitya 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

LengthWidthHeightUnitOfMeasureId

The unique identifier of a Unit Of Measure.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameLength/Width/Height Unit Of Measure ID
descriptionThe unique identifier of a Unit Of Measure.
dataFormatint32
isNullabletrue

Traits

List of traits for the LengthWidthHeightUnitOfMeasureId 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enLength/Width/Height Unit Of Measure ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Unit Of Measure.
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
UnitOfMeasure.cdm.json/UnitOfMeasureUnitOfMeasureId
entitya 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.

ParameterValueData typeExplanation
identifier"{0BEE4900-E448-4B01-BD49-E653E1D1BBE0}"stringThe 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

Volume

The volume of the shipment item.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameVolume
descriptionThe volume of the shipment item.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the Volume attribute are listed here.

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

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"8"integerthe 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.

ParameterValueData typeExplanation
identifier"{29A92CD7-D86A-4FA8-8B78-BED111B203EB}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enVolume
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe volume of the shipment item.
entitya 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

VolumeUnitOfMeasureId

The unique identifier of a Unit Of Measure.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameVolume Unit Of Measure ID
descriptionThe unique identifier of a Unit Of Measure.
dataFormatint32
isNullabletrue

Traits

List of traits for the VolumeUnitOfMeasureId 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enVolume Unit Of Measure ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Unit Of Measure.
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
UnitOfMeasure.cdm.json/UnitOfMeasureUnitOfMeasureId
entitya 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.

ParameterValueData typeExplanation
identifier"{5AD730C6-6873-49BD-B8FA-6BEC99236615}"stringThe 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

PerItemWeight

The individual or per item weight of an item.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNamePer Item Weight
descriptionThe individual or per item weight of an item.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the PerItemWeight attribute are listed here.

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

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"8"integerthe 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.

ParameterValueData typeExplanation
identifier"{2673F6DF-FCF7-4899-BE19-C24561913AA0}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPer Item Weight
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe individual or per item weight of an item.
entitya 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

TotalQuantityItemWeight

The total weight of all the items without additional packaging weights added.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameTotal Quantity Item Weight
descriptionThe total weight of all the items without additional packaging weights added.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the TotalQuantityItemWeight attribute are listed here.

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

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"8"integerthe 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.

ParameterValueData typeExplanation
identifier"{CEC34720-4381-4550-BD33-8F059BC0C5A9}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTotal Quantity Item Weight
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe total weight of all the items without additional packaging weights added.
entitya 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

PerItemPackagedWeight

The weight of each item packaged for shipment.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNamePer Item Packaged Weight
descriptionThe weight of each item packaged for shipment.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the PerItemPackagedWeight attribute are listed here.

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

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"8"integerthe 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.

ParameterValueData typeExplanation
identifier"{238504D2-EB6A-435C-94BA-9B1BDAEC3AE5}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPer Item Packaged Weight
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe weight of each item packaged for shipment.
entitya 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

TotalQuantityPackagedWeight

The total weight of all items packaged for shipment.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameTotal Quantity Packaged Weight
descriptionThe total weight of all items packaged for shipment.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the TotalQuantityPackagedWeight attribute are listed here.

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

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"8"integerthe 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.

ParameterValueData typeExplanation
identifier"{0ED8E35E-6081-4FD5-B8DC-7D2949E00292}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTotal Quantity Packaged Weight
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe total weight of all items packaged for shipment.
entitya 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

PerItemDimensionalWeight

The per item dimensional weight, which is the conversion of the cubic space of a shipment into pounds. Commonly referred to as dim weight. The international term is volume weight.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNamePer Item Dimensional Weight
descriptionThe per item dimensional weight, which is the conversion of the cubic space of a shipment into pounds. Commonly referred to as dim weight. The international term is volume weight.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the PerItemDimensionalWeight attribute are listed here.

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

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"8"integerthe 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.

ParameterValueData typeExplanation
identifier"{32AC98BD-C834-4F88-9DEF-25A36B884122}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPer Item Dimensional Weight
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe per item dimensional weight, which is the conversion of the cubic space of a shipment into pounds. Commonly referred to as dim weight. The international term is volume weight.
entitya 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

TotalQuantityDimensionalWeight

The dimensional weight of all items, which is the conversion of the cubic space of a shipment into pounds. Commonly referred to as dim weight. T
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameTotal Quantity Dimensional Weight
descriptionThe dimensional weight of all items, which is the conversion of the cubic space of a shipment into pounds. Commonly referred to as dim weight. T
dataFormatdecimal
isNullabletrue

Traits

List of traits for the TotalQuantityDimensionalWeight attribute are listed here.

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

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"8"integerthe 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.

ParameterValueData typeExplanation
identifier"{37304A40-CFDA-4BDC-BD0E-F0F2E7E6D57B}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTotal Quantity Dimensional Weight
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe dimensional weight of all items, which is the conversion of the cubic space of a shipment into pounds. Commonly referred to as dim weight. T
entitya 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

ActualGrossShipmentWeight

The weight of the shipment including all packing, blocking, platforms, special bracing, etc., if required. (includes weight of unit load device, when applicable.)
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameActual Gross Shipment Weight
descriptionThe weight of the shipment including all packing, blocking, platforms, special bracing, etc., if required. (includes weight of unit load device, when applicable.)
dataFormatdecimal
isNullabletrue

Traits

List of traits for the ActualGrossShipmentWeight attribute are listed here.

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

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"8"integerthe 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.

ParameterValueData typeExplanation
identifier"{33AD4B23-4A25-46B9-9445-C3F15DAB9902}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enActual Gross Shipment Weight
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe weight of the shipment including all packing, blocking, platforms, special bracing, etc., if required. (includes weight of unit load device, when applicable.)
entitya 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

TotalItemChargeableWeight

The weight of the shipment used in determining airfreight charges. The chargeable weight may be the dimensional weight, or on container shipments, the gross weight of the shipment less the tare weight of the container.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameTotal Item Chargeable Weight
descriptionThe weight of the shipment used in determining airfreight charges. The chargeable weight may be the dimensional weight, or on container shipments, the gross weight of the shipment less the tare weight of the container.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the TotalItemChargeableWeight attribute are listed here.

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

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"8"integerthe 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.

ParameterValueData typeExplanation
identifier"{362CC905-D07F-44FB-98F7-CB7DA77B03C5}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTotal Item Chargeable Weight
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe weight of the shipment used in determining airfreight charges. The chargeable weight may be the dimensional weight, or on container shipments, the gross weight of the shipment less the tare weight of the container.
entitya 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

TotalItemsDensity

Density is weight per unit of volume. Density is computer by dividing a shipments weight by its cubic volume. Generally expressed in pounds per cubic foot in the U.S.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameTotal Items Density
descriptionDensity is weight per unit of volume. Density is computer by dividing a shipments weight by its cubic volume. Generally expressed in pounds per cubic foot in the U.S.
dataFormatint32
isNullabletrue

Traits

List of traits for the TotalItemsDensity 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.

ParameterValueData typeExplanation
identifier"{07BAEB38-1AC8-4712-8808-6C5ADDBFC7EC}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTotal Items Density
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDensity is weight per unit of volume. Density is computer by dividing a shipments weight by its cubic volume. Generally expressed in pounds per cubic foot in the U.S.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

TotalItemsDimensionalWeight

A computed weight based on a minimum density requirement. It's used to determine the freight charges for low dense shipments. It's computed by dividing the shipment volume by the minimum density requirement. The Dimensional Weight Rule was developed to insure fair compensation for low-density shipments. When a given shipment falls below the minimum density requirement, dimensional weight rather than actual weight is used to calculate the transportation charged. Minimum density requirements vary from carrier to carrier. Some carriers give discounts for shipments of high-density goods.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameTotal Items Dimensional Weight
descriptionA computed weight based on a minimum density requirement. It's used to determine the freight charges for low dense shipments. It's computed by dividing the shipment volume by the minimum density requirement. The Dimensional Weight Rule was developed to insure fair compensation for low-density shipments. When a given shipment falls below the minimum density requirement, dimensional weight rather than actual weight is used to calculate the transportation charged. Minimum density requirements vary from carrier to carrier. Some carriers give discounts for shipments of high-density goods.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the TotalItemsDimensionalWeight attribute are listed here.

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

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"8"integerthe 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.

ParameterValueData typeExplanation
identifier"{109F234C-2A85-491A-A7CC-970DB5A80DB3}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTotal Items Dimensional Weight
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enA computed weight based on a minimum density requirement. It's used to determine the freight charges for low dense shipments. It's computed by dividing the shipment volume by the minimum density requirement. The Dimensional Weight Rule was developed to insure fair compensation for low-density shipments. When a given shipment falls below the minimum density requirement, dimensional weight rather than actual weight is used to calculate the transportation charged. Minimum density requirements vary from carrier to carrier. Some carriers give discounts for shipments of high-density goods.
entitya 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

ShipmentItemNetWeight

Weight of the goods alone without any immediate wrappings, e.g., the weight of the contents of a tin can without the weight of the can.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameShipment Item Net Weight
descriptionWeight of the goods alone without any immediate wrappings, e.g., the weight of the contents of a tin can without the weight of the can.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the ShipmentItemNetWeight attribute are listed here.

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

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"8"integerthe 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.

ParameterValueData typeExplanation
identifier"{277D2467-D1BF-43CC-8BFB-F64949E96AEA}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enShipment Item Net Weight
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enWeight of the goods alone without any immediate wrappings, e.g., the weight of the contents of a tin can without the weight of the can.
entitya 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

PerUnitDeclaredValueForCarriageAmount

The value of goods declared to the carrier by the shipper for the purposes of determining charges of or establishing the limit of the carrier's liability for loss, damage, or delay. See Valuation Charges.

The value of goods declared to the carrier by the shipper for the purposes of determining charges or establishing the limit of the carrier's liability for loss, damage, or delay.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNamePer Unit Declared Value For Carriage Amount
descriptionThe value of goods declared to the carrier by the shipper for the purposes of determining charges of or establishing the limit of the carrier's liability for loss, damage, or delay. See Valuation Charges.

The value of goods declared to the carrier by the shipper for the purposes of determining charges or establishing the limit of the carrier's liability for loss, damage, or delay.

dataFormatdecimal
isNullabletrue

Traits

List of traits for the PerUnitDeclaredValueForCarriageAmount attribute are listed here.

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

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"2"integerthe 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.

ParameterValueData typeExplanation
identifier"{02740421-2A19-4D31-89FD-E82C6934A25C}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPer Unit Declared Value For Carriage Amount
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe value of goods declared to the carrier by the shipper for the purposes of determining charges of or establishing the limit of the carrier's liability for loss, damage, or delay. See Valuation Charges.

The value of goods declared to the carrier by the shipper for the purposes of determining charges or establishing the limit of the carrier's liability for loss, damage, or delay.

entitya 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

PerUnitDeclaredValueForCustomsAmount

Declared Value for Customs The selling price of the contents or the replacement cost if the contents are not for resale. The amount mush be equal to or greater than the declared value.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNamePer Unit Declared Value For Customs Amount
descriptionDeclared Value for Customs The selling price of the contents or the replacement cost if the contents are not for resale. The amount mush be equal to or greater than the declared value.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the PerUnitDeclaredValueForCustomsAmount attribute are listed here.

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

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"2"integerthe 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.

ParameterValueData typeExplanation
identifier"{1D7F591A-8421-4101-87E8-11EA3A4CB483}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPer Unit Declared Value For Customs Amount
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDeclared Value for Customs The selling price of the contents or the replacement cost if the contents are not for resale. The amount mush be equal to or greater than the declared value.
entitya 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

SpecialHandlingStatement

A statement regarding any special handling requirements.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameSpecial Handling Statement
descriptionA statement regarding any special handling requirements.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

List of traits for the SpecialHandlingStatement 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.

ParameterValueData typeExplanation
identifier"{2C947400-E63C-4D47-BC90-B4734F27A629}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSpecial Handling Statement
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enA statement regarding any special handling requirements.
entitya reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

ParameterValueData typeExplanation
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.

EstimatedValue

The estimated value of the shipment item(s).
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameEstimated Value
descriptionThe estimated value of the shipment item(s).
dataFormatdecimal
isNullabletrue

Traits

List of traits for the EstimatedValue attribute are listed here.

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

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"2"integerthe 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.

ParameterValueData typeExplanation
identifier"{C53EB474-C9A8-449A-BF8F-56B873A73E8C}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enEstimated Value
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe estimated value of the shipment item(s).
entitya 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

WarningInformationText

The text of the warning label, if any, appearing upon the shipment item.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameWarning Information Text
descriptionThe text of the warning label, if any, appearing upon the shipment item.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

List of traits for the WarningInformationText 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.

ParameterValueData typeExplanation
identifier"{391F046D-D77D-4E98-8072-DC583660598A}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enWarning Information Text
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe text of the warning label, if any, appearing upon the shipment item.
entitya reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

ParameterValueData typeExplanation
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.

AwkwardCargoIndicator

Cargo of irregular size that can either be containerized (packed in container) or non-containerized (without equipment associated with) during transportation. It requires prior approval on a case by case basis before confirmation of booking.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameAwkward Cargo Indicator
descriptionCargo of irregular size that can either be containerized (packed in container) or non-containerized (without equipment associated with) during transportation. It requires prior approval on a case by case basis before confirmation of booking.
dataFormatboolean
isNullabletrue

Traits

List of traits for the AwkwardCargoIndicator 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.

ParameterValueData typeExplanation
identifier"{073D5717-B5DB-4770-8D2E-2CD6DEE33F5B}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAwkward Cargo Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCargo of irregular size that can either be containerized (packed in container) or non-containerized (without equipment associated with) during transportation. It requires prior approval on a case by case basis before confirmation of booking.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

BreakBulkCargoIndicator

Goods shipped loose in the vessel's hold and not in a container.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameBreak-Bulk Cargo Indicator
descriptionGoods shipped loose in the vessel's hold and not in a container.
dataFormatboolean
isNullabletrue

Traits

List of traits for the BreakBulkCargoIndicator 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.

ParameterValueData typeExplanation
identifier"{9C19BC7E-8C6D-479F-8E91-870F4617E553}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBreak-Bulk Cargo Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enGoods shipped loose in the vessel's hold and not in a container.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

PerishableCargoIndicator

Cargo subject to decay or deterioration.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNamePerishable Cargo Indicator
descriptionCargo subject to decay or deterioration.
dataFormatboolean
isNullabletrue

Traits

List of traits for the PerishableCargoIndicator 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.

ParameterValueData typeExplanation
identifier"{6BA515D9-FF84-4732-9430-99D95817A9F1}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPerishable Cargo Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCargo subject to decay or deterioration.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

BreakBulkItemIndicator

Cargo which is not containerized due to its weight and/or size e.g. steel pipes, boats etc.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameBreak Bulk Item Indicator
descriptionCargo which is not containerized due to its weight and/or size e.g. steel pipes, boats etc.
dataFormatboolean
isNullabletrue

Traits

List of traits for the BreakBulkItemIndicator 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.

ParameterValueData typeExplanation
identifier"{2C5AE84B-A9BA-4077-9144-C4EB4E17B291}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBreak Bulk Item Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCargo which is not containerized due to its weight and/or size e.g. steel pipes, boats etc.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

DangerousGoodsIndicator

Items capable of presenting a risk to the health or safety of people or property when shipped.

The term used by I.M.C.O. for hazardous materials which are capable of posing a significant risk to health, safety or property while being transported.

The United Nation's official term for Hazardous Materials. Articles or substances which are capable of posing a significant risk to the health or safety of the general public when transported by air and which are classified according to the most current editions of the ICAO Technical Instructions for the Safe Transport of Dangerous Goods by Air and the IATA Dangerous Goods Regulations. See Hazardous Materials.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameDangerous Goods Indicator
descriptionItems capable of presenting a risk to the health or safety of people or property when shipped.

The term used by I.M.C.O. for hazardous materials which are capable of posing a significant risk to health, safety or property while being transported.

The United Nation's official term for Hazardous Materials. Articles or substances which are capable of posing a significant risk to the health or safety of the general public when transported by air and which are classified according to the most current editions of the ICAO Technical Instructions for the Safe Transport of Dangerous Goods by Air and the IATA Dangerous Goods Regulations. See Hazardous Materials.

dataFormatboolean
isNullabletrue

Traits

List of traits for the DangerousGoodsIndicator 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.

ParameterValueData typeExplanation
identifier"{375C7F3B-D866-4396-ACB9-A77EC81969F6}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDangerous Goods Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enItems capable of presenting a risk to the health or safety of people or property when shipped.

The term used by I.M.C.O. for hazardous materials which are capable of posing a significant risk to health, safety or property while being transported.

The United Nation's official term for Hazardous Materials. Articles or substances which are capable of posing a significant risk to the health or safety of the general public when transported by air and which are classified according to the most current editions of the ICAO Technical Instructions for the Safe Transport of Dangerous Goods by Air and the IATA Dangerous Goods Regulations. See Hazardous Materials.

entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

HazardousMaterialHazmatIndicator

Hazardous materials (Hazmat) The U.S. Government's official term for Dangerous Goods. Items of freight that are inherently harmful and classified under Title 49, Code of Federal Regulations (CFR). Hazardous Materials may only be transported under certain conditions relative to packaging, quantity carried, airplane type, location on board the airplane, etc., and in conformance with applicable rules. Also see Dangerous Goods.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameHazardous Material HAZMAT Indicator
descriptionHazardous materials (Hazmat) The U.S. Government's official term for Dangerous Goods. Items of freight that are inherently harmful and classified under Title 49, Code of Federal Regulations (CFR). Hazardous Materials may only be transported under certain conditions relative to packaging, quantity carried, airplane type, location on board the airplane, etc., and in conformance with applicable rules. Also see Dangerous Goods.
dataFormatboolean
isNullabletrue

Traits

List of traits for the HazardousMaterialHazmatIndicator 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.

ParameterValueData typeExplanation
identifier"{07C50CFA-2D74-4450-B0E4-C12ED316C823}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enHazardous Material HAZMAT Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enHazardous materials (Hazmat) The U.S. Government's official term for Dangerous Goods. Items of freight that are inherently harmful and classified under Title 49, Code of Federal Regulations (CFR). Hazardous Materials may only be transported under certain conditions relative to packaging, quantity carried, airplane type, location on board the airplane, etc., and in conformance with applicable rules. Also see Dangerous Goods.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

OversizedCargoIndicator

Unusually large or heavy cargo that will not fit in the cargo areas of standard-body freighters or passenger airplanes. Cargo the exceeds the standard dimensions of common ULDs
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameOversized Cargo Indicator
descriptionUnusually large or heavy cargo that will not fit in the cargo areas of standard-body freighters or passenger airplanes. Cargo the exceeds the standard dimensions of common ULDs
dataFormatboolean
isNullabletrue

Traits

List of traits for the OversizedCargoIndicator 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.

ParameterValueData typeExplanation
identifier"{09626A3E-96B4-4AAB-9BDC-CD1690B06FC0}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOversized Cargo Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnusually large or heavy cargo that will not fit in the cargo areas of standard-body freighters or passenger airplanes. Cargo the exceeds the standard dimensions of common ULDs
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

BulkCargoIndicator

Loose cargo, not unitized, not loaded in containers or on pallets.

Air Cargo: Cargo loaded as loose pieces into airplane compartments.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameBulk Cargo Indicator
descriptionLoose cargo, not unitized, not loaded in containers or on pallets.

Air Cargo: Cargo loaded as loose pieces into airplane compartments.

dataFormatboolean
isNullabletrue

Traits

List of traits for the BulkCargoIndicator 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.

ParameterValueData typeExplanation
identifier"{70C3943B-A9B8-4DDB-81EB-D40DA4F7CCC2}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBulk Cargo Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enLoose cargo, not unitized, not loaded in containers or on pallets.

Air Cargo: Cargo loaded as loose pieces into airplane compartments.

entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

ArticlesOfExtraordinaryValueIndicator

Commodities identified as high value items.

Commodities identified as high-value items that require advance arrangements and special handling.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameArticles Of Extraordinary Value Indicator
descriptionCommodities identified as high value items.

Commodities identified as high-value items that require advance arrangements and special handling.

dataFormatboolean
isNullabletrue

Traits

List of traits for the ArticlesOfExtraordinaryValueIndicator 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.

ParameterValueData typeExplanation
identifier"{05DD6792-B694-44B4-969F-81E00BECD56A}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enArticles Of Extraordinary Value Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCommodities identified as high value items.

Commodities identified as high-value items that require advance arrangements and special handling.

entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

AttractiveMerchandiseIndicator

Commodities such as cameras, radios, electronic equipment, etc., that are handled as high-value shipments but not rated the same.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameAttractive Merchandise Indicator
descriptionCommodities such as cameras, radios, electronic equipment, etc., that are handled as high-value shipments but not rated the same.
dataFormatboolean
isNullabletrue

Traits

List of traits for the AttractiveMerchandiseIndicator 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.

ParameterValueData typeExplanation
identifier"{70F12335-E192-42FF-B48A-70F21BBC12A4}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAttractive Merchandise Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCommodities such as cameras, radios, electronic equipment, etc., that are handled as high-value shipments but not rated the same.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

PerishableItemIndicator

A commodity possessing a quality or condition making it conducive to deterioration, spoilage, or death. Examples of this are seafood, flowers, fruits, vegetables and other perishable foodstuff.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNamePerishable Item Indicator
descriptionA commodity possessing a quality or condition making it conducive to deterioration, spoilage, or death. Examples of this are seafood, flowers, fruits, vegetables and other perishable foodstuff.
dataFormatboolean
isNullabletrue

Traits

List of traits for the PerishableItemIndicator 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.

ParameterValueData typeExplanation
identifier"{3FD3B065-A5B0-4EEB-A903-C352E9D8BC36}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPerishable Item Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enA commodity possessing a quality or condition making it conducive to deterioration, spoilage, or death. Examples of this are seafood, flowers, fruits, vegetables and other perishable foodstuff.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

SerializedItemIndicator

Indicates that the Item is serialized.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameSerialized Item Indicator
descriptionIndicates that the Item is serialized.
dataFormatboolean
isNullabletrue

Traits

List of traits for the SerializedItemIndicator 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.

ParameterValueData typeExplanation
identifier"{4233743F-10F1-46D9-AD20-25572A4ED388}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSerialized Item Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIndicates that the Item is serialized.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

TrackSerialNumberIndicator

Indicates that the Item must be tracked by Serial Number.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameTrack Serial Number Indicator
descriptionIndicates that the Item must be tracked by Serial Number.
dataFormatboolean
isNullabletrue

Traits

List of traits for the TrackSerialNumberIndicator 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.

ParameterValueData typeExplanation
identifier"{388E619C-88F2-42A4-984C-3106F2C0A88D}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTrack Serial Number Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIndicates that the Item must be tracked by Serial Number.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

HoldForPickUpAtDestinationIndicator

Freight to be held at the carrier's destination location for pick-up by the recipient. See also Notify on Arrival.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameHold For Pick-Up At Destination Indicator
descriptionFreight to be held at the carrier's destination location for pick-up by the recipient. See also Notify on Arrival.
dataFormatboolean
isNullabletrue

Traits

List of traits for the HoldForPickUpAtDestinationIndicator 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.

ParameterValueData typeExplanation
identifier"{10F6B44A-511F-4E0D-A36D-23E1AA54EBB7}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enHold For Pick-Up At Destination Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFreight to be held at the carrier's destination location for pick-up by the recipient. See also Notify on Arrival.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

CyCfsCargoIndicator

Cargo loaded in a full container by a shipper at origin, delivered to pier facility at destination, and then devanned by the carrier for loose pick up.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameCY/CFS Cargo Indicator
descriptionCargo loaded in a full container by a shipper at origin, delivered to pier facility at destination, and then devanned by the carrier for loose pick up.
dataFormatboolean
isNullabletrue

Traits

List of traits for the CyCfsCargoIndicator 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.

ParameterValueData typeExplanation
identifier"{178DA1FC-8290-447B-8085-9FC5011A3795}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCY/CFS Cargo Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCargo loaded in a full container by a shipper at origin, delivered to pier facility at destination, and then devanned by the carrier for loose pick up.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

CyCyCargoIndicator

Cargo loaded by the shipper in a full container at origin and delivered to the carrier's terminal at destination for pick up intact by consignee.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameCY/CY Cargo Indicator
descriptionCargo loaded by the shipper in a full container at origin and delivered to the carrier's terminal at destination for pick up intact by consignee.
dataFormatboolean
isNullabletrue

Traits

List of traits for the CyCyCargoIndicator 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.

ParameterValueData typeExplanation
identifier"{5B9B875A-95B1-4171-838D-F91155ED301E}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCY/CY Cargo Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCargo loaded by the shipper in a full container at origin and delivered to the carrier's terminal at destination for pick up intact by consignee.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

DryCargoIndicator

Cargo that does not require temperature control.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameDry Cargo Indicator
descriptionCargo that does not require temperature control.
dataFormatboolean
isNullabletrue

Traits

List of traits for the DryCargoIndicator 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.

ParameterValueData typeExplanation
identifier"{72A27277-441C-4BC7-B9A9-DCB07F8B6C3B}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDry Cargo Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCargo that does not require temperature control.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

PersonalEffectivesItemsIndicator

Shipments of used personal goods not for resale.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNamePersonal Effectives Items Indicator
descriptionShipments of used personal goods not for resale.
dataFormatboolean
isNullabletrue

Traits

List of traits for the PersonalEffectivesItemsIndicator 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.

ParameterValueData typeExplanation
identifier"{219C6ECA-05B0-4993-B0F4-F7E532FE40EB}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPersonal Effectives Items Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enShipments of used personal goods not for resale.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

BondedFreightIndicator

Freight moving under a bond to U.S. Customs or to the Internal Revenue Service, and to be delivered only under stated conditions.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameBonded Freight Indicator
descriptionFreight moving under a bond to U.S. Customs or to the Internal Revenue Service, and to be delivered only under stated conditions.
dataFormatboolean
isNullabletrue

Traits

List of traits for the BondedFreightIndicator 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.

ParameterValueData typeExplanation
identifier"{05E7A4B8-E5F2-4D70-A9C7-0F0BD89797E9}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBonded Freight Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFreight moving under a bond to U.S. Customs or to the Internal Revenue Service, and to be delivered only under stated conditions.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

BulkCargoShipmentItemIndicator

Not in packages or containers; shipped loose in the hold of a ship without mark and count." Grain, coal and sulfur are usually bulk freight.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameBulk Cargo Shipment Item Indicator
descriptionNot in packages or containers; shipped loose in the hold of a ship without mark and count." Grain, coal and sulfur are usually bulk freight.
dataFormatboolean
isNullabletrue

Traits

List of traits for the BulkCargoShipmentItemIndicator 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.

ParameterValueData typeExplanation
identifier"{50AB47B9-0DE9-44E6-9CE3-6DBF77A974A3}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBulk Cargo Shipment Item Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enNot in packages or containers; shipped loose in the hold of a ship without mark and count." Grain, coal and sulfur are usually bulk freight.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

ControlledAtmosphereRequiredIndicator

An atmosphere in which oxygen, carbon dioxide and nitrogen concentrations are regulated, as well as temperature and humidity.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameControlled Atmosphere Required Indicator
descriptionAn atmosphere in which oxygen, carbon dioxide and nitrogen concentrations are regulated, as well as temperature and humidity.
dataFormatboolean
isNullabletrue

Traits

List of traits for the ControlledAtmosphereRequiredIndicator 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.

ParameterValueData typeExplanation
identifier"{09A76CE3-4FEE-48F0-8702-B8A19FCBF155}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enControlled Atmosphere Required Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAn atmosphere in which oxygen, carbon dioxide and nitrogen concentrations are regulated, as well as temperature and humidity.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

ContainerizableCargoIndicator

Cargo that will fit into a container and result in an economical shipment.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameContainerizable Cargo Indicator
descriptionCargo that will fit into a container and result in an economical shipment.
dataFormatboolean
isNullabletrue

Traits

List of traits for the ContainerizableCargoIndicator 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.

ParameterValueData typeExplanation
identifier"{19E1C037-6C61-4C0A-81B5-9ED235508C48}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enContainerizable Cargo Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCargo that will fit into a container and result in an economical shipment.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

DangerousAndHazardousCargoIndicator

Abbreviation for "Dangerous and Hazardous" cargo.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameDangerous And Hazardous Cargo Indicator
descriptionAbbreviation for "Dangerous and Hazardous" cargo.
dataFormatboolean
isNullabletrue

Traits

List of traits for the DangerousAndHazardousCargoIndicator 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.

ParameterValueData typeExplanation
identifier"{109C0B05-6BB1-40C2-93F4-53C4ACEB94C2}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDangerous And Hazardous Cargo Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAbbreviation for "Dangerous and Hazardous" cargo.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

LoosePackingShipmentItemIndicator

Without packing.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameLoose Packing Shipment Item Indicator
descriptionWithout packing.
dataFormatboolean
isNullabletrue

Traits

List of traits for the LoosePackingShipmentItemIndicator 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.

ParameterValueData typeExplanation
identifier"{3143E804-65EC-4DC0-A855-9BDBC717C588}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enLoose Packing Shipment Item Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enWithout packing.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

OverheightCargoIndicator

Cargo more than eight feet high which thus cannot fit into a standard container.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameOverheight Cargo Indicator
descriptionCargo more than eight feet high which thus cannot fit into a standard container.
dataFormatboolean
isNullabletrue

Traits

List of traits for the OverheightCargoIndicator 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.

ParameterValueData typeExplanation
identifier"{2B17DEAE-7A17-41E1-8F5D-3719F34E33C8}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOverheight Cargo Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCargo more than eight feet high which thus cannot fit into a standard container.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

LooseCargoIndicator

Air cargo delivered to an airline as separate packages and loaded and unloaded onto airplanes (or ULDs) by airline employees, and then delivered as separate pieces to the consigned. See Bulk Cargo.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameLoose Cargo Indicator
descriptionAir cargo delivered to an airline as separate packages and loaded and unloaded onto airplanes (or ULDs) by airline employees, and then delivered as separate pieces to the consigned. See Bulk Cargo.
dataFormatboolean
isNullabletrue

Traits

List of traits for the LooseCargoIndicator 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.

ParameterValueData typeExplanation
identifier"{147E7F41-6A95-4820-8660-6FA0C51E6CF0}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enLoose Cargo Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAir cargo delivered to an airline as separate packages and loaded and unloaded onto airplanes (or ULDs) by airline employees, and then delivered as separate pieces to the consigned. See Bulk Cargo.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

BandedPackingIndicator

Cargo wrapped and/or secured with metal or plastic strips
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameBanded Packing Indicator
descriptionCargo wrapped and/or secured with metal or plastic strips
dataFormatboolean
isNullabletrue

Traits

List of traits for the BandedPackingIndicator 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.

ParameterValueData typeExplanation
identifier"{6F9833D7-0C37-416C-AFC0-2B547DDDFBAD}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBanded Packing Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCargo wrapped and/or secured with metal or plastic strips
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

GuaranteedFreightIndicator

Freight charges which are not paid to the carrier in advance of shipment but which the shipper promises to pay within a specified period of time. Guaranteed freight is considered earned by the carrier at the time of shipment and must be paid even if the cargo is undelivered or delivered damaged. Guaranteed freight is not refundable by the carrier even if they do not deliver the cargo except through subrogation proceedings.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameGuaranteed Freight Indicator
descriptionFreight charges which are not paid to the carrier in advance of shipment but which the shipper promises to pay within a specified period of time. Guaranteed freight is considered earned by the carrier at the time of shipment and must be paid even if the cargo is undelivered or delivered damaged. Guaranteed freight is not refundable by the carrier even if they do not deliver the cargo except through subrogation proceedings.
dataFormatboolean
isNullabletrue

Traits

List of traits for the GuaranteedFreightIndicator 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.

ParameterValueData typeExplanation
identifier"{7E8112B7-1C77-4760-A462-293847B3471E}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enGuaranteed Freight Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFreight charges which are not paid to the carrier in advance of shipment but which the shipper promises to pay within a specified period of time. Guaranteed freight is considered earned by the carrier at the time of shipment and must be paid even if the cargo is undelivered or delivered damaged. Guaranteed freight is not refundable by the carrier even if they do not deliver the cargo except through subrogation proceedings.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

ItemSafetyClassificationId

The unique identifier of an Item Safety Classification.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameItem Safety Classification ID
descriptionThe unique identifier of an Item Safety Classification.
dataFormatint32
isNullabletrue

Traits

List of traits for the ItemSafetyClassificationId 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.

ParameterValueData typeExplanation
identifier"{0E64A221-E91D-4FD5-8791-050B2698A0B8}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enItem Safety Classification ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of an Item Safety Classification.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

IdentificationMethodId

The unique identifier of the Identification Method.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameIdentification Method ID
descriptionThe unique identifier of the Identification Method.
dataFormatint32
isNullabletrue

Traits

List of traits for the IdentificationMethodId 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.

ParameterValueData typeExplanation
identifier"{195AABF6-13F8-46BB-8F95-242751A73405}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIdentification Method ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of the Identification Method.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

FreightConditionId

The unique identifier of an descriptive Freight Condition.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameFreight Condition ID
descriptionThe unique identifier of an descriptive Freight Condition.
dataFormatint32
isNullabletrue

Traits

List of traits for the FreightConditionId 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.

ParameterValueData typeExplanation
identifier"{151DD3CA-8A70-460A-823D-F63345CA2DD1}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFreight Condition ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of an descriptive Freight Condition.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

HazardSeverityCategoryId

The unique identifier of a Hazard Severity Category.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameHazard Severity Category ID
descriptionThe unique identifier of a Hazard Severity Category.
dataFormatint32
isNullabletrue

Traits

List of traits for the HazardSeverityCategoryId 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.

ParameterValueData typeExplanation
identifier"{E07A1540-A82D-4050-A97D-F8B4F6D41593}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enHazard Severity Category ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Hazard Severity Category.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

CommodityTypeId

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

Properties

NameValue
displayNameCommodity Type ID
descriptionThe unique identifier of a Commodity Type.
dataFormatint32
isNullabletrue

Traits

List of traits for the CommodityTypeId 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.

ParameterValueData typeExplanation
identifier"{1F7AA972-FC44-47FE-B47D-D996892FAA8A}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCommodity Type ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Commodity Type.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

HtsScheduleBCode

The unique code identifying items within the HTS Schedule B.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameHTS Schedule B Code
descriptionThe unique code identifying items within the HTS Schedule B.
dataFormatint32
isNullabletrue

Traits

List of traits for the HtsScheduleBCode 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.

ParameterValueData typeExplanation
identifier"{4D8D2ECA-DD2B-4995-8F02-4447A9B7AE1F}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enHTS Schedule B Code
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique code identifying items within the HTS Schedule B.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

HarmonizedTariffScheduleCode

The unique identifier of an HTS Code.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameHarmonized Tariff Schedule Code
descriptionThe unique identifier of an HTS Code.
dataFormatint32
isNullabletrue

Traits

List of traits for the HarmonizedTariffScheduleCode 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.

ParameterValueData typeExplanation
identifier"{1A9B3D82-D619-4CE0-A1AA-98A4271FC2ED}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enHarmonized Tariff Schedule Code
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of an HTS Code.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

EccnNumber

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

Properties

NameValue
displayNameECCN Number
descriptionThe unique identifier of a ECCN.
dataFormatint32
isNullabletrue

Traits

List of traits for the EccnNumber 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.

ParameterValueData typeExplanation
identifier"{3DD4662A-4672-49C2-AC11-3AB37BBFE90B}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enECCN Number
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a ECCN.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

ItemSku

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

Properties

NameValue
displayNameItem SKU
descriptionThe Stock Keeping Unit identifier, which is typically used for inventory-related activities.
dataFormatstring
maximumLength40
isNullabletrue

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.nullable
The attribute value can be set to NULL.

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enItem SKU
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe Stock Keeping Unit identifier, which is typically used for inventory-related activities.
entitya reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

ParameterValueData typeExplanation
maximumLength"40"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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
Item.cdm.json/ItemItemSku
entitya 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.

ParameterValueData typeExplanation
identifier"{2F28EE04-00AE-47B9-8797-8E24E670B7EE}"stringThe 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.

CargoTypeId

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

Properties

NameValue
displayNameCargo Type ID
descriptionThe unique identifier of a Cargo Type.
dataFormatint32
isNullabletrue

Traits

List of traits for the CargoTypeId 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.

ParameterValueData typeExplanation
identifier"{07AA742F-17D1-462C-BD0F-AA1E35589461}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCargo Type ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Cargo Type.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

LandedCost

The total cost of the item once it has arrived at the buyer's door.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameLanded Cost
descriptionThe total cost of the item once it has arrived at the buyer's door.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the LandedCost attribute are listed here.

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

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"2"integerthe 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.

ParameterValueData typeExplanation
identifier"{3C799512-B5BF-40CB-B7BF-77ADF7E0E7DA}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enLanded Cost
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe total cost of the item once it has arrived at the buyer's door.
entitya 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

PalletTypeId

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

Properties

NameValue
displayNamePallet Type ID
descriptionThe unique identifier of a Pallet Type.
dataFormatint32
isNullabletrue

Traits

List of traits for the PalletTypeId 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.

ParameterValueData typeExplanation
identifier"{51330BD2-819D-43D0-A075-8086BFC0E855}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPallet Type ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Pallet Type.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

PalletSerialNumber

The serial number of the Pallet.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNamePallet Serial Number
descriptionThe serial number of the Pallet.
dataFormatstring
maximumLength30
isNullabletrue

Traits

List of traits for the PalletSerialNumber 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.

ParameterValueData typeExplanation
identifier"{402C8F3A-DEEE-4ABD-9921-F76AE6FC54D2}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPallet Serial Number
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe serial number of the Pallet.
entitya reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

ParameterValueData typeExplanation
maximumLength"30"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.

IncotermId

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

Properties

NameValue
displayNameIncoterm ID
descriptionThe unique identifier of a Incoterm.
dataFormatint32
isNullabletrue

Traits

List of traits for the IncotermId 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.

ParameterValueData typeExplanation
identifier"{013C9F49-F03C-4E2F-B0DF-82B64753A45F}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIncoterm ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Incoterm.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

ContainerId

The unique identifier of the container.

This would be the 'serial number' of the container if It's serialized.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNameContainer ID
descriptionThe unique identifier of the container.

This would be the 'serial number' of the container if It's serialized.

dataFormatint32
isNullabletrue

Traits

List of traits for the ContainerId 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.

ParameterValueData typeExplanation
identifier"{0BDCCEF0-DE4D-46AF-873B-76B0C3E44A90}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enContainer ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of the container.

This would be the 'serial number' of the container if It's serialized.

entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

PoNumber

The unique identifier of a Purchase Order.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNamePO Number
descriptionThe unique identifier of a Purchase Order.
dataFormatstring
maximumLength20
isNullabletrue

Traits

List of traits for the PoNumber 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPO Number
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Purchase Order.
entitya reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

ParameterValueData typeExplanation
maximumLength"20"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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
PurchaseOrderLine.cdm.json/PurchaseOrderLinePoNumber
entitya 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.

ParameterValueData typeExplanation
identifier"{EAA5FEDF-62F4-423E-BC61-E96D25D24789}"stringThe 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.

PoLineItemNumber

The unique identifier of a PO line item.
First included in: ShipmentItem (this entity)

Properties

NameValue
displayNamePO Line Item Number
descriptionThe unique identifier of a PO line item.
dataFormatint32
isNullabletrue

Traits

List of traits for the PoLineItemNumber 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPO Line Item Number
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a PO line item.
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
PurchaseOrderLine.cdm.json/PurchaseOrderLinePoLineItemNumber
entitya 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.

ParameterValueData typeExplanation
identifier"{3FAD330B-FC53-41E4-AFA4-756E0BA0C9BF}"stringThe 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