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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| versionNumber | "4.3" | string | semantic version number of the entity |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||||
|---|---|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.identifiedBy
Names a specific identity attribute to use with an entity.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | ShipmentItem/(resolvedAttributes)/ShipmentItemNumber | attribute |
minimumObjectModelVersion
Minimum version of the object model required to fully understand the data schema used.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| versionNumber | "1.2.3" | string |
is.IDM.modelVersion
Semantic version number of the IDM.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| versionNumber | "1.6.0" | string |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{5E4A0C20-7D9D-4906-98AF-73E54494647A}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nativeTo.businessArea
The name of the business area from which the entity originates.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "Shipping" | string |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
has.entitySchemaAbstractionLevel
A level of abstraction assigned to an Entity schema. Logical schema descriptions use complex dataTypes, inheritance, and entities as attributes. Resolved descriptions contain none of those things, only final trait and attribute sets are shown. A composition schema manipulates, guides or restates parts of logical schemas to produce one resolved schema.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "resolved" | string | Possible values: logical, composition, resolved |
Attributes
| Name | Description | First Included in Instance |
|---|---|---|
| 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
| Name | Value |
|---|---|
| displayName | Shipment ID |
| description | The unique identifier of a Shipment. |
| isPrimaryKey | true |
| dataFormat | int32 |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | ShipmentItem/(resolvedAttributes)/ShipmentId | attribute |
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{9275E253-FB90-41C0-91E9-6345ED316691}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.dataFormat.integer
ShipmentItemNumber
The shipment line number.
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Shipment Item Number |
| description | The shipment line number. |
| isPrimaryKey | true |
| dataFormat | int32 |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | ShipmentItem/(resolvedAttributes)/ShipmentItemNumber | attribute |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{2D5EA12D-F5EC-4EFA-A702-046FC0B82A9B}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Packing Instructions |
| description | Packing instructions for the associated shipped item. |
| dataFormat | string |
| maximumLength | 2048 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{7108C5F6-3C65-4355-A298-9761D6A0907C}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.constrained
Maximum length or value constraints.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "2048" | integer |
is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.
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
| Name | Value |
|---|---|
| displayName | Handling Instructions |
| description | 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. |
| dataFormat | string |
| maximumLength | 2048 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{54BFD191-5C67-44A9-A7E3-C54CA3DBA0A3}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.constrained
Maximum length or value constraints.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "2048" | integer |
is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.
CountryOfManufactureName
The country of manufacture of the item.
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Country Of Manufacture Name |
| description | The country of manufacture of the item. |
| dataFormat | string |
| maximumLength | 256 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{31F50BCC-E05B-4DE6-B790-7FD6DC60967A}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.constrained
Maximum length or value constraints.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "256" | integer |
is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.
ShippedItemQuantity
The quantity of items shipped.
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Shipped Item Quantity |
| description | The quantity of items shipped. |
| dataFormat | decimal |
| isNullable | true |
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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "18" | integer | the total number of significant digits |
| scale | "2" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{0F202E22-0F72-4B77-8A5D-EF98B7A3D4D1}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
OrderId
The unique number that identifies an Order.
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Order ID |
| description | The unique number that identifies an Order. |
| dataFormat | int64 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{17D47D6D-4666-4EA5-ADA2-AD037B2AEEE6}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Order Line Number |
| description | The number that identifies the Order Line Item. |
| dataFormat | int32 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{10B5BE31-61A7-446D-96A9-B2329E213A03}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Transaction ID |
| description | The unique identifier of a Transaction. |
| dataFormat | int64 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{4A2DA06A-6776-419A-B683-C6959D24F520}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Transaction Line Item ID |
| description | The unique identifier that identifies the Transaction Line Item. |
| dataFormat | int32 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{1139C343-DF0A-4F9F-B9F0-B52FBE33E528}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Item Net Weight |
| description | The weight of the Item. |
| dataFormat | decimal |
| isNullable | true |
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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "18" | integer | the total number of significant digits |
| scale | "8" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{2A559A2F-1C39-429B-9490-68F1065E1BC9}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
WeightUnitOfMeasureId
The unique identifier of a Unit Of Measure.
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Weight Unit Of Measure ID |
| description | The unique identifier of a Unit Of Measure. |
| dataFormat | int32 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{65395D00-C822-4956-9D5C-7A7B904C9AC2}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.dataFormat.integer
ItemLength
The length of the Item.
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Item Length |
| description | The length of the Item. |
| dataFormat | decimal |
| isNullable | true |
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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "18" | integer | the total number of significant digits |
| scale | "8" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{111367E0-D1C3-4FD5-9BF9-B9F572E055C0}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
ItemWidth
The width of the Item.
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Item Width |
| description | The width of the Item. |
| dataFormat | decimal |
| isNullable | true |
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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "18" | integer | the total number of significant digits |
| scale | "8" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{0546B834-64A7-4625-9D5A-139B6CD1F2E3}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
ItemHeight
The height of the Item.
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Item Height |
| description | The height of the Item. |
| dataFormat | decimal |
| isNullable | true |
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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "18" | integer | the total number of significant digits |
| scale | "8" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{0D438C51-B286-4590-B30A-75411771796C}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
LengthWidthHeightUnitOfMeasureId
The unique identifier of a Unit Of Measure.
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Length/Width/Height Unit Of Measure ID |
| description | The unique identifier of a Unit Of Measure. |
| dataFormat | int32 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{0BEE4900-E448-4B01-BD49-E653E1D1BBE0}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.dataFormat.integer
Volume
The volume of the shipment item.
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Volume |
| description | The volume of the shipment item. |
| dataFormat | decimal |
| isNullable | true |
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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "18" | integer | the total number of significant digits |
| scale | "8" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{29A92CD7-D86A-4FA8-8B78-BED111B203EB}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
VolumeUnitOfMeasureId
The unique identifier of a Unit Of Measure.
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Volume Unit Of Measure ID |
| description | The unique identifier of a Unit Of Measure. |
| dataFormat | int32 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{5AD730C6-6873-49BD-B8FA-6BEC99236615}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.dataFormat.integer
PerItemWeight
The individual or per item weight of an item.
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Per Item Weight |
| description | The individual or per item weight of an item. |
| dataFormat | decimal |
| isNullable | true |
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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "18" | integer | the total number of significant digits |
| scale | "8" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{2673F6DF-FCF7-4899-BE19-C24561913AA0}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
TotalQuantityItemWeight
The total weight of all the items without additional packaging weights added.
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Total Quantity Item Weight |
| description | The total weight of all the items without additional packaging weights added. |
| dataFormat | decimal |
| isNullable | true |
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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "18" | integer | the total number of significant digits |
| scale | "8" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{CEC34720-4381-4550-BD33-8F059BC0C5A9}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
PerItemPackagedWeight
The weight of each item packaged for shipment.
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Per Item Packaged Weight |
| description | The weight of each item packaged for shipment. |
| dataFormat | decimal |
| isNullable | true |
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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "18" | integer | the total number of significant digits |
| scale | "8" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{238504D2-EB6A-435C-94BA-9B1BDAEC3AE5}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
TotalQuantityPackagedWeight
The total weight of all items packaged for shipment.
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Total Quantity Packaged Weight |
| description | The total weight of all items packaged for shipment. |
| dataFormat | decimal |
| isNullable | true |
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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "18" | integer | the total number of significant digits |
| scale | "8" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{0ED8E35E-6081-4FD5-B8DC-7D2949E00292}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
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
| Name | Value |
|---|---|
| displayName | Per Item Dimensional Weight |
| description | 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. |
| dataFormat | decimal |
| isNullable | true |
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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "18" | integer | the total number of significant digits |
| scale | "8" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{32AC98BD-C834-4F88-9DEF-25A36B884122}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
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
| Name | Value |
|---|---|
| displayName | Total Quantity Dimensional Weight |
| description | 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 |
| dataFormat | decimal |
| isNullable | true |
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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "18" | integer | the total number of significant digits |
| scale | "8" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{37304A40-CFDA-4BDC-BD0E-F0F2E7E6D57B}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
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
| Name | Value |
|---|---|
| displayName | Actual Gross Shipment Weight |
| description | The weight of the shipment including all packing, blocking, platforms, special bracing, etc., if required. (includes weight of unit load device, when applicable.) |
| dataFormat | decimal |
| isNullable | true |
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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "18" | integer | the total number of significant digits |
| scale | "8" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{33AD4B23-4A25-46B9-9445-C3F15DAB9902}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
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
| Name | Value |
|---|---|
| displayName | Total Item Chargeable Weight |
| description | 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. |
| dataFormat | decimal |
| isNullable | true |
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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "18" | integer | the total number of significant digits |
| scale | "8" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{362CC905-D07F-44FB-98F7-CB7DA77B03C5}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
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
| Name | Value |
|---|---|
| displayName | Total Items Density |
| description | 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. |
| dataFormat | int32 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{07BAEB38-1AC8-4712-8808-6C5ADDBFC7EC}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Total Items Dimensional Weight |
| description | 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. |
| dataFormat | decimal |
| isNullable | true |
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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "18" | integer | the total number of significant digits |
| scale | "8" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{109F234C-2A85-491A-A7CC-970DB5A80DB3}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
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
| Name | Value |
|---|---|
| displayName | Shipment Item Net Weight |
| description | 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. |
| dataFormat | decimal |
| isNullable | true |
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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "18" | integer | the total number of significant digits |
| scale | "8" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{277D2467-D1BF-43CC-8BFB-F64949E96AEA}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
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
| Name | Value |
|---|---|
| displayName | Per Unit Declared Value For Carriage Amount |
| description | 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. |
| dataFormat | decimal |
| isNullable | true |
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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "18" | integer | the total number of significant digits |
| scale | "2" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{02740421-2A19-4D31-89FD-E82C6934A25C}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
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
| Name | Value |
|---|---|
| displayName | Per Unit Declared Value For Customs Amount |
| description | 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. |
| dataFormat | decimal |
| isNullable | true |
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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "18" | integer | the total number of significant digits |
| scale | "2" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{1D7F591A-8421-4101-87E8-11EA3A4CB483}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
SpecialHandlingStatement
A statement regarding any special handling requirements.
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Special Handling Statement |
| description | A statement regarding any special handling requirements. |
| dataFormat | string |
| maximumLength | 2048 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{2C947400-E63C-4D47-BC90-B4734F27A629}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.constrained
Maximum length or value constraints.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "2048" | integer |
is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.
EstimatedValue
The estimated value of the shipment item(s).
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Estimated Value |
| description | The estimated value of the shipment item(s). |
| dataFormat | decimal |
| isNullable | true |
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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "18" | integer | the total number of significant digits |
| scale | "2" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{C53EB474-C9A8-449A-BF8F-56B873A73E8C}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
WarningInformationText
The text of the warning label, if any, appearing upon the shipment item.
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Warning Information Text |
| description | The text of the warning label, if any, appearing upon the shipment item. |
| dataFormat | string |
| maximumLength | 2048 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{391F046D-D77D-4E98-8072-DC583660598A}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.constrained
Maximum length or value constraints.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "2048" | integer |
is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.
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
| Name | Value |
|---|---|
| displayName | Awkward Cargo Indicator |
| description | 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. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{073D5717-B5DB-4770-8D2E-2CD6DEE33F5B}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Break-Bulk Cargo Indicator |
| description | Goods shipped loose in the vessel's hold and not in a container. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{9C19BC7E-8C6D-479F-8E91-870F4617E553}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Perishable Cargo Indicator |
| description | Cargo subject to decay or deterioration. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{6BA515D9-FF84-4732-9430-99D95817A9F1}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Break Bulk Item Indicator |
| description | Cargo which is not containerized due to its weight and/or size e.g. steel pipes, boats etc. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{2C5AE84B-A9BA-4077-9144-C4EB4E17B291}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Dangerous Goods Indicator |
| description | 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. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{375C7F3B-D866-4396-ACB9-A77EC81969F6}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Hazardous Material HAZMAT Indicator |
| description | 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. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{07C50CFA-2D74-4450-B0E4-C12ED316C823}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Oversized Cargo Indicator |
| description | 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 |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{09626A3E-96B4-4AAB-9BDC-CD1690B06FC0}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Bulk Cargo Indicator |
| description | Loose cargo, not unitized, not loaded in containers or on pallets.
Air Cargo: Cargo loaded as loose pieces into airplane compartments. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{70C3943B-A9B8-4DDB-81EB-D40DA4F7CCC2}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Articles Of Extraordinary Value Indicator |
| description | Commodities identified as high value items.
Commodities identified as high-value items that require advance arrangements and special handling. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{05DD6792-B694-44B4-969F-81E00BECD56A}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Attractive Merchandise Indicator |
| description | Commodities such as cameras, radios, electronic equipment, etc., that are handled as high-value shipments but not rated the same. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{70F12335-E192-42FF-B48A-70F21BBC12A4}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Perishable Item Indicator |
| description | 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. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{3FD3B065-A5B0-4EEB-A903-C352E9D8BC36}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Serialized Item Indicator |
| description | Indicates that the Item is serialized. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{4233743F-10F1-46D9-AD20-25572A4ED388}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Track Serial Number Indicator |
| description | Indicates that the Item must be tracked by Serial Number. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{388E619C-88F2-42A4-984C-3106F2C0A88D}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Hold For Pick-Up At Destination Indicator |
| description | Freight to be held at the carrier's destination location for pick-up by the recipient. See also Notify on Arrival. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{10F6B44A-511F-4E0D-A36D-23E1AA54EBB7}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | CY/CFS Cargo Indicator |
| description | 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. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{178DA1FC-8290-447B-8085-9FC5011A3795}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | CY/CY Cargo Indicator |
| description | 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. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{5B9B875A-95B1-4171-838D-F91155ED301E}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Dry Cargo Indicator |
| description | Cargo that does not require temperature control. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{72A27277-441C-4BC7-B9A9-DCB07F8B6C3B}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Personal Effectives Items Indicator |
| description | Shipments of used personal goods not for resale. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{219C6ECA-05B0-4993-B0F4-F7E532FE40EB}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Bonded Freight Indicator |
| description | Freight moving under a bond to U.S. Customs or to the Internal Revenue Service, and to be delivered only under stated conditions. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{05E7A4B8-E5F2-4D70-A9C7-0F0BD89797E9}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Bulk Cargo Shipment Item Indicator |
| description | 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. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{50AB47B9-0DE9-44E6-9CE3-6DBF77A974A3}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Controlled Atmosphere Required Indicator |
| description | An atmosphere in which oxygen, carbon dioxide and nitrogen concentrations are regulated, as well as temperature and humidity. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{09A76CE3-4FEE-48F0-8702-B8A19FCBF155}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Containerizable Cargo Indicator |
| description | Cargo that will fit into a container and result in an economical shipment. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{19E1C037-6C61-4C0A-81B5-9ED235508C48}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Dangerous And Hazardous Cargo Indicator |
| description | Abbreviation for "Dangerous and Hazardous" cargo. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{109C0B05-6BB1-40C2-93F4-53C4ACEB94C2}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.boolean
LoosePackingShipmentItemIndicator
Without packing.
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Loose Packing Shipment Item Indicator |
| description | Without packing. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{3143E804-65EC-4DC0-A855-9BDBC717C588}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Overheight Cargo Indicator |
| description | Cargo more than eight feet high which thus cannot fit into a standard container. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{2B17DEAE-7A17-41E1-8F5D-3719F34E33C8}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Loose Cargo Indicator |
| description | 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. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{147E7F41-6A95-4820-8660-6FA0C51E6CF0}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Banded Packing Indicator |
| description | Cargo wrapped and/or secured with metal or plastic strips |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{6F9833D7-0C37-416C-AFC0-2B547DDDFBAD}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Guaranteed Freight Indicator |
| description | 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. |
| dataFormat | boolean |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{7E8112B7-1C77-4760-A462-293847B3471E}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Item Safety Classification ID |
| description | The unique identifier of an Item Safety Classification. |
| dataFormat | int32 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{0E64A221-E91D-4FD5-8791-050B2698A0B8}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Identification Method ID |
| description | The unique identifier of the Identification Method. |
| dataFormat | int32 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{195AABF6-13F8-46BB-8F95-242751A73405}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Freight Condition ID |
| description | The unique identifier of an descriptive Freight Condition. |
| dataFormat | int32 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{151DD3CA-8A70-460A-823D-F63345CA2DD1}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Hazard Severity Category ID |
| description | The unique identifier of a Hazard Severity Category. |
| dataFormat | int32 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{E07A1540-A82D-4050-A97D-F8B4F6D41593}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Commodity Type ID |
| description | The unique identifier of a Commodity Type. |
| dataFormat | int32 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{1F7AA972-FC44-47FE-B47D-D996892FAA8A}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | HTS Schedule B Code |
| description | The unique code identifying items within the HTS Schedule B. |
| dataFormat | int32 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{4D8D2ECA-DD2B-4995-8F02-4447A9B7AE1F}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Harmonized Tariff Schedule Code |
| description | The unique identifier of an HTS Code. |
| dataFormat | int32 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{1A9B3D82-D619-4CE0-A1AA-98A4271FC2ED}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | ECCN Number |
| description | The unique identifier of a ECCN. |
| dataFormat | int32 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{3DD4662A-4672-49C2-AC11-3AB37BBFE90B}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Item SKU |
| description | The Stock Keeping Unit identifier, which is typically used for inventory-related activities. |
| dataFormat | string |
| maximumLength | 40 |
| isNullable | true |
Traits
List of traits for the ItemSku attribute are listed here.
is.dataFormat.character
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.constrained
Maximum length or value constraints.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "40" | integer |
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{2F28EE04-00AE-47B9-8797-8E24E670B7EE}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.
CargoTypeId
The unique identifier of a Cargo Type.
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Cargo Type ID |
| description | The unique identifier of a Cargo Type. |
| dataFormat | int32 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{07AA742F-17D1-462C-BD0F-AA1E35589461}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Landed Cost |
| description | The total cost of the item once it has arrived at the buyer's door. |
| dataFormat | decimal |
| isNullable | true |
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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "18" | integer | the total number of significant digits |
| scale | "2" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{3C799512-B5BF-40CB-B7BF-77ADF7E0E7DA}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
PalletTypeId
The unique identifier of a Pallet Type.
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Pallet Type ID |
| description | The unique identifier of a Pallet Type. |
| dataFormat | int32 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{51330BD2-819D-43D0-A075-8086BFC0E855}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Pallet Serial Number |
| description | The serial number of the Pallet. |
| dataFormat | string |
| maximumLength | 30 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{402C8F3A-DEEE-4ABD-9921-F76AE6FC54D2}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.constrained
Maximum length or value constraints.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "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
| Name | Value |
|---|---|
| displayName | Incoterm ID |
| description | The unique identifier of a Incoterm. |
| dataFormat | int32 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{013C9F49-F03C-4E2F-B0DF-82B64753A45F}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | Container ID |
| description | The unique identifier of the container.
This would be the 'serial number' of the container if It's serialized. |
| dataFormat | int32 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{0BDCCEF0-DE4D-46AF-873B-76B0C3E44A90}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a 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
| Name | Value |
|---|---|
| displayName | PO Number |
| description | The unique identifier of a Purchase Order. |
| dataFormat | string |
| maximumLength | 20 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.constrained
Maximum length or value constraints.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "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.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{EAA5FEDF-62F4-423E-BC61-E96D25D24789}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.
PoLineItemNumber
The unique identifier of a PO line item.
First included in: ShipmentItem (this entity)
Properties
| Name | Value |
|---|---|
| displayName | PO Line Item Number |
| description | The unique identifier of a PO line item. |
| dataFormat | int32 |
| isNullable | true |
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.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{3FAD330B-FC53-41E4-AFA4-756E0BA0C9BF}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.dataFormat.integer