RosettaNet XML Message Guidelines
3B3_MG_R01_00_00_ShipmentStatusNotification.htm (03-Jan-2001 15:14)
This document has been prepared by Edifecs (http://www.edifecs.com/)
based on the Business Collaboration Framework from requirements
in conformance with the RosettaNet methodology.
1 |
1 | fromRole.PartnerRoleDescription
|
2 |
1 | |-- ContactInformation
|
3 |
1 | | |-- contactName.FreeFormText
|
4 |
1 | | |-- EmailAddress
|
5 |
0..1 | | |-- facsimileNumber.CommunicationsNumber
|
6 |
1 | | |-- telephoneNumber.CommunicationsNumber
|
7 |
1 | |-- GlobalPartnerRoleClassificationCode
|
8 |
1 | |-- PartnerDescription
|
9 |
1 | | |-- BusinessDescription
|
10 |
1 | | | |-- GlobalBusinessIdentifier
|
11 |
1 | | | |-- GlobalSupplyChainCode
|
12 |
1 | | |-- GlobalPartnerClassificationCode
|
13 |
1 | GlobalDocumentFunctionCode
|
14 |
1..n | ShipmentStatus
|
15 |
0..1 | |-- CustomsInformation
|
16 |
0..1 | | |-- customsEntryNumber.ProprietaryReferenceIdentifier
|
17 |
0..1 | | |-- customsIdentifier.ProprietaryReferenceIdentifier
|
18 |
0..1 | | |-- customsLocation.FreeFormText
|
19 |
0..1 | | |-- GlobalPortOfDeclarationCode
|
20 |
0..n | | |-- GlobalPortOfEntryCode
|
21 |
0..1 | |-- DeliveryException
|
22 |
1 | | |-- DateTimeStamp
|
23 |
1 | | |-- FreeFormText
|
24 |
0..1 | |-- OriginatingPartner
|
25 |
1 | | |-- shipFrom.PartnerDescription
|
26 |
1 | | | |-- BusinessDescription
|
27 |
1 | | | | |-- GlobalBusinessIdentifier
|
28 |
0..1 | | | |-- ContactInformation
|
29 |
1 | | | | |-- contactName.FreeFormText
|
30 |
0..1 | | | | |-- EmailAddress
|
31 |
0..1 | | | | |-- facsimileNumber.CommunicationsNumber
|
32 |
0..1 | | | | |-- PhysicalAddress
|
33 |
0..1 | | | | | |-- addressLine1.FreeFormText
|
34 |
0..1 | | | | | |-- addressLine2.FreeFormText
|
35 |
0..1 | | | | | |-- addressLine3.FreeFormText
|
36 |
0..1 | | | | | |-- cityName.FreeFormText
|
37 |
0..1 | | | | | |-- GlobalCountryCode
|
38 |
0..1 | | | | | |-- GlobalLocationIdentifier
|
39 |
0..1 | | | | | |-- NationalPostalCode
|
40 |
0..1 | | | | | |-- postOfficeBoxIdentifier.FreeFormText
|
41 |
0..1 | | | | | |-- regionName.FreeFormText
|
42 |
0..1 | | | | |-- telephoneNumber.CommunicationsNumber
|
43 |
0..1 | |-- ProofOfDeliveryInformationResource
|
44 |
0..1 | | |-- DigitalCertificateSignature
|
45 |
0..1 | | |-- numberOfShippingContainers.CountableAmount
|
46 |
0..1 | | |-- PhysicalAddress
|
47 |
0..1 | | | |-- addressLine1.FreeFormText
|
48 |
0..1 | | | |-- addressLine2.FreeFormText
|
49 |
0..1 | | | |-- addressLine3.FreeFormText
|
50 |
1 | | | |-- cityName.FreeFormText
|
51 |
0..1 | | | |-- GlobalCountryCode
|
52 |
0..1 | | | |-- GlobalLocationIdentifier
|
53 |
0..1 | | | |-- NationalPostalCode
|
54 |
0..1 | | | |-- postOfficeBoxIdentifier.FreeFormText
|
55 |
0..1 | | | |-- regionName.FreeFormText
|
56 |
0..1 | | |-- receivedByName.FreeFormText
|
57 |
1 | |-- Shipment
|
58 |
0..n | | |-- GlobalCarrierCode
|
59 |
0..1 | | |-- GlobalShipmentChangeDispositionCode
|
60 |
0..1 | | |-- GlobalShipmentModeCode
|
61 |
1 | | |-- numberOfShippingContainers.CountableAmount
|
62 |
0..1 | | |-- shipmentChangeReason.FreeFormText
|
63 |
1 | | |-- shipmentIdentifier.ProprietaryReferenceIdentifier
|
64 |
0..1 | | |-- ShipmentTransportationEvent
|
65 |
0..2 | | | |-- confirmedEvent.TransportationEvent
|
66 |
1 | | | | |-- DateStamp
|
67 |
1 | | | | |-- GlobalTransportEventCode
|
68 |
0..2 | | | |-- revisedScheduledEvent.TransportationEvent
|
69 |
1 | | | | |-- DateStamp
|
70 |
1 | | | | |-- GlobalTransportEventCode
|
71 |
0..2 | | | |-- scheduledEvent.TransportationEvent
|
72 |
1 | | | | |-- DateStamp
|
73 |
1 | | | | |-- GlobalTransportEventCode
|
74 |
1..n | | |-- ShippingContainer
|
75 |
0..1 | | | |-- DeliveryException
|
76 |
1 | | | | |-- DateTimeStamp
|
77 |
1 | | | | |-- FreeFormText
|
78 |
0..1 | | | |-- ShipmentStatusDetail
|
79 |
1..n | | | | |-- GlobalShipmentStatusReportingLevelCode
|
80 |
0..1 | | | | |-- pickupPeriod.DateTimePeriod
|
81 |
0..1 | | | | | |-- beginDateTime.DateTimeStamp
|
82 |
0..1 | | | | | |-- endDateTime.DateTimeStamp
|
83 |
1 | | | | |-- shipmentLocation.PhysicalAddress
|
84 |
0..1 | | | | | |-- addressLine1.FreeFormText
|
85 |
0..1 | | | | | |-- addressLine2.FreeFormText
|
86 |
0..1 | | | | | |-- addressLine3.FreeFormText
|
87 |
0..1 | | | | | |-- cityName.FreeFormText
|
88 |
0..1 | | | | | |-- GlobalCountryCode
|
89 |
0..1 | | | | | |-- GlobalLocationIdentifier
|
90 |
0..1 | | | | | |-- NationalPostalCode
|
91 |
0..1 | | | | | |-- postOfficeBoxIdentifier.FreeFormText
|
92 |
0..1 | | | | | |-- regionName.FreeFormText
|
93 |
1 | | | | |-- shipmentStatusDateTime.DateTimeStamp
|
94 |
0..1 | | | | |-- shipmentStatusDescription.FreeFormText
|
95 |
1..n | | | | |-- ShipmentStatusEvent
|
96 |
1 | | | | | |-- DateTimeStamp
|
97 |
1 | | | | | |-- GlobalShipmentStatusCode
|
98 |
1 | | | |-- shippingContainerIdentifier.ProprietarySerialIdentifier
|
99 |
0..n | | | |-- ShippingContainerItem
|
100 |
1..n | | | | |-- DocumentSubLineReference
|
101 |
1 | | | | | |-- GlobalDocumentReferenceTypeCode
|
102 |
0..1 | | | | | |-- LineNumber
|
103 |
1 | | | | | |-- ProprietaryDocumentIdentifier
|
104 |
0..1 | | | | | |-- subLineNumber.LineNumber
|
105 |
0..1 | | | | |-- numberOfItemPackages.CountableAmount
|
106 |
0..1 | | | | |-- shippingContainerIdentifier.ProprietarySerialIdentifier
|
107 |
0..n | | | | |-- traceIdentifier.ProprietaryLotIdentifier
|
108 |
0..n | | |-- TrackingReference
|
109 |
1 | | | |-- GlobalTrackingReferenceTypeCode
|
110 |
1 | | | |-- ProprietaryShipmentTrackingIdentifier
|
111 |
0..1 | | |-- transportedBy.PartnerDescription
|
112 |
1 | | | |-- BusinessDescription
|
113 |
1 | | | | |-- GlobalBusinessIdentifier
|
114 |
0..1 | | | |-- ContactInformation
|
115 |
1 | | | | |-- contactName.FreeFormText
|
116 |
0..1 | | | | |-- EmailAddress
|
117 |
0..1 | | | | |-- facsimileNumber.CommunicationsNumber
|
118 |
0..1 | | | | |-- PhysicalAddress
|
119 |
0..1 | | | | | |-- addressLine1.FreeFormText
|
120 |
0..1 | | | | | |-- addressLine2.FreeFormText
|
121 |
0..1 | | | | | |-- addressLine3.FreeFormText
|
122 |
0..1 | | | | | |-- cityName.FreeFormText
|
123 |
0..1 | | | | | |-- GlobalCountryCode
|
124 |
0..1 | | | | | |-- GlobalLocationIdentifier
|
125 |
0..1 | | | | | |-- NationalPostalCode
|
126 |
0..1 | | | | | |-- postOfficeBoxIdentifier.FreeFormText
|
127 |
0..1 | | | | | |-- regionName.FreeFormText
|
128 |
0..1 | | | | |-- telephoneNumber.CommunicationsNumber
|
129 |
1 | |-- ShipmentStatusDetail
|
130 |
1..n | | |-- GlobalShipmentStatusReportingLevelCode
|
131 |
0..1 | | |-- pickupPeriod.DateTimePeriod
|
132 |
1 | | | |-- beginDateTime.DateTimeStamp
|
133 |
0..1 | | | |-- endDateTime.DateTimeStamp
|
134 |
1 | | |-- shipmentLocation.PhysicalAddress
|
135 |
0..1 | | | |-- addressLine1.FreeFormText
|
136 |
0..1 | | | |-- addressLine2.FreeFormText
|
137 |
0..1 | | | |-- addressLine3.FreeFormText
|
138 |
1 | | | |-- cityName.FreeFormText
|
139 |
0..1 | | | |-- GlobalCountryCode
|
140 |
0..1 | | | |-- GlobalLocationIdentifier
|
141 |
0..1 | | | |-- NationalPostalCode
|
142 |
0..1 | | | |-- postOfficeBoxIdentifier.FreeFormText
|
143 |
0..1 | | | |-- regionName.FreeFormText
|
144 |
1 | | |-- shipmentStatusDateTime.DateTimeStamp
|
145 |
0..1 | | |-- shipmentStatusDescription.FreeFormText
|
146 |
1..n | | |-- ShipmentStatusEvent
|
147 |
1 | | | |-- DateTimeStamp
|
148 |
1 | | | |-- GlobalShipmentStatusCode
|
149 |
1 | thisDocumentGenerationDateTime.DateTimeStamp
|
150 |
1 | thisDocumentIdentifier.ProprietaryDocumentIdentifier
|
151 |
1 | toRole.PartnerRoleDescription
|
152 |
0..1 | |-- ContactInformation
|
153 |
1 | | |-- contactName.FreeFormText
|
154 |
1 | | |-- EmailAddress
|
155 |
0..1 | | |-- facsimileNumber.CommunicationsNumber
|
156 |
1 | | |-- telephoneNumber.CommunicationsNumber
|
157 |
1 | |-- GlobalPartnerRoleClassificationCode
|
158 |
1 | |-- PartnerDescription
|
159 |
1 | | |-- BusinessDescription
|
160 |
1 | | | |-- GlobalBusinessIdentifier
|
161 |
1 | | | |-- GlobalSupplyChainCode
|
162 |
1 | | |-- GlobalPartnerClassificationCode
|
7: GlobalPartnerRoleClassificationCode |
|---|
Entity Instances |
11: GlobalSupplyChainCode |
|---|
Entity Instances |
12: GlobalPartnerClassificationCode |
|---|
Entity Instances |
13: GlobalDocumentFunctionCode |
|---|
Entity Instances |
19: GlobalPortOfDeclarationCode |
|---|
Entity Instances |
20: GlobalPortOfEntryCode |
|---|
Entity Instances |
37: GlobalCountryCode |
|---|
Entity Instances |
41: regionName.FreeFormText |
|---|
User Notes: RosettaNet suggests the use of ISO defined codes for describing regionName. |
51: GlobalCountryCode |
|---|
Entity Instances |
55: regionName.FreeFormText |
|---|
User Notes: RosettaNet suggests the use of ISO defined codes for describing regionName. |
58: GlobalCarrierCode |
|---|
Entity Instances |
59: GlobalShipmentChangeDispositionCode |
|---|
Entity Instances |
60: GlobalShipmentModeCode |
|---|
Entity Instances |
67: GlobalTransportEventCode |
|---|
Entity Instances |
70: GlobalTransportEventCode |
|---|
Entity Instances |
73: GlobalTransportEventCode |
|---|
Entity Instances |
79: GlobalShipmentStatusReportingLevelCode |
|---|
Entity Instances |
88: GlobalCountryCode |
|---|
Entity Instances |
97: GlobalShipmentStatusCode |
|---|
Entity Instances |
98: shippingContainerIdentifier.ProprietarySerialIdentifier |
|---|
User Notes: The UCC structured identifier (barcode) of the outermost shipping package. |
101: GlobalDocumentReferenceTypeCode |
|---|
Entity Instances |
109: GlobalTrackingReferenceTypeCode |
|---|
Entity Instances |
111: transportedBy.PartnerDescription |
|---|
User Notes: The party arranging or undertaking the transportation of goods from one point to another. |
123: GlobalCountryCode |
|---|
Entity Instances |
127: regionName.FreeFormText |
|---|
User Notes: RosettaNet suggests the use of ISO defined codes for describing regionName. |
130: GlobalShipmentStatusReportingLevelCode |
|---|
Entity Instances |
139: GlobalCountryCode |
|---|
Entity Instances |
143: regionName.FreeFormText |
|---|
User Notes: RosettaNet suggests the use of ISO defined codes for describing regionName. |
148: GlobalShipmentStatusCode |
|---|
Entity Instances |
157: GlobalPartnerRoleClassificationCode |
|---|
Entity Instances |
161: GlobalSupplyChainCode |
|---|
Entity Instances |
162: GlobalPartnerClassificationCode |
|---|
Entity Instances |
Name | Definition |
|---|---|
fromRole | The role initiating a business document exchange. |
contactName | Name of the contact person(s) within the organization. |
facsimileNumber | The numerical schema designed to achieve contact via facsimile. |
telephoneNumber | The numerical schema designed to achieve contact via telephone. |
customsEntryNumber | Unique tracking identification number that identifies a shipment routed through customs. |
customsIdentifier | Unique identification number assigned by a local customs authority. |
customsLocation | The location where Customs activities are performed for a shipment tendered for international transportation.. |
shipFrom | The DUNS or DUNS + 4 number of the location from where the product is to be shipped. |
addressLine1 | The first line of a physical address. |
addressLine2 | The second line of a physical address. |
addressLine3 | The third line of a physical address. |
cityName | The name of a city. |
postOfficeBoxIdentifier | The proprietary identity of a physical address, located at a post office, designed solely to accept and receive mail. |
regionName | The name of a state or province within a country. |
numberOfShippingContainers | A numeric expression of the number of outer containers for product shipping. |
receivedByName | The free form text name of the person who has received a product shipment. |
shipmentIdentifier | Reference identifier assigned by the partner originating a shipment to uniquely identify the shipment. |
confirmedEvent | The date a transportation event is confirmed to occur. |
revisedScheduledEvent | The revised date a transportation event is scheduled to occur. |
scheduledEvent | The date a transportation event is scheduled to occur. |
pickupPeriod | The date range indicating when a shipment may be picked up for tender. |
beginDateTime | The start date and time of a date and time period. |
endDateTime | The end date and time of a date and time period. |
shipmentLocation | The current location of a shipment during the transportation process. |
shipmentStatusDateTime | The date-time when the shipment status was generated. |
shipmentStatusDescription | Free form text description regarding the status of a shipment. |
shippingContainerIdentifier | Unique identifier that represents a shipping container. Normally a UCC structured identifier. Also known as a "license plate". |
subLineNumber | Number of the subline in the document, associated with a given line number. |
numberOfItemPackages | A numeric expression of the number of item packages within a container. |
traceIdentifier | Free form text for a non-serial lot identifier. |
transportedBy | The party responsible for either carrying or forwarding the product. |
thisDocumentGenerationDateTime | The date-time stamp indicating when this document was generated. |
thisDocumentIdentifier | Unique tracking identification number that identifies the business document being sent. |
toRole | The role receiving the document in a business document exchange. |
Name | Definition |
|---|---|
PartnerRoleDescription | The collection of business properties that describe a business partners' role in a partner interface process. |
ContactInformation | The collection of business properties that provide communication and address information for contacting a person, organization or business. |
PartnerDescription | The collection of business properties that describe a business partners' identity and their function in a supply chain. |
BusinessDescription | The collection of business properties that describe a business identity and location. |
ShipmentStatus | The collection of business properties that describe the shipping status of ordered products. |
CustomsInformation | The collection of business properties that describe a information necessary to comply with local Customs regulations during international transportation. |
DeliveryException | The collection of business properties which allows a Transport Service Provider to advise a consignee of delivery status exception reason and time. |
OriginatingPartner | The collection of business properties used to identify the business partner initiating a shipment or transaction. |
PhysicalAddress | The actual physical location of an entity as prescribed by local postal authorities, including country identification as it relates to the party or a product. |
ProofOfDeliveryInformationResource | The collection of business properties that describe proof of delivery information. |
Shipment | The collection of business properties that describe a consignment tendered for transportation from one point to another. |
ShipmentTransportationEvent | The collection of business properties that describes the occurrence of the public conveyance of a shipment of goods. |
TransportationEvent | The collection of business properties that describe the occurrence of the public conveyance of goods as a commercial enterprise. |
ShippingContainer | The collection of business properties that describe the nature and contents of a shipping unit. |
ShipmentStatusDetail | The collection of business properties that describe the shipping status of shipments during the transporation process. |
DateTimePeriod | The collection of business properties that describe a time duration specified by a start and end date stamp and a start and end time stamp. |
ShipmentStatusEvent | The collection of business properties that describe the status of a shipment in the transportation process at a defined period of time.. |
ShippingContainerItem | The collection of business properties that describe the nature and contents of the good contained within shipping unit. |
DocumentSubLineReference | The collection of business properties that allows the description of multiple proprietary documents and applicable line number or subline number references. |
TrackingReference | The collection of business properties that describe information about tracing shipments during the transportation process. |
Name | Definition | Data Type | Min | Max | Representation |
|---|---|---|---|---|---|
FreeFormText | Unformatted text. | String | 1 |
|
|
EmailAddress | Electronic mail address. | String | 1 |
|
|
CommunicationsNumber | The electro-technical communication number, e.g., telephone number, facsimile number, pager number. | String | 1 | 30 | X(30) |
GlobalPartnerRoleClassificationCode | Code identifying a party's role in the supply chain. | String | 1 |
|
|
GlobalBusinessIdentifier | A unique business identifier. The DUNS number is specified by RosettaNet. | Integer | 9 | 9 | 9(9) |
GlobalSupplyChainCode | Code identifying the supply chain for the partner's function. | String | 1 |
|
|
GlobalPartnerClassificationCode | Code identifying a partner's function in the supply chain. | String | 1 |
|
|
GlobalDocumentFunctionCode | Code identifying the function of a document as either a request or a response. | String | 1 |
|
|
ProprietaryReferenceIdentifier | A unique reference identifier for goods, services or business documents. | String | 1 | 255 |
|
GlobalPortOfDeclarationCode | Code identifying the location of export clearance for a product shipment. | String | 1 |
|
|
GlobalPortOfEntryCode | Code identifying the delivery location for the product shipment. | String | 1 |
|
|
DateTimeStamp | Specifies an instance in time. Based on the ISO 8601 specification where "CC" represents the century, "YY" the year, "MM" the month and "DD" the day. The letter "T" is the date/time separator and "hh", "mm", "ss.sss" represent hour, minute and second respectively. This representation is immediately followed by a "Z" to indicate Coordinated Universal Time. Informal format: CCYYMMDDThhmmss.sssZ | DateTime | 13 | 20 | 9(8)X9(6)V9(3)X |
GlobalCountryCode | Code identifying the two character country code specified in ISO 3166-1993. | String | 2 | 2 | X(2) |
GlobalLocationIdentifier | Location uniquely identified by the DUNS +4 number. | Integer | 13 | 13 | 9(13) |
NationalPostalCode | Code identifying geographic location as specified by a national postal code. | String | 1 | 9 | X(9) |
DigitalCertificateSignature | A data structure created using public key cryptography and one-way hash functions to produce a signature on the data that can be authenticated and which is difficult to forge or repudiate. A digital signature is also know as an encrypted message digest. | String | 1 |
|
|
CountableAmount | Dimensionless magnitude, e.g. number of products. | PositiveInteger | 1 | 15 | 9(15) |
GlobalCarrierCode | A unique carrier identification code, based on Standard Carrier Alpha Code(s) | String | 1 |
|
|
GlobalShipmentChangeDispositionCode | Code identifying the additional reasons for a change to a product shipment. | String | 1 |
|
|
GlobalShipmentModeCode | The method of transport used for the conveyance of goods. | String | 1 |
|
|
DateStamp | Specifies a specific date. Date stamp based on the ISO 8601 specification. The "Z" following the day identifier (DD) is used to indicate Coordinated Universal Time. Informal format: CCYYMMDDZ | Date | 9 | 9 | 9(8)X |
GlobalTransportEventCode | Code identifying an event during the transportation of a shipment. | String | 1 |
|
|
GlobalShipmentStatusReportingLevelCode | Code identifying the level of reporting for shipment delivery statuses. | String | 1 |
|
|
GlobalShipmentStatusCode | Code identifying the delivery status for a shipment. | String | 1 |
|
|
ProprietarySerialIdentifier | Unique serial identifier assigned to the product. | String | 1 |
|
|
GlobalDocumentReferenceTypeCode | Code identifying the type of business document used for referencing within another business document. | String | 1 |
|
|
LineNumber | Number of the line in the document. | String | 1 | 6 | X(6) |
ProprietaryDocumentIdentifier | Unique identifier, i.e. a numeric value or alphanumeric value, for a business document. | String | 1 |
|
|
ProprietaryLotIdentifier | A unique identifier representing the manufacturing lot of a Global Product Identifier. | String | 1 |
|
|
GlobalTrackingReferenceTypeCode | Code identifying the type of document reference being used to track a shipment. | String | 1 |
|
|
ProprietaryShipmentTrackingIdentifier | Proprietary unique identifier for tracking product shipments. | String | 1 |
|
|