Shipment (Load) in ESG data model(Shipment)
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 | Shipment/(resolvedAttributes)/ShipmentId | 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 | "{2B7D8EC5-1245-4B61-B63C-59853A45FF83}" | 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. | Shipment |
MasterShipmentNumber | A master shipment number is used to tie multiple shipments together. It's typically used when one or more shipments are to be considered to be a single shipment for billing purposes. | Shipment |
TrackingIdentifier | A tracking identifier is a number or alphanumeric string consisting of a series of numbers and letters, used to uniquely identify a handling unit associated with a shipment. | Shipment |
ShipmentBookingNumber | Reservation number used to secure equipment and act as a control number prior to completion of a B/L. | Shipment |
ExportLicenseNumber | An export license number that may be associated with the shipment. | Shipment |
InsurancePolicyId | The unique identifier of an Insurance Policy. | Shipment |
GlobalShipmentIdentificationNumber | The Global Shipment Identification Number (GSIN) is part of the GS1 system of standards. It's used to identify shipments.A shipment, which may be comprised of one or more logistic units, is intended to be delivered together. The logistic units belonging to a particular shipment keep the same GSIN during all transport stages, from origin to final destination. | Shipment |
GlobalIdentificationNumberForConsignment | The Global Identification Number for Consignment (GINC) is part of the GS1 system of standards. It's used to identify a grouping of goods that has been consigned to a freight forwarder and is intended to be transported as a single group. GINC is used to identify consignments comprised of one or more logistic units, potentially belonging to different shipments, that are intended to be transported together for a portion of their transportation journey. This typically occurs when shipments are consolidated. | Shipment |
ShipmentOrderId | The unique number that identifies an Order. | Shipment |
ShipmentOrderLineNumber | The number that identifies the Order Line Item. | Shipment |
ConsignorName | The name of the person or firm whose name appears on the air waybill as the party contracting with the carrier for carriage of the goods. Usually the shipper. | Shipment |
ConsignorPartyId | The unique identifier of a Party. | Shipment |
ConsignorCustomerAccountId | The unique identifier of a Customer Account. | Shipment |
ConsignorLocationId | The unique identifier of a Location. | Shipment |
ConsignorSignatureImage | The consignor's signature or signature image. | Shipment |
ConsigneeName | The Consignee is the person or legal entity in a freight contract to whom goods have been shipped or turned over to care. | Shipment |
ConsigneePartyId | The unique identifier of a Party. | Shipment |
ConsigneeCustomerAccountId | The unique identifier of a Customer Account. | Shipment |
ConsigneeLocationId | The unique identifier of a Location. | Shipment |
ConsigneeSignatureImage | The consignee's signature or signature image. | Shipment |
NotifyPartyId | The unique identifier of a Party. | Shipment |
ShipmentFromName | The name of the ship-from party. | Shipment |
ShipmentFromLocationId | The unique identifier of a Location. | Shipment |
OriginationWarehouseId | The unique identifier of a Warehouse. | Shipment |
ShipmentToName | The name of the ship-to party. | Shipment |
ShipmentToLocationId | The unique identifier of a Location. | Shipment |
DestinationWarehouseId | The unique identifier of a Warehouse. | Shipment |
ShipmentConditionId | The unique identifier of a Shipment Condition. | Shipment |
ShipmentTotalNetWeight | Net Weight - The total weight of a shipment less the weight of containers, pallets, nets or straps. | Shipment |
ShipmentTotalGrossWeight | The full weight of a shipment including goods and packaging.The weight of the shipment including all packing, blocking, platforms, special bracing, etc., if required. (includes weight of unit load device, when applicable.) | Shipment |
ShipmentTotalChargeableWeight | The weight of the shipment used in determining shipment 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. | Shipment |
PackingInstructions | Instructions for shipping personnel regarding the associated Shipment. | Shipment |
DeliveryInstructions | Specific information provided to the inland carrier concerning the arrangement made by the Freight Forwarder to deliver items to the particular pier or steamship line. | Shipment |
ArrangementsInAdvanceInstructions | Certain commodities, such as gold, gems, live animals etc., require arrangements to be made in advance with the Carriers. | Shipment |
DeclarationByForeignShipperStatement | A statement by the Shipper in the foreign country attesting to certain facts. | Shipment |
HiddenDamageStatement | The statement regarding to any hidden damages allocated to the Shipment. | Shipment |
ArrivalNoticeStatement | An advice that the carrier sends to the consignee advising of goods coming forward for delivery. Pertinent information such as BL number, container number and total charges due from consignee etc., are included and sent to consignee prior to vessel arrival. This is done gratuitously by the carrier to ensure smooth delivery but There's no obligation by the carrier to do so. The responsibility to monitor the transit and present himself to take timely delivery still rests with the consignee. | Shipment |
EstimatedShipmentCost | The estimated total shipment cost amount. | Shipment |
ShipmentAgreedValuationAmount | The value of a shipment agreed upon in order to secure a specific freight rate. | Shipment |
ShipmentCarrierLiabilityAmount | The amount of declared value on a shipment that is over the carrier's liability | Shipment |
ShipmentAllInAmount | The total price to move cargo from origin to destination, inclusive of all charges. | Shipment |
ShipmentExcessValueAmount | The amount of declared value on a shipment that is over the carrier's liability | Shipment |
ShipmentTotalChargesAmount | The total amount of all charges associated with the shipment. | Shipment |
CollectOnDeliveryIndicator | Indicates that the shipment is collect.A transportation service under which the purchase price of the goods in collected by the carrier from the receiver at the time of delivery. Payment Is subsequently transmitted to the shipper. Carriers charge a nominal fee for this service. Payment is due upon delivery. There are no credit provisions in COD service. | Shipment |
AutomaticProofOfDeliveryRequiredIndicator | Indicates that a POD is required.An Automatic Proof of Delivery (POD) is information automatically sent to payer containing name of person who signed for the package with timestamp of delivery. | Shipment |
HoldForPickupShipmentIndicator | Indicates that freight is to be held at the carrier's destination location for pickup by the recipient. | Shipment |
AstrayShipmentIndicator | Indicates that the shipment is traveling without paperwork or on paperwork in place of the original | Shipment |
InterlineShipmentIndicator | Indicates that the shipment requires the movement of a shipment via two or more carriers. | Shipment |
IntermodalShipmentIndicator | Indicates that the shipment requires the movement of goods by more than one mode of Transport, i.e. railroad, truck, ship and airplane, in the same ULD, under a singe waybill. | Shipment |
PrePaidShipmentIndicator | Freight and charges are required to be paid by shipper before original bill of lading is released to them. | Shipment |
WithoutReserveShipmentIndicator | A term indicating that a shipper's agent or representative is empowered to make definitive decisions and adjustments abroad without approval of the group or individual represented | Shipment |
NotifyOnArrivalIndicator | Indicates that the consignor requires to be notified upon receipt of the shipment. | Shipment |
DoorToDoorShipmentIndicator | Through transportation of a container and its contents from consignor's premises to consignee's premises. | Shipment |
ConsolidatedShipmentIndicator | Numerous shipments from different shippers to one consignee that are consolidated and treated as a single consignment. | Shipment |
UnclaimedShipmentIndicator | Indicates that the shipment has been unclaimed. | Shipment |
PartialShipmentAcceptableIndicator | An indicator denoting that the customer has agreed to partial shipments. | Shipment |
EstimatedNumberDeliveryDays | The estimated number of days to deliver the Shipment. | Shipment |
LatestAvailableShipDate | The latest ship date that is acceptable to the customer. | Shipment |
ShipmentTenderTimestamp | The timestamp that the shipment was tendered or place or shipment. | Shipment |
PlannedEarliestPickUpTimestamp | The earliest that the shipment can be picked up. | Shipment |
PlannedLatestPickUpTimestamp | The latest that the shipment can be picked-up. | Shipment |
PlannedEarliestDeliveryTimestamp | The earliest that the shipment can be delivered. | Shipment |
PlannedLatestDeliveryTimestamp | The latest that the shipment can be delivered. | Shipment |
PlannedShipTimestamp | The planned date of shipment. | Shipment |
ActualShipTimestamp | The actual shipment date. | Shipment |
CleanBillOfLadingTimestamp | The date that a clear bill of lading was determined, which is a receipt for goods issued by the Carrier indicating that the goods were received in good order and condition, without damages. | Shipment |
ReleaseNoteTimestamp | Receipt signed by customer acknowledging delivery of goods. | Shipment |
EstimatedDeliveryTimestamp | Estimated delivery timestamp. | Shipment |
ShipmentDeliveryTimestamp | The timestamp that the shipment was received or delivered at the ship-to address. | Shipment |
ArrivalNoticeIssuedTimestamp | The date that the Arrival Notice was issued or sent.An advice that the carrier sends to the consignee advising of goods coming forward for delivery. Pertinent information such as BL number, container number and total charges due from consignee etc., are included and sent to consignee prior to vessel arrival. This is done gratuitously by the carrier to ensure smooth delivery but There's no obligation by the carrier to do so. The responsibility to monitor the transit and present himself to take timely delivery still rests with the consignee. | Shipment |
AutomaticProofOfDeliveryPodIssuedTimestamp | The date that the automatic proof of delivery (POD) was issued. | Shipment |
PackingTypeId | The unique identifier of a Packing Type. | Shipment |
ShipmentTypeId | The unique identifier of a Shipment Type. | Shipment |
ShipmentPriorityId | The unique identifier of a Shipment Priority. | Shipment |
ShipmentMethodId | The unique identifier of a Shipment Method. | Shipment |
IncotermId | The unique identifier of a Incoterm. | Shipment |
CarrierId | The unique identifier of a Carrier. | Shipment |
RequestedCarrierId | The unique identifier of a Carrier. | Shipment |
ChannelId | The unique identifier of a Channel. | Shipment |
ContainerId | The unique identifier of the container.This would be the 'serial number' of the container if It's serialized. | Shipment |
PalletTypeId | The unique identifier of a Pallet Type. | Shipment |
PalletSerialNumber | The serial number of the Pallet. | Shipment |
ItemSku | The Stock Keeping Unit identifier, which is typically used for inventory-related activities. | Shipment |
ShipmentHeight | The height of the Shipment. | Shipment |
ShipmentWidth | The width of the Shipment. | Shipment |
ShipmentLength | The length of the Shipment. | Shipment |
ShipmentNetWeight | The weight of the Shipment. | Shipment |
ShipmentVolume | The volume of the shipment. | Shipment |
VolumeUnitOfMeasureId | Note:A temporary divider header that is used to separate and organize information for the viewer.This column is marked 'Logical Only' and is therefore 'for presentation only' and will not be used when generating DDL. | Shipment |
LengthWidthHeightUnitOfMeasureId | The unique identifier of a Unit Of Measure. | Shipment |
WeightUnitOfMeasureId | The unique identifier of a Unit Of Measure. | Shipment |
TimeSpentAtDeliveryLocation | The amount of time spent at the ship-to address to deliver the shipment. | Shipment |
IsoCurrencyCode | The ISO 4217 currency code. | Shipment |
ShipmentId
The unique identifier of a Shipment.
First included in: Shipment (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 | Shipment/(resolvedAttributes)/ShipmentId | 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 | "{082B8EC8-4958-4670-A5BC-B80979E673A9}" | 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
MasterShipmentNumber
A master shipment number is used to tie multiple shipments together. It's typically used when one or more shipments are to be considered to be a single shipment for billing purposes.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Master Shipment Number |
description | A master shipment number is used to tie multiple shipments together. It's typically used when one or more shipments are to be considered to be a single shipment for billing purposes. |
dataFormat | int32 |
Traits
List of traits for the MasterShipmentNumber 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 | "{114D4997-7468-4754-A6D6-3748008A7D4E}" | 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
TrackingIdentifier
A tracking identifier is a number or alphanumeric string consisting of a series of numbers and letters, used to uniquely identify a handling unit associated with a shipment.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Tracking Identifier |
description | A tracking identifier is a number or alphanumeric string consisting of a series of numbers and letters, used to uniquely identify a handling unit associated with a shipment. |
dataFormat | string |
maximumLength | 2048 |
isNullable | true |
Traits
List of traits for the TrackingIdentifier 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 | "{121B10AA-2695-4A35-8AB1-A8BC71635A90}" | 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.
ShipmentBookingNumber
Reservation number used to secure equipment and act as a control number prior to completion of a B/L.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment Booking Number |
description | Reservation number used to secure equipment and act as a control number prior to completion of a B/L. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the ShipmentBookingNumber 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 | "{52C542FF-DAA2-48E7-8717-F9D38C1F3C64}" | 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
ExportLicenseNumber
An export license number that may be associated with the shipment.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Export License Number |
description | An export license number that may be associated with the shipment. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the ExportLicenseNumber 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 | "{BA65F2D9-8A5D-435C-AB6D-6CDD78945DF1}" | 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
InsurancePolicyId
The unique identifier of an Insurance Policy.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Insurance Policy ID |
description | The unique identifier of an Insurance Policy. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the InsurancePolicyId 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 | "{256A4F3F-73E4-4845-9360-3FF1C3864016}" | 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
GlobalShipmentIdentificationNumber
The Global Shipment Identification Number (GSIN) is part of the GS1 system of standards. It's used to identify shipments.
A shipment, which may be comprised of one or more logistic units, is intended to be delivered together. The logistic units belonging to a particular shipment keep the same GSIN during all transport stages, from origin to final destination.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Global Shipment Identification Number (GSIN) |
description | The Global Shipment Identification Number (GSIN) is part of the GS1 system of standards. It's used to identify shipments.
A shipment, which may be comprised of one or more logistic units, is intended to be delivered together. The logistic units belonging to a particular shipment keep the same GSIN during all transport stages, from origin to final destination. |
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the GlobalShipmentIdentificationNumber attribute are listed here.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
Parameter | Value | Data type | Explanation |
---|---|---|---|
precision | "17" | integer | the total number of significant digits |
scale | "0" | 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 | "{5D11A98B-3C72-4EB8-BE24-8CC2D3F068E8}" | 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
GlobalIdentificationNumberForConsignment
The Global Identification Number for Consignment (GINC) is part of the GS1 system of standards. It's used to identify a grouping of goods that has been consigned to a freight forwarder and is intended to be transported as a single group.
GINC is used to identify consignments comprised of one or more logistic units, potentially belonging to different shipments, that are intended to be transported together for a portion of their transportation journey. This typically occurs when shipments are consolidated.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Global Identification Number For Consignment (GINC) |
description | The Global Identification Number for Consignment (GINC) is part of the GS1 system of standards. It's used to identify a grouping of goods that has been consigned to a freight forwarder and is intended to be transported as a single group.
GINC is used to identify consignments comprised of one or more logistic units, potentially belonging to different shipments, that are intended to be transported together for a portion of their transportation journey. This typically occurs when shipments are consolidated. |
dataFormat | string |
maximumLength | 30 |
isNullable | true |
Traits
List of traits for the GlobalIdentificationNumberForConsignment 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 | "{94D0715F-B88E-4AD3-94FD-22B267069463}" | 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.
ShipmentOrderId
The unique number that identifies an Order.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment Order ID |
description | The unique number that identifies an Order. |
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the ShipmentOrderId 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 | "{47E880E2-5D17-4052-A849-275B3BD4077B}" | 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.
ShipmentOrderLineNumber
The number that identifies the Order Line Item.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment Order Line Number |
description | The number that identifies the Order Line Item. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the ShipmentOrderLineNumber 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 | "{6825E037-FFF6-40F4-BB3A-C147553A6BB4}" | 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
ConsignorName
The name of the person or firm whose name appears on the air waybill as the party contracting with the carrier for carriage of the goods. Usually the shipper.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Consignor Name |
description | The name of the person or firm whose name appears on the air waybill as the party contracting with the carrier for carriage of the goods. Usually the shipper. |
dataFormat | string |
maximumLength | 256 |
isNullable | true |
Traits
List of traits for the ConsignorName 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 | "{210E2777-E90E-43E7-95B5-9F68720A3E57}" | 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.
ConsignorPartyId
The unique identifier of a Party.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Consignor Party ID |
description | The unique identifier of a Party. |
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the ConsignorPartyId attribute are listed here.
is.dataFormat.integer
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| 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 | "{42F98F17-B550-4720-B3A0-A8D7105DA78C}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.dataFormat.integer
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
ConsignorCustomerAccountId
The unique identifier of a Customer Account.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Consignor Customer Account ID |
description | The unique identifier of a Customer Account. |
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the ConsignorCustomerAccountId attribute are listed here.
is.dataFormat.integer
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| 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 | "{6EA55BEF-870E-49D4-AA89-9BE500FD02F6}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.dataFormat.integer
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
ConsignorLocationId
The unique identifier of a Location.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Consignor Location ID |
description | The unique identifier of a Location. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the ConsignorLocationId 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 | "{34287B8A-CA85-45B1-BAAD-3D72228E31C5}" | 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
ConsignorSignatureImage
The consignor's signature or signature image.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Consignor Signature Image |
description | The consignor's signature or signature image. |
dataFormat | binary |
isNullable | true |
Traits
List of traits for the ConsignorSignatureImage attribute are listed here.
is.dataFormat.byte
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 | "{21086169-1C2B-479B-A91B-AFAFDD1ECCCE}" | 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.byte
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.
ConsigneeName
The Consignee is the person or legal entity in a freight contract to whom goods have been shipped or turned over to care.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Consignee Name |
description | The Consignee is the person or legal entity in a freight contract to whom goods have been shipped or turned over to care. |
dataFormat | string |
maximumLength | 256 |
isNullable | true |
Traits
List of traits for the ConsigneeName 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 | "{052E3935-F909-4214-972B-697D804FBE49}" | 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.
ConsigneePartyId
The unique identifier of a Party.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Consignee Party ID |
description | The unique identifier of a Party. |
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the ConsigneePartyId attribute are listed here.
is.dataFormat.integer
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| 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 | "{3EC38108-F0BB-4849-A91B-BB48B09B93B4}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.dataFormat.integer
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
ConsigneeCustomerAccountId
The unique identifier of a Customer Account.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Consignee Customer Account ID |
description | The unique identifier of a Customer Account. |
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the ConsigneeCustomerAccountId attribute are listed here.
is.dataFormat.integer
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| 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 | "{71D2F0AB-41B0-44FE-B1E2-CFA60D0074B0}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.dataFormat.integer
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
ConsigneeLocationId
The unique identifier of a Location.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Consignee Location ID |
description | The unique identifier of a Location. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the ConsigneeLocationId 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 | "{4DF03C01-0E16-43CA-9E08-ED30332E584C}" | 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
ConsigneeSignatureImage
The consignee's signature or signature image.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Consignee Signature Image |
description | The consignee's signature or signature image. |
dataFormat | binary |
isNullable | true |
Traits
List of traits for the ConsigneeSignatureImage attribute are listed here.
is.dataFormat.byte
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 | "{1CF066D3-2D8A-4694-A09F-33BC610899BC}" | 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.byte
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.
NotifyPartyId
The unique identifier of a Party.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Notify Party ID |
description | The unique identifier of a Party. |
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the NotifyPartyId attribute are listed here.
is.dataFormat.integer
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| 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 | "{271DB30E-8ADB-4293-BD57-425ED4B47916}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.dataFormat.integer
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
ShipmentFromName
The name of the ship-from party.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment From Name |
description | The name of the ship-from party. |
dataFormat | string |
maximumLength | 256 |
isNullable | true |
Traits
List of traits for the ShipmentFromName 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 | "{7E9C3666-E8C8-43DD-A907-C0349F38BBC4}" | 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.
ShipmentFromLocationId
The unique identifier of a Location.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment-From Location ID |
description | The unique identifier of a Location. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the ShipmentFromLocationId 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 | "{49DB506A-F386-4B68-B02E-499976EACCC0}" | 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
OriginationWarehouseId
The unique identifier of a Warehouse.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Origination Warehouse ID |
description | The unique identifier of a Warehouse. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the OriginationWarehouseId 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 | "{7AF357B6-50A2-48FB-BE31-98EEC52E8F4C}" | 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
ShipmentToName
The name of the ship-to party.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment To Name |
description | The name of the ship-to party. |
dataFormat | string |
maximumLength | 256 |
isNullable | true |
Traits
List of traits for the ShipmentToName 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 | "{77D76CAE-3F41-4BF8-BFAD-36BDAB1C2F65}" | 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.
ShipmentToLocationId
The unique identifier of a Location.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment-To Location ID |
description | The unique identifier of a Location. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the ShipmentToLocationId 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 | "{16A2C784-C0AE-42B8-9C78-CA1751C7A359}" | 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
DestinationWarehouseId
The unique identifier of a Warehouse.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Destination Warehouse ID |
description | The unique identifier of a Warehouse. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the DestinationWarehouseId 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 | "{5082B892-7C0E-40CE-BE5F-410D0DC7ACEE}" | 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
ShipmentConditionId
The unique identifier of a Shipment Condition.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment Condition ID |
description | The unique identifier of a Shipment Condition. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the ShipmentConditionId 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 | "{28990B9A-8526-429C-BC2E-13CB34B613E6}" | 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
ShipmentTotalNetWeight
Net Weight - The total weight of a shipment less the weight of containers, pallets, nets or straps.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment Total Net Weight |
description | Net Weight - The total weight of a shipment less the weight of containers, pallets, nets or straps. |
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the ShipmentTotalNetWeight 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 | "{5E536770-7E16-41EB-88B3-DFBF874E79D0}" | 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
ShipmentTotalGrossWeight
The full weight of a shipment including goods and packaging.
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: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment Total Gross Weight |
description | The full weight of a shipment including goods and packaging.
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 ShipmentTotalGrossWeight 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 | "{5838CF40-6EE9-4C94-998B-90D4C1218131}" | 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
ShipmentTotalChargeableWeight
The weight of the shipment used in determining shipment 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: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment Total Chargeable Weight |
description | The weight of the shipment used in determining shipment 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 ShipmentTotalChargeableWeight 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 | "{7EBC18EB-1CDB-45F0-B575-54B94F4F452F}" | 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
PackingInstructions
Instructions for shipping personnel regarding the associated Shipment.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Packing Instructions |
description | Instructions for shipping personnel regarding the associated Shipment. |
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 | "{55ADD31E-C049-401F-AA0A-5711A531CAAB}" | 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.
DeliveryInstructions
Specific information provided to the inland carrier concerning the arrangement made by the Freight Forwarder to deliver items to the particular pier or steamship line.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Delivery Instructions |
description | Specific information provided to the inland carrier concerning the arrangement made by the Freight Forwarder to deliver items to the particular pier or steamship line. |
dataFormat | string |
maximumLength | 2048 |
isNullable | true |
Traits
List of traits for the DeliveryInstructions 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 | "{539BAC80-DBCF-4AC2-B19B-2EDD0296051F}" | 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.
ArrangementsInAdvanceInstructions
Certain commodities, such as gold, gems, live animals etc., require arrangements to be made in advance with the Carriers.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Arrangements In Advance Instructions |
description | Certain commodities, such as gold, gems, live animals etc., require arrangements to be made in advance with the Carriers. |
dataFormat | string |
maximumLength | 2048 |
isNullable | true |
Traits
List of traits for the ArrangementsInAdvanceInstructions 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 | "{3C7247CB-A382-4100-B9EA-AA863291E3E5}" | 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.
DeclarationByForeignShipperStatement
A statement by the Shipper in the foreign country attesting to certain facts.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Declaration By Foreign Shipper Statement |
description | A statement by the Shipper in the foreign country attesting to certain facts. |
dataFormat | string |
maximumLength | 2048 |
isNullable | true |
Traits
List of traits for the DeclarationByForeignShipperStatement 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 | "{0EE844B4-C5B7-4760-B422-AD3E79083501}" | 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.
HiddenDamageStatement
The statement regarding to any hidden damages allocated to the Shipment.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Hidden Damage Statement |
description | The statement regarding to any hidden damages allocated to the Shipment. |
dataFormat | string |
maximumLength | 2048 |
isNullable | true |
Traits
List of traits for the HiddenDamageStatement 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 | "{2DAA3CAB-3653-42AE-8A6E-50B4747D7D51}" | 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.
ArrivalNoticeStatement
An advice that the carrier sends to the consignee advising of goods coming forward for delivery. Pertinent information such as BL number, container number and total charges due from consignee etc., are included and sent to consignee prior to vessel arrival. This is done gratuitously by the carrier to ensure smooth delivery but There's no obligation by the carrier to do so. The responsibility to monitor the transit and present himself to take timely delivery still rests with the consignee.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Arrival Notice Statement |
description | An advice that the carrier sends to the consignee advising of goods coming forward for delivery. Pertinent information such as BL number, container number and total charges due from consignee etc., are included and sent to consignee prior to vessel arrival. This is done gratuitously by the carrier to ensure smooth delivery but There's no obligation by the carrier to do so. The responsibility to monitor the transit and present himself to take timely delivery still rests with the consignee. |
dataFormat | string |
maximumLength | 2048 |
isNullable | true |
Traits
List of traits for the ArrivalNoticeStatement 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 | "{72AC16AA-C259-443A-A3C2-935EA080D851}" | 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.
EstimatedShipmentCost
The estimated total shipment cost amount.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Estimated Shipment Cost |
description | The estimated total shipment cost amount. |
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the EstimatedShipmentCost 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 | "{1C4D433F-B220-4457-91A3-B92CC6F5F9CE}" | 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
ShipmentAgreedValuationAmount
The value of a shipment agreed upon in order to secure a specific freight rate.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment Agreed Valuation Amount |
description | The value of a shipment agreed upon in order to secure a specific freight rate. |
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the ShipmentAgreedValuationAmount 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 | "{385B1E14-4BF1-47C0-ADA7-AA7594E7C552}" | 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
ShipmentCarrierLiabilityAmount
The amount of declared value on a shipment that is over the carrier's liability
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment Carrier Liability Amount |
description | The amount of declared value on a shipment that is over the carrier's liability |
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the ShipmentCarrierLiabilityAmount 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 | "{23B0836D-CC1E-4616-B11D-F93336FDDC49}" | 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
ShipmentAllInAmount
The total price to move cargo from origin to destination, inclusive of all charges.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment All-In Amount |
description | The total price to move cargo from origin to destination, inclusive of all charges. |
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the ShipmentAllInAmount 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 | "{31ED2529-8972-4BCC-A3E4-870EAABF344A}" | 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
ShipmentExcessValueAmount
The amount of declared value on a shipment that is over the carrier's liability
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment Excess Value Amount |
description | The amount of declared value on a shipment that is over the carrier's liability |
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the ShipmentExcessValueAmount 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 | "{2BC6D16B-8E96-40B7-B0F8-322B6A2143EA}" | 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
ShipmentTotalChargesAmount
The total amount of all charges associated with the shipment.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment Total Charges Amount |
description | The total amount of all charges associated with the shipment. |
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the ShipmentTotalChargesAmount 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 | "{B2531B4D-8929-4C9F-A458-841A6E95F69B}" | 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
CollectOnDeliveryIndicator
Indicates that the shipment is collect.
A transportation service under which the purchase price of the goods in collected by the carrier from the receiver at the time of delivery. Payment Is subsequently transmitted to the shipper. Carriers charge a nominal fee for this service. Payment is due upon delivery. There are no credit provisions in COD service.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Collect On Delivery Indicator |
description | Indicates that the shipment is collect.
A transportation service under which the purchase price of the goods in collected by the carrier from the receiver at the time of delivery. Payment Is subsequently transmitted to the shipper. Carriers charge a nominal fee for this service. Payment is due upon delivery. There are no credit provisions in COD service. |
dataFormat | boolean |
isNullable | true |
Traits
List of traits for the CollectOnDeliveryIndicator 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 | "{271CC3D8-9E47-48FA-8F8B-44E36BF8D596}" | 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
AutomaticProofOfDeliveryRequiredIndicator
Indicates that a POD is required.
An Automatic Proof of Delivery (POD) is information automatically sent to payer containing name of person who signed for the package with timestamp of delivery.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Automatic Proof Of Delivery Required Indicator |
description | Indicates that a POD is required.
An Automatic Proof of Delivery (POD) is information automatically sent to payer containing name of person who signed for the package with timestamp of delivery. |
dataFormat | boolean |
isNullable | true |
Traits
List of traits for the AutomaticProofOfDeliveryRequiredIndicator 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 | "{60B3F5D8-0E0B-4858-85E4-0543852ACB1E}" | 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
HoldForPickupShipmentIndicator
Indicates that freight is to be held at the carrier's destination location for pickup by the recipient.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Hold For Pickup Shipment Indicator |
description | Indicates that freight is to be held at the carrier's destination location for pickup by the recipient. |
dataFormat | boolean |
isNullable | true |
Traits
List of traits for the HoldForPickupShipmentIndicator 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 | "{5AA24B8C-6943-4BB8-A65B-5291D4BB0BED}" | 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
AstrayShipmentIndicator
Indicates that the shipment is traveling without paperwork or on paperwork in place of the original
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Astray Shipment Indicator |
description | Indicates that the shipment is traveling without paperwork or on paperwork in place of the original |
dataFormat | boolean |
isNullable | true |
Traits
List of traits for the AstrayShipmentIndicator 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 | "{125954BC-275D-4E07-8300-150A15A15ABA}" | 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
InterlineShipmentIndicator
Indicates that the shipment requires the movement of a shipment via two or more carriers.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Interline Shipment Indicator |
description | Indicates that the shipment requires the movement of a shipment via two or more carriers. |
dataFormat | boolean |
isNullable | true |
Traits
List of traits for the InterlineShipmentIndicator 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 | "{1CEF6A49-6220-4577-B710-F5018D3C56A6}" | 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
IntermodalShipmentIndicator
Indicates that the shipment requires the movement of goods by more than one mode of Transport, i.e. railroad, truck, ship and airplane, in the same ULD, under a singe waybill.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Intermodal Shipment Indicator |
description | Indicates that the shipment requires the movement of goods by more than one mode of Transport, i.e. railroad, truck, ship and airplane, in the same ULD, under a singe waybill. |
dataFormat | boolean |
isNullable | true |
Traits
List of traits for the IntermodalShipmentIndicator 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 | "{0201B65B-2144-4748-8F2E-D67F56962E2A}" | 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
PrePaidShipmentIndicator
Freight and charges are required to be paid by shipper before original bill of lading is released to them.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Pre-Paid Shipment Indicator |
description | Freight and charges are required to be paid by shipper before original bill of lading is released to them. |
dataFormat | boolean |
isNullable | true |
Traits
List of traits for the PrePaidShipmentIndicator 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 | "{8854A788-3F0A-44FD-9733-4E58DF6C58E1}" | 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
WithoutReserveShipmentIndicator
A term indicating that a shipper's agent or representative is empowered to make definitive decisions and adjustments abroad without approval of the group or individual represented
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Without Reserve Shipment Indicator |
description | A term indicating that a shipper's agent or representative is empowered to make definitive decisions and adjustments abroad without approval of the group or individual represented |
dataFormat | boolean |
isNullable | true |
Traits
List of traits for the WithoutReserveShipmentIndicator 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 | "{0E1F7F3B-2A9B-4555-A60B-4E00A8AF4C59}" | 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
NotifyOnArrivalIndicator
Indicates that the consignor requires to be notified upon receipt of the shipment.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Notify On Arrival Indicator |
description | Indicates that the consignor requires to be notified upon receipt of the shipment. |
dataFormat | boolean |
isNullable | true |
Traits
List of traits for the NotifyOnArrivalIndicator 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 | "{32EE3769-F09A-4962-86A8-AF4F8BD8F775}" | 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
DoorToDoorShipmentIndicator
Through transportation of a container and its contents from consignor's premises to consignee's premises.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Door-To-Door Shipment Indicator |
description | Through transportation of a container and its contents from consignor's premises to consignee's premises. |
dataFormat | boolean |
isNullable | true |
Traits
List of traits for the DoorToDoorShipmentIndicator 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 | "{0C2497EC-B3DD-43DB-97A9-F0FD78D3E58E}" | 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
ConsolidatedShipmentIndicator
Numerous shipments from different shippers to one consignee that are consolidated and treated as a single consignment.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Consolidated (Aggregated) Shipment Indicator |
description | Numerous shipments from different shippers to one consignee that are consolidated and treated as a single consignment. |
dataFormat | boolean |
isNullable | true |
Traits
List of traits for the ConsolidatedShipmentIndicator 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 | "{3738EF82-50D4-492C-9356-FB3DE3B8D0E7}" | 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
UnclaimedShipmentIndicator
Indicates that the shipment has been unclaimed.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Unclaimed Shipment Indicator |
description | Indicates that the shipment has been unclaimed. |
dataFormat | boolean |
isNullable | true |
Traits
List of traits for the UnclaimedShipmentIndicator 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 | "{20798B7B-D689-4422-91F3-C0B10992C4FE}" | 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
PartialShipmentAcceptableIndicator
An indicator denoting that the customer has agreed to partial shipments.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Partial Shipment Acceptable Indicator |
description | An indicator denoting that the customer has agreed to partial shipments. |
dataFormat | boolean |
isNullable | true |
Traits
List of traits for the PartialShipmentAcceptableIndicator 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 | "{5719C3F5-F6B5-4AD7-A048-12A796954E5B}" | 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
EstimatedNumberDeliveryDays
The estimated number of days to deliver the Shipment.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Estimated Number Delivery Days |
description | The estimated number of days to deliver the Shipment. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the EstimatedNumberDeliveryDays 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 | "{013264E7-5A43-4623-98A5-13749A4436A7}" | 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
LatestAvailableShipDate
The latest ship date that is acceptable to the customer.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Latest Available Ship Date |
description | The latest ship date that is acceptable to the customer. |
dataFormat | date |
isNullable | true |
Traits
List of traits for the LatestAvailableShipDate attribute are listed here.
is.dataFormat.date
means.measurement.date
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
Parameter | Value | Data type | Explanation |
---|---|---|---|
identifier | "{00EB1AA6-3DFF-4100-BC67-B1F6521990D2}" | 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.date
ShipmentTenderTimestamp
The timestamp that the shipment was tendered or place or shipment.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment Tender Timestamp |
description | The timestamp that the shipment was tendered or place or shipment. |
dataFormat | dateTime |
isNullable | true |
Traits
List of traits for the ShipmentTenderTimestamp attribute are listed here.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
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 | "{06D60DAC-7B1E-44C8-A1CF-2C72F58D47D4}" | 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.time
is.dataFormat.date
PlannedEarliestPickUpTimestamp
The earliest that the shipment can be picked up.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Planned Earliest Pick-Up Timestamp |
description | The earliest that the shipment can be picked up. |
dataFormat | dateTime |
isNullable | true |
Traits
List of traits for the PlannedEarliestPickUpTimestamp attribute are listed here.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
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 | "{13A37490-80E8-436E-8232-1ED74570A049}" | 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.time
is.dataFormat.date
PlannedLatestPickUpTimestamp
The latest that the shipment can be picked-up.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Planned Latest Pick-Up Timestamp |
description | The latest that the shipment can be picked-up. |
dataFormat | dateTime |
isNullable | true |
Traits
List of traits for the PlannedLatestPickUpTimestamp attribute are listed here.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
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 | "{1D78D3E6-1B92-4E32-A069-E0D124406B84}" | 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.time
is.dataFormat.date
PlannedEarliestDeliveryTimestamp
The earliest that the shipment can be delivered.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Planned Earliest Delivery Timestamp |
description | The earliest that the shipment can be delivered. |
dataFormat | dateTime |
isNullable | true |
Traits
List of traits for the PlannedEarliestDeliveryTimestamp attribute are listed here.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
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 | "{182F5949-34C7-4CA3-A663-E821EE8C71C1}" | 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.time
is.dataFormat.date
PlannedLatestDeliveryTimestamp
The latest that the shipment can be delivered.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Planned Latest Delivery Timestamp |
description | The latest that the shipment can be delivered. |
dataFormat | dateTime |
isNullable | true |
Traits
List of traits for the PlannedLatestDeliveryTimestamp attribute are listed here.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
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 | "{3426A5FF-6E6B-4C7E-B47A-2E471C67857A}" | 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.time
is.dataFormat.date
PlannedShipTimestamp
The planned date of shipment.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Planned Ship Timestamp |
description | The planned date of shipment. |
dataFormat | dateTime |
isNullable | true |
Traits
List of traits for the PlannedShipTimestamp attribute are listed here.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
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 | "{882825D6-95E9-46F1-BF2D-CF4B8EC92D08}" | 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.time
is.dataFormat.date
ActualShipTimestamp
The actual shipment date.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Actual Ship Timestamp |
description | The actual shipment date. |
dataFormat | dateTime |
isNullable | true |
Traits
List of traits for the ActualShipTimestamp attribute are listed here.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
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 | "{05143488-88B0-47F3-AA77-43C620615B64}" | 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.time
is.dataFormat.date
CleanBillOfLadingTimestamp
The date that a clear bill of lading was determined, which is a receipt for goods issued by the Carrier indicating that the goods were received in good order and condition, without damages.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Clean Bill Of Lading Timestamp |
description | The date that a clear bill of lading was determined, which is a receipt for goods issued by the Carrier indicating that the goods were received in good order and condition, without damages. |
dataFormat | dateTime |
isNullable | true |
Traits
List of traits for the CleanBillOfLadingTimestamp attribute are listed here.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
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 | "{8E24DEEB-A9E6-4481-A8AF-E983BDE66E63}" | 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.time
is.dataFormat.date
ReleaseNoteTimestamp
Receipt signed by customer acknowledging delivery of goods.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Release Note Timestamp |
description | Receipt signed by customer acknowledging delivery of goods. |
dataFormat | dateTime |
isNullable | true |
Traits
List of traits for the ReleaseNoteTimestamp attribute are listed here.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
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 | "{BFF1BBCE-95ED-4E30-A2B1-76BB03F3577E}" | 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.time
is.dataFormat.date
EstimatedDeliveryTimestamp
Estimated delivery timestamp.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Estimated Delivery Timestamp |
description | Estimated delivery timestamp. |
dataFormat | dateTime |
isNullable | true |
Traits
List of traits for the EstimatedDeliveryTimestamp attribute are listed here.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
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 | "{2705EFF4-7340-45A9-96CE-4C9527BDE95F}" | 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.time
is.dataFormat.date
ShipmentDeliveryTimestamp
The timestamp that the shipment was received or delivered at the ship-to address.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment Delivery Timestamp |
description | The timestamp that the shipment was received or delivered at the ship-to address. |
dataFormat | dateTime |
isNullable | true |
Traits
List of traits for the ShipmentDeliveryTimestamp attribute are listed here.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
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 | "{124D3692-1203-4267-8F43-2A4356B21750}" | 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.time
is.dataFormat.date
ArrivalNoticeIssuedTimestamp
The date that the Arrival Notice was issued or sent.
An advice that the carrier sends to the consignee advising of goods coming forward for delivery. Pertinent information such as BL number, container number and total charges due from consignee etc., are included and sent to consignee prior to vessel arrival. This is done gratuitously by the carrier to ensure smooth delivery but There's no obligation by the carrier to do so. The responsibility to monitor the transit and present himself to take timely delivery still rests with the consignee.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Arrival Notice Issued Timestamp |
description | The date that the Arrival Notice was issued or sent.
An advice that the carrier sends to the consignee advising of goods coming forward for delivery. Pertinent information such as BL number, container number and total charges due from consignee etc., are included and sent to consignee prior to vessel arrival. This is done gratuitously by the carrier to ensure smooth delivery but There's no obligation by the carrier to do so. The responsibility to monitor the transit and present himself to take timely delivery still rests with the consignee. |
dataFormat | dateTime |
isNullable | true |
Traits
List of traits for the ArrivalNoticeIssuedTimestamp attribute are listed here.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
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 | "{4C7250AD-E2E9-414A-950F-E545644C83D1}" | 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.time
is.dataFormat.date
AutomaticProofOfDeliveryPodIssuedTimestamp
The date that the automatic proof of delivery (POD) was issued.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Automatic Proof Of Delivery POD Issued Timestamp |
description | The date that the automatic proof of delivery (POD) was issued. |
dataFormat | dateTime |
isNullable | true |
Traits
List of traits for the AutomaticProofOfDeliveryPodIssuedTimestamp attribute are listed here.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
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 | "{058B8FBA-F72E-4F8A-8576-FB6059B96CD3}" | 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.time
is.dataFormat.date
PackingTypeId
The unique identifier of a Packing Type.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Packing Type ID |
description | The unique identifier of a Packing Type. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the PackingTypeId 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 | "{694AB817-561C-48D0-9881-90BB154A3EA7}" | 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
ShipmentTypeId
The unique identifier of a Shipment Type.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment Type ID |
description | The unique identifier of a Shipment Type. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the ShipmentTypeId 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 | "{2C74D5B9-07B4-42F0-9713-AB9FD85CC827}" | 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
ShipmentPriorityId
The unique identifier of a Shipment Priority.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment Priority ID |
description | The unique identifier of a Shipment Priority. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the ShipmentPriorityId 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 | "{07526A88-8D34-4E1A-A6B0-243B06AA31A5}" | 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
ShipmentMethodId
The unique identifier of a Shipment Method.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment Method ID |
description | The unique identifier of a Shipment Method. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the ShipmentMethodId 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 | "{086D12E2-CA8E-4B3B-AFCC-F340287C5C40}" | 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
IncotermId
The unique identifier of a Incoterm.
First included in: Shipment (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 | "{BD120F01-10F1-4143-A9F3-93EDAA87DB22}" | 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
CarrierId
The unique identifier of a Carrier.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Carrier ID |
description | The unique identifier of a Carrier. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the CarrierId 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 | "{5A1DD443-C10E-4D2A-8951-677F0DF35C17}" | 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
RequestedCarrierId
The unique identifier of a Carrier.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Requested Carrier ID |
description | The unique identifier of a Carrier. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the RequestedCarrierId 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 | "{67378AE2-A6FC-4958-B9EF-7EED9EF765C8}" | 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
ChannelId
The unique identifier of a Channel.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Channel ID |
description | The unique identifier of a Channel. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the ChannelId 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 | "{2D1B9AE1-FC0A-4BFB-927D-D85013DA75FA}" | 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: Shipment (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 | "{37A3DAD8-4814-44BB-9EE8-6155FFF047C9}" | 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
PalletTypeId
The unique identifier of a Pallet Type.
First included in: Shipment (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 | "{0BC10A8D-A148-4FAD-9D51-7F0C3206D600}" | 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: Shipment (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 | "{1B8835F7-797B-496B-8D7B-80DEF6255062}" | 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.
ItemSku
The Stock Keeping Unit identifier, which is typically used for inventory-related activities.
First included in: Shipment (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 | "{686108B2-7798-47FF-82C3-E10859437B81}" | 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.
ShipmentHeight
The height of the Shipment.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment Height |
description | The height of the Shipment. |
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the ShipmentHeight 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 | "{2BF394E7-17C1-4B38-B4A3-A521ADB721A6}" | 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
ShipmentWidth
The width of the Shipment.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment Width |
description | The width of the Shipment. |
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the ShipmentWidth 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 | "{5A8ED968-38F0-4487-8F06-0B1C86F88A62}" | 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
ShipmentLength
The length of the Shipment.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment Length |
description | The length of the Shipment. |
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the ShipmentLength 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 | "{07944A30-4EF3-4566-9681-1EB093083B73}" | 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
ShipmentNetWeight
The weight of the Shipment.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment Net Weight |
description | The weight of the Shipment. |
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the ShipmentNetWeight 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 | "{0A79CB91-6715-4600-A18F-5B0E6E9E8D18}" | 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
ShipmentVolume
The volume of the shipment.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Shipment Volume |
description | The volume of the shipment. |
dataFormat | decimal |
isNullable | true |
Traits
List of traits for the ShipmentVolume 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 | "{23920B66-1993-4FD0-A83E-77F1FF0544B5}" | 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
Note: A temporary divider header that is used to separate and organize information for the viewer.
This column is marked 'Logical Only' and is therefore 'for presentation only' and will not be used when generating DDL.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Volume Unit Of Measure ID |
description | Note:
A temporary divider header that is used to separate and organize information for the viewer.
This column is marked 'Logical Only' and is therefore 'for presentation only' and will not be used when generating DDL. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the VolumeUnitOfMeasureId 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 | "{45605A79-5023-45A0-ABCF-B9C60FEBF235}" | 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
LengthWidthHeightUnitOfMeasureId
The unique identifier of a Unit Of Measure.
First included in: Shipment (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
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 | "{8104D781-FEE5-4E0F-9C92-F94535982794}" | 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
WeightUnitOfMeasureId
The unique identifier of a Unit Of Measure.
First included in: Shipment (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
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 | "{145A3D01-79A6-4F4E-B013-C1206ECBA436}" | 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
TimeSpentAtDeliveryLocation
The amount of time spent at the ship-to address to deliver the shipment.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | Time Spent At Delivery Location |
description | The amount of time spent at the ship-to address to deliver the shipment. |
dataFormat | time |
isNullable | true |
Traits
List of traits for the TimeSpentAtDeliveryLocation attribute are listed here.
is.dataFormat.time
means.measurement.time
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 | "{52E94004-E6CB-41E6-884B-F0A1C1ACC78D}" | 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.time
IsoCurrencyCode
The ISO 4217 currency code.
First included in: Shipment (this entity)
Properties
Name | Value |
---|---|
displayName | ISO Currency Code |
description | The ISO 4217 currency code. |
dataFormat | string |
maximumLength | 3 |
isNullable | true |
Traits
List of traits for the IsoCurrencyCode attribute are listed here.
is.dataFormat.character
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| 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 | "3" | integer |
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
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 | "{37605A6E-6AA9-4F72-A6FD-9BDA89DD9A64}" | 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.