RosettaNet XML Message Guidelines
3B5_MG_R01_00_00_ShipmentChangeRequest.htm (03-Jan-2001 17:04)
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 | ShippingInformation
|
15 |
1 | |-- Shipment
|
16 |
0..1 | | |-- deliveryDateTime.DateTimePeriod
|
17 |
1 | | | |-- beginDateTime.DateTimeStamp
|
18 |
1 | | | |-- endDateTime.DateTimeStamp
|
19 |
0..n | | |-- GlobalCarrierCode
|
20 |
0..1 | | |-- GlobalIncotermsCode
|
21 |
1 | | |-- GlobalShipmentChangeDispositionCode
|
22 |
0..1 | | |-- GlobalShipmentModeCode
|
23 |
1 | | |-- GlobalShippingServiceLevelCode
|
24 |
1 | | |-- numberOfShippingContainers.CountableAmount
|
25 |
1 | | |-- ReceivingPartner
|
26 |
0..n | | | |-- ReferenceIdentification
|
27 |
0..1 | | | | |-- effectiveDatePeriod.DatePeriod
|
28 |
1 | | | | | |-- beginDate.DateStamp
|
29 |
0..1 | | | | | |-- endDate.DateStamp
|
30 |
1 | | | | |-- ProprietaryReferenceIdentifier
|
31 |
1 | | | | |-- ReferenceIdentificationQualifier
|
32 |
1 | | | |-- shipto.PartnerDescription
|
33 |
1 | | | | |-- BusinessDescription
|
34 |
1 | | | | | |-- GlobalBusinessIdentifier
|
35 |
0..1 | | | | | |-- NationalBusinessTaxIdentifier
|
36 |
1 | | | | | | |-- BusinessTaxIdentifier
|
37 |
1 | | | | | | |-- GlobalCountryCode
|
38 |
0..1 | | | | | |-- RegionalBusinessTaxIdentifier
|
39 |
1 | | | | | | |-- BusinessTaxIdentifier
|
40 |
1 | | | | | | |-- regionName.FreeFormText
|
41 |
1 | | | | |-- ContactInformation
|
42 |
1 | | | | | |-- contactName.FreeFormText
|
43 |
0..1 | | | | | |-- EmailAddress
|
44 |
0..1 | | | | | |-- facsimileNumber.CommunicationsNumber
|
45 |
0..1 | | | | | |-- PhysicalAddress
|
46 |
0..1 | | | | | | |-- addressLine1.FreeFormText
|
47 |
0..1 | | | | | | |-- addressLine2.FreeFormText
|
48 |
0..1 | | | | | | |-- addressLine3.FreeFormText
|
49 |
0..1 | | | | | | |-- cityName.FreeFormText
|
50 |
0..1 | | | | | | |-- GlobalCountryCode
|
51 |
0..1 | | | | | | |-- GlobalLocationIdentifier
|
52 |
0..1 | | | | | | |-- NationalPostalCode
|
53 |
0..1 | | | | | | |-- postOfficeBoxIdentifier.FreeFormText
|
54 |
0..1 | | | | | | |-- regionName.FreeFormText
|
55 |
0..1 | | | | | |-- telephoneNumber.CommunicationsNumber
|
56 |
0..1 | | |-- shipmentChangeReason.FreeFormText
|
57 |
1 | | |-- shipmentIdentifier.ProprietaryReferenceIdentifier
|
58 |
0..1 | | |-- ShipmentTransportationEvent
|
59 |
0..2 | | | |-- confirmedEvent.TransportationEvent
|
60 |
1 | | | | |-- DateStamp
|
61 |
1 | | | | |-- GlobalTransportEventCode
|
62 |
0..2 | | | |-- revisedScheduledEvent.TransportationEvent
|
63 |
1 | | | | |-- DateStamp
|
64 |
1 | | | | |-- GlobalTransportEventCode
|
65 |
0..2 | | | |-- scheduledEvent.TransportationEvent
|
66 |
1 | | | | |-- DateStamp
|
67 |
1 | | | | |-- GlobalTransportEventCode
|
68 |
1..n | | |-- ShippingContainer
|
69 |
0..1 | | | |-- shippingContainerIdentifier.ProprietarySerialIdentifier
|
70 |
0..n | | | |-- ShippingContainerItem
|
71 |
1..n | | | | |-- DocumentSubLineReference
|
72 |
1 | | | | | |-- GlobalDocumentReferenceTypeCode
|
73 |
0..1 | | | | | |-- LineNumber
|
74 |
1 | | | | | |-- ProprietaryDocumentIdentifier
|
75 |
0..1 | | | | | |-- subLineNumber.LineNumber
|
76 |
0..1 | | | | |-- numberOfItemPackages.CountableAmount
|
77 |
0..1 | | | | |-- shippingContainerIdentifier.ProprietarySerialIdentifier
|
78 |
0..n | | | | |-- traceIdentifier.ProprietaryLotIdentifier
|
79 |
0..n | | |-- TrackingReference
|
80 |
1 | | | |-- GlobalTrackingReferenceTypeCode
|
81 |
1 | | | |-- ProprietaryShipmentTrackingIdentifier
|
82 |
0..1 | | |-- transportedBy.PartnerDescription
|
83 |
1 | | | |-- BusinessDescription
|
84 |
0..1 | | | | |-- businessName.FreeFormText
|
85 |
1 | | | | |-- GlobalBusinessIdentifier
|
86 |
0..1 | | | |-- ContactInformation
|
87 |
1 | | | | |-- contactName.FreeFormText
|
88 |
0..1 | | | | |-- EmailAddress
|
89 |
0..1 | | | | |-- facsimileNumber.CommunicationsNumber
|
90 |
0..1 | | | | |-- PhysicalAddress
|
91 |
0..1 | | | | | |-- addressLine1.FreeFormText
|
92 |
0..1 | | | | | |-- addressLine2.FreeFormText
|
93 |
0..1 | | | | | |-- addressLine3.FreeFormText
|
94 |
0..1 | | | | | |-- cityName.FreeFormText
|
95 |
0..1 | | | | | |-- GlobalCountryCode
|
96 |
0..1 | | | | | |-- GlobalLocationIdentifier
|
97 |
0..1 | | | | | |-- NationalPostalCode
|
98 |
0..1 | | | | | |-- postOfficeBoxIdentifier.FreeFormText
|
99 |
0..1 | | | | | |-- regionName.FreeFormText
|
100 |
0..1 | | | | |-- telephoneNumber.CommunicationsNumber
|
101 |
1 | thisDocumentGenerationDateTime.DateTimeStamp
|
102 |
1 | thisDocumentIdentifier.ProprietaryDocumentIdentifier
|
103 |
1 | toRole.PartnerRoleDescription
|
104 |
0..1 | |-- ContactInformation
|
105 |
1 | | |-- contactName.FreeFormText
|
106 |
1 | | |-- EmailAddress
|
107 |
0..1 | | |-- facsimileNumber.CommunicationsNumber
|
108 |
1 | | |-- telephoneNumber.CommunicationsNumber
|
109 |
1 | |-- GlobalPartnerRoleClassificationCode
|
110 |
1 | |-- PartnerDescription
|
111 |
1 | | |-- BusinessDescription
|
112 |
1 | | | |-- GlobalBusinessIdentifier
|
113 |
1 | | | |-- GlobalSupplyChainCode
|
114 |
1 | | |-- GlobalPartnerClassificationCode
|
7: GlobalPartnerRoleClassificationCode |
---|
Entity Instances |
11: GlobalSupplyChainCode |
---|
Entity Instances |
12: GlobalPartnerClassificationCode |
---|
Entity Instances |
13: GlobalDocumentFunctionCode |
---|
Entity Instances |
16: deliveryDateTime.DateTimePeriod |
---|
Constraint: If GlobalShippingServiceLevelCode is equal to "Time Critical" then deliveryDate.DateTimePeriod is mandatory. |
User Notes: When delivery is scheduled for a specific date instead of a date period, enter the specified date in both the beginDateTime and endDateTime fields. |
19: GlobalCarrierCode |
---|
Entity Instances |
20: GlobalIncotermsCode |
---|
Entity Instances |
21: GlobalShipmentChangeDispositionCode |
---|
User Notes: If this field carries the value "Return Shipment" then the shipTO.ShippingInformationAddressResource block should be interpreted as the return address if provided in the change request. Otherwise the return request address is provided for as by agreement. If reassignment of carrier is used, the same rule applies to the carrier information located in the PartnerDescription block. |
Entity Instances |
22: GlobalShipmentModeCode |
---|
Entity Instances |
23: GlobalShippingServiceLevelCode |
---|
Entity Instances |
31: ReferenceIdentificationQualifier |
---|
User Notes: Proprietary value allowed, however RosettaNet recommends the use of ANSI X12 Qualifier list Element 98 (Entity Identifier Code) for this purpose. |
37: GlobalCountryCode |
---|
Entity Instances |
40: regionName.FreeFormText |
---|
User Notes: RosettaNet suggests the use of ISO defined codes for describing regionName. |
50: GlobalCountryCode |
---|
Entity Instances |
54: regionName.FreeFormText |
---|
User Notes: RosettaNet suggests the use of ISO defined codes for describing regionName. |
61: GlobalTransportEventCode |
---|
Entity Instances |
64: GlobalTransportEventCode |
---|
Entity Instances |
67: GlobalTransportEventCode |
---|
Entity Instances |
69: shippingContainerIdentifier.ProprietarySerialIdentifier |
---|
User Notes: The UCC structured identifier (barcode) of the outermost shipping package. |
72: GlobalDocumentReferenceTypeCode |
---|
Entity Instances |
80: GlobalTrackingReferenceTypeCode |
---|
Entity Instances |
82: transportedBy.PartnerDescription |
---|
Constraint: Mandatory when GlobalShipmentChangeDispositionCode is equal to "reassignment of carrier". |
User Notes: The re-assigned carrier. |
95: GlobalCountryCode |
---|
Entity Instances |
99: regionName.FreeFormText |
---|
User Notes: RosettaNet suggests the use of ISO defined codes for describing regionName. |
109: GlobalPartnerRoleClassificationCode |
---|
Entity Instances |
113: GlobalSupplyChainCode |
---|
Entity Instances |
114: 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. |
deliveryDateTime | The delivery date and time for the product. |
beginDateTime | The start date and time of a date and time period. |
endDateTime | The end date and time of a date and time period. |
numberOfShippingContainers | A numeric expression of the number of outer containers for product shipping. |
effectiveDatePeriod | The date range indicating when information or an activity are valid. |
beginDate | The start date of a date period. |
endDate | The end date of a date period. |
shipTo | The partner and/or location to which the product must be delivered. |
regionName | The name of a state or province within a country. |
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. |
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. |
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. |
businessName | The name of a business entity. |
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. |
ShippingInformation | The collection of business properties that describe information regarding shipments tendered for transportation. |
Shipment | The collection of business properties that describe a consignment tendered for transportation from one point to another. |
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. |
ReceivingPartner | The collection of business properties used to identify the business partner accepting delivery of a shipment or transaction. |
ReferenceIdentification | The collection of business properties that describe information about proprietary documents or entities. |
DatePeriod | The collection of business properties that specify the number of days by a start and end date stamp. |
NationalBusinessTaxIdentifier | The national tax identification number assigned to a business. |
RegionalBusinessTaxIdentifier | Identifying number assigned to a business entity by a regional taxing jurisdiction. |
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. |
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. |
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 |   |   |
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 |
GlobalCarrierCode | A unique carrier identification code, based on Standard Carrier Alpha Code(s) | String | 1 |   |   |
GlobalIncotermsCode | Code identifying incoterms. | 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 |   |   |
GlobalShippingServiceLevelCode | Code identifying the shipping service level, e.g., overnight, same day. | String | 1 |   |   |
CountableAmount | Dimensionless magnitude, e.g. number of products. | PositiveInteger | 1 | 15 | 9(15) |
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 |
ProprietaryReferenceIdentifier | A unique reference identifier for goods, services or business documents. | String | 1 | 255 |   |
ReferenceIdentificationQualifier | A unique identifier clarifying the purpose or use of a proprietary reference number.. | String | 1 |   |   |
BusinessTaxIdentifier | Identifying number for Tax Information Field. | String | 1 | 30 | X(30) |
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) |
GlobalTransportEventCode | Code identifying an event during the transportation of 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 |   |   |