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



Guideline Information

7: GlobalPartnerRoleClassificationCode

Entity Instances
ShipmentController: The party who is authorized to make decisions regarding a shipment while in-transit.


11: GlobalSupplyChainCode

Entity Instances
Information Technology: The information technology supply chain.
Electronic Components: The electronic components supply chain.


12: GlobalPartnerClassificationCode

Entity Instances
Carrier: Product carrier for transporting goods in supply chain.
Distributor: Product distributor in supply chain.
End User: Product end user in supply chain.
End User Government: End user government.
Financier: Financial service provider in supply chain
Manufacturer: Product manufacturer in supply chain.
Retailer: Product retailer in supply chain.
Shopper: Product shopper in supply chain.
Freight Forwarder: Product freight forwarder for transporting goods in supply chain.
Broker: Representative of a third party.
Customs Broker: Product customs broker in supply chain.
Warehouser: Product warehouser in supply chain.
Distribution Center: Product distributor in supply chain.
Contract Manufacturer: The party responsible for the services rendered.
Reseller: A party buys goods from a manufacturer and resells them to customers unchanged.
Original Equipment Manufacturer: Product manufacturer of original equipment in the supply chain.


13: GlobalDocumentFunctionCode

Entity Instances
Request: The business document is a request for a business action to be performed by a partner.


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
SCAC codes to be used.


20: GlobalIncotermsCode

Entity Instances
FCA: Free Carrier (named place)
FAS: Free Along Ship (named port of shipment)
EXW: Ex Works (named place)
FOB: Free on Board (named port of shipment)
CFR: Cost and Freight (named port of destination)
CIF: Cost, Insurance and Freight (named port of destination)
CPT: Carriage Paid To (named place of destination)
CIP: Carriage and Insurance Paid To (named place of destination)
DAF: Delivered at Frontier (named place)
DES: Delivered Ex Ship (named port of destination)
DEQ: Delivered Ex Quay (Duty Paid) (named port of destination)
DDU: Delivered Duty Unpaid (named place of destination)
DDP: Delivered Duty Paid (named place of destination)


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
Stop shipment until further notice
Release shipment
Destroy shipment
Abandon shipment
Return Shipment
Reassignment of carrier
Cancel shipment


22: GlobalShipmentModeCode

Entity Instances
Air
Expedited Truck
Customer Pickup
Motor
Containerized Ocean
Rail
Ocean
Intermodal
Air Express
Air Freight
Contract Carrier
Private Carrier


23: GlobalShippingServiceLevelCode

Entity Instances
9 A.M.
A.M.
Air Cargo
Air Economy
Authorized Return Service
Bulk Commodity Train
Business Class
Consignee Billing Service
Courier Express
Deferred Service
Delivery Confirmation
Delivery Confirmation Return
Delivery Notification Only
Delivery Scheduled Next Day by Cartage Agent
Delivery scheduled second day by cartage agent
Delivery scheduled third day by cartage agent
Door Service
Expedited Service
Expedited Service - Worldwide
Express Service
Express Service - Worldwide
Express Service Plus
First Class
Ground
Manifest Freight
Metro
Multiweight
Next Day Air
Next Day Hundred Weight
Next Flight Out
Next Morning
Not Served
Other Intermodal and Stack Service
Overnight
P.O. Box/Zip Code
Passenger Service
PM
Premium Surface
Primary Service Area - Next Day by 10:30 A.M.
Primary Service Area - Next Day by 5:00 P.M.
Primary Service Area - Next Day By 9:30 AM
Primary Service Area - Next Day by Noon
Primary Service Area - Second Day by Noon
Priority Mail
Priority Mail Insured
Proof of Delivery (POD) with Signature
Regular
Same Day
Saturday
Saturday Pickup
Second Day
Second Day Air
Second Day Hundred Weight
Second Morning
Standard Class
Standard Ground
Standard Ground Hundred Weight
Standard Service
Three Day Service
Tracking - Ground
Air Charter
Sunday and Holidays
Time Critical
Pickup
Scheduled


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
AF: AFGHANISTAN
AL: ALBANIA
DZ: ALGERIA
AS: AMERICAN SAMOA
AD: ANDORRA
AO: ANGOLA
AI: ANGUILLA
AQ: ANTARCTICA
AG: ANTIGUA AND BARBUDA
AR: ARGENTINA
AM: ARMENIA
AW: ARUBA
AU: AUSTRALIA
AT: AUSTRIA
AZ: AZERBAIJAN
BS: BAHAMAS
BH: BAHRAIN
BD: BANGLADESH
BB: BARBADOS
BY: BELARUS
BE: BELGIUM
BZ: BELIZE
BJ: BENIN
BM: BERMUDA
BT: BHUTAN
BO: BOLIVIA
BA: BOSNIA AND HERZEGOVINA
BW: BOTSWANA
BV: BOUVET ISLAND
BR: BRAZIL
IO: BRITISH INDIAN OCEAN TERRITORY
BN: BRUNEI DARUSSALAM
BG: BULGARIA
BF: BURKINA FASO
BI: BURUNDI
KH: CAMBODIA
CM: CAMEROON
CA: CANADA
CV: CAPE VERDE
KY: CAYMAN ISLANDS
CF: CENTRAL AFRICAN REPUBLIC
TD: CHAD
CL: CHILE
CN: CHINA
CX: CHRISTMAS ISLAND
CC: COCOS (KEELING) ISLANDS
CO: COLOMBIA
KM: COMOROS
CG: CONGO
CK: COOK ISLANDS
CR: COSTA RICA
CI: CÔTE D'IVOIRE
HR: CROATIA
CU: CUBA
CY: CYPRUS
CZ: CZECH REPUBLIC
DK: DENMARK
DJ: DJIBOUTI
DM: DOMINICA
DO: DOMINICAN REPUBLIC
TP: EAST TIMOR
EC: ECUADOR
EG: EGYPT
SV: EL SALVADOR
GQ: EQUATORIAL GUINEA
ER: ERITREA
EE: ESTONIA
ET: ETHIOPIA
FK: FALKLAND ISLANDS (MALVINAS)
FO: FAROE ISLANDS
FJ: FIJI
FI: FINLAND
FR: FRANCE
GF: FRENCH GUIANA
PF: FRENCH POLYNESIA
TF: FRENCH SOUTHERN TERRITORIES
GA: GABON
GM: GAMBIA
GE: GEORGIA
DE: GERMANY
GH: GHANA
GI: GIBRALTAR
GR: GREECE
GL: GREENLAND
GD: GRENADA
GP: GUADELOUPE
GU: GUAM
GT: GUATEMALA
GN: GUINEA
GW: GUINEA-BISSAU
GY: GUYANA
HT: HAITI
HM: HEARD ISLAND AND MCDONALD ISLANDS
VA: HOLY SEE (VATICAN CITY STATE)
HN: HONDURAS
HK: HONG KONG
HU: HUNGARY
IS: ICELAND
IN: INDIA
ID: INDONESIA
IR: IRAN, ISLAMIC REPUBLIC OF
IQ: IRAQ
IE: IRELAND
SA: SAUDI ARABIA
SN: SENEGAL
SC: SEYCHELLES
SL: SIERRA LEONE
SG: SINGAPORE
SK: SLOVAKIA
SI: SLOVENIA
SB: SOLOMON ISLANDS
SO: SOMALIA
ZA: SOUTH AFRICA
GS: SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
ES: SPAIN
LK: SRI LANKA
SD: SUDAN
SR: SURINAME
SJ: SVALBARD AND JAN MAYEN ISLANDS
SZ: SWAZILAND
SE: SWEDEN
CH: SWITZERLAND
SY: SYRIAN ARAB REPUBLIC
TW: TAIWAN, PROVINCE OF CHINA
TJ: TAJIKISTAN
TZ: TANZANIA, UNITED REPUBLIC OF
TH: THAILAND
TG: TOGO
TK: TOKELAU
TO: TONGA
TT: TRINIDAD AND TOBAGO
TN: TUNISIA
TR: TURKEY
TM: TURKMENISTAN
TC: TURKS AND CAICOS ISLANDS
TV: TUVALU
UG: UGANDA
UA: UKRAINE
AE: UNITED ARAB EMIRATES
GB: UNITED KINGDOM
US: UNITED STATES
UM: UNITED STATES MINOR OUTLYING ISLANDS
UY: URUGUAY
UZ: UZBEKISTAN
VU: VANUATU
VE: VENEZUELA
VN: VIET NAM
VG: VIRGIN ISLANDS (BRITISH)
VI: VIRGIN ISLANDS (U.S.)
WF: WALLIS AND FUTUNA ISLANDS
EH: WESTERN SAHARA
YE: YEMEN
YU: YUGOSLAVIA
ZR: ZAIRE
ZM: ZAMBIA
ZW: ZIMBABWE
IL: ISRAEL
IT: ITALY
JM: JAMAICA
JP: JAPAN
JO: JORDAN
KZ: KAZAKSTAN
KE: KENYA
KI: KIRIBATI
KP: KOREA, DEMOCRATIC PEOPLE'S REP. OF
KR: KOREA, REPUBLIC OF
KW: KUWAIT
KG: KYRGYSTAN
LA: LAO PEOPLE'S DEMOCRATIC REPUBLIC
LV: LATVIA
LB: LEBANON
LS: LESOTHO
LR: LIBERIA
LY: LIBYAN ARAB JAMAHIRIYA
LI: LIECHTENSTEIN
LT: LITHUANIA
LU: LUXEMBOURG
MO: MACAU
MK: MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
MG: MADAGASCAR
MW: MALAWI
MY: MALAYSIA
MV: MALDIVES
ML: MALI
MT: MALTA
MH: MARSHALL ISLANDS
MQ: MARTINIQUE
MR: MAURITANIA
MU: MAURITIUS
YT: MAYOTTE
MX: MEXICO
FM: MICRONESIA, FEDERATED STATES
MD: MOLDOVA, REPUBLIC OF
MC: MONACO
MN: MONGOLIA
MS: MONTSERRAT
MA: MOROCCO
MZ: MOZAMBIQUE
MM: MYANMAR
NA: NAMIBIA
NR: NAURU
NP: NEPAL
NL: NETHERLANDS
AN: NETHERLANDS ANTILLES
NT: NEUTRAL ZONE
NC: NEW CALEDONIA
NZ: NEW ZEALAND
NI: NICARAGUA
NE: NIGER
NG: NIGERIA
NU: NIUE
NF: NORFOLK ISLAND
MP: NORTHERN MARIANA ISLANDS
NO: NORWAY
OM: OMAN
PK: PAKISTAN
PW: PALAU
PA: PANAMA
PG: PAPUA NEW GUINEA
PY: PARAGUAY
PE: PERU
PH: PHILIPPINES
PN: PITCAIRN
PL: POLAND
PT: PORTUGAL
PR: PUERTO RICO
QA: QATAR
RE: REUNION
RO: ROMANIA
RU: RUSSIAN FEDERATION
RW: RWANDA
SH: SAINT HELENA
KN: SAINT KITTS AND NEVIS
LC: SAINT LUCIA
PM: SAINT PIERRE AND MIQUELON
VC: SAINT VINCENT AND THE GRENADINES
WS: SAMOA
SM: SAN MARINO
ST: SAO TOME AND PRINCIPE


40: regionName.FreeFormText

User Notes: RosettaNet suggests the use of ISO defined codes for describing regionName.


50: GlobalCountryCode

Entity Instances
AF: AFGHANISTAN
AL: ALBANIA
DZ: ALGERIA
AS: AMERICAN SAMOA
AD: ANDORRA
AO: ANGOLA
AI: ANGUILLA
AQ: ANTARCTICA
AG: ANTIGUA AND BARBUDA
AR: ARGENTINA
AM: ARMENIA
AW: ARUBA
AU: AUSTRALIA
AT: AUSTRIA
AZ: AZERBAIJAN
BS: BAHAMAS
BH: BAHRAIN
BD: BANGLADESH
BB: BARBADOS
BY: BELARUS
BE: BELGIUM
BZ: BELIZE
BJ: BENIN
BM: BERMUDA
BT: BHUTAN
BO: BOLIVIA
BA: BOSNIA AND HERZEGOVINA
BW: BOTSWANA
BV: BOUVET ISLAND
BR: BRAZIL
IO: BRITISH INDIAN OCEAN TERRITORY
BN: BRUNEI DARUSSALAM
BG: BULGARIA
BF: BURKINA FASO
BI: BURUNDI
KH: CAMBODIA
CM: CAMEROON
CA: CANADA
CV: CAPE VERDE
KY: CAYMAN ISLANDS
CF: CENTRAL AFRICAN REPUBLIC
TD: CHAD
CL: CHILE
CN: CHINA
CX: CHRISTMAS ISLAND
CC: COCOS (KEELING) ISLANDS
CO: COLOMBIA
KM: COMOROS
CG: CONGO
CK: COOK ISLANDS
CR: COSTA RICA
CI: CÔTE D'IVOIRE
HR: CROATIA
CU: CUBA
CY: CYPRUS
CZ: CZECH REPUBLIC
DK: DENMARK
DJ: DJIBOUTI
DM: DOMINICA
DO: DOMINICAN REPUBLIC
TP: EAST TIMOR
EC: ECUADOR
EG: EGYPT
SV: EL SALVADOR
GQ: EQUATORIAL GUINEA
ER: ERITREA
EE: ESTONIA
ET: ETHIOPIA
FK: FALKLAND ISLANDS (MALVINAS)
FO: FAROE ISLANDS
FJ: FIJI
FI: FINLAND
FR: FRANCE
GF: FRENCH GUIANA
PF: FRENCH POLYNESIA
TF: FRENCH SOUTHERN TERRITORIES
GA: GABON
GM: GAMBIA
GE: GEORGIA
DE: GERMANY
GH: GHANA
GI: GIBRALTAR
GR: GREECE
GL: GREENLAND
GD: GRENADA
GP: GUADELOUPE
GU: GUAM
GT: GUATEMALA
GN: GUINEA
GW: GUINEA-BISSAU
GY: GUYANA
HT: HAITI
HM: HEARD ISLAND AND MCDONALD ISLANDS
VA: HOLY SEE (VATICAN CITY STATE)
HN: HONDURAS
HK: HONG KONG
HU: HUNGARY
IS: ICELAND
IN: INDIA
ID: INDONESIA
IR: IRAN, ISLAMIC REPUBLIC OF
IQ: IRAQ
IE: IRELAND
SA: SAUDI ARABIA
SN: SENEGAL
SC: SEYCHELLES
SL: SIERRA LEONE
SG: SINGAPORE
SK: SLOVAKIA
SI: SLOVENIA
SB: SOLOMON ISLANDS
SO: SOMALIA
ZA: SOUTH AFRICA
GS: SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
ES: SPAIN
LK: SRI LANKA
SD: SUDAN
SR: SURINAME
SJ: SVALBARD AND JAN MAYEN ISLANDS
SZ: SWAZILAND
SE: SWEDEN
CH: SWITZERLAND
SY: SYRIAN ARAB REPUBLIC
TW: TAIWAN, PROVINCE OF CHINA
TJ: TAJIKISTAN
TZ: TANZANIA, UNITED REPUBLIC OF
TH: THAILAND
TG: TOGO
TK: TOKELAU
TO: TONGA
TT: TRINIDAD AND TOBAGO
TN: TUNISIA
TR: TURKEY
TM: TURKMENISTAN
TC: TURKS AND CAICOS ISLANDS
TV: TUVALU
UG: UGANDA
UA: UKRAINE
AE: UNITED ARAB EMIRATES
GB: UNITED KINGDOM
US: UNITED STATES
UM: UNITED STATES MINOR OUTLYING ISLANDS
UY: URUGUAY
UZ: UZBEKISTAN
VU: VANUATU
VE: VENEZUELA
VN: VIET NAM
VG: VIRGIN ISLANDS (BRITISH)
VI: VIRGIN ISLANDS (U.S.)
WF: WALLIS AND FUTUNA ISLANDS
EH: WESTERN SAHARA
YE: YEMEN
YU: YUGOSLAVIA
ZR: ZAIRE
ZM: ZAMBIA
ZW: ZIMBABWE
IL: ISRAEL
IT: ITALY
JM: JAMAICA
JP: JAPAN
JO: JORDAN
KZ: KAZAKSTAN
KE: KENYA
KI: KIRIBATI
KP: KOREA, DEMOCRATIC PEOPLE'S REP. OF
KR: KOREA, REPUBLIC OF
KW: KUWAIT
KG: KYRGYSTAN
LA: LAO PEOPLE'S DEMOCRATIC REPUBLIC
LV: LATVIA
LB: LEBANON
LS: LESOTHO
LR: LIBERIA
LY: LIBYAN ARAB JAMAHIRIYA
LI: LIECHTENSTEIN
LT: LITHUANIA
LU: LUXEMBOURG
MO: MACAU
MK: MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
MG: MADAGASCAR
MW: MALAWI
MY: MALAYSIA
MV: MALDIVES
ML: MALI
MT: MALTA
MH: MARSHALL ISLANDS
MQ: MARTINIQUE
MR: MAURITANIA
MU: MAURITIUS
YT: MAYOTTE
MX: MEXICO
FM: MICRONESIA, FEDERATED STATES
MD: MOLDOVA, REPUBLIC OF
MC: MONACO
MN: MONGOLIA
MS: MONTSERRAT
MA: MOROCCO
MZ: MOZAMBIQUE
MM: MYANMAR
NA: NAMIBIA
NR: NAURU
NP: NEPAL
NL: NETHERLANDS
AN: NETHERLANDS ANTILLES
NT: NEUTRAL ZONE
NC: NEW CALEDONIA
NZ: NEW ZEALAND
NI: NICARAGUA
NE: NIGER
NG: NIGERIA
NU: NIUE
NF: NORFOLK ISLAND
MP: NORTHERN MARIANA ISLANDS
NO: NORWAY
OM: OMAN
PK: PAKISTAN
PW: PALAU
PA: PANAMA
PG: PAPUA NEW GUINEA
PY: PARAGUAY
PE: PERU
PH: PHILIPPINES
PN: PITCAIRN
PL: POLAND
PT: PORTUGAL
PR: PUERTO RICO
QA: QATAR
RE: REUNION
RO: ROMANIA
RU: RUSSIAN FEDERATION
RW: RWANDA
SH: SAINT HELENA
KN: SAINT KITTS AND NEVIS
LC: SAINT LUCIA
PM: SAINT PIERRE AND MIQUELON
VC: SAINT VINCENT AND THE GRENADINES
WS: SAMOA
SM: SAN MARINO
ST: SAO TOME AND PRINCIPE


54: regionName.FreeFormText

User Notes: RosettaNet suggests the use of ISO defined codes for describing regionName.


61: GlobalTransportEventCode

Entity Instances
Ship: The event representing when the product is requested to ship.
Dock: The event representing when the product should arrive on the recipient's dock.


64: GlobalTransportEventCode

Entity Instances
Ship: The event representing when the product is requested to ship.
Dock: The event representing when the product should arrive on the recipient's dock.


67: GlobalTransportEventCode

Entity Instances
Ship: The event representing when the product is requested to ship.
Dock: The event representing when the product should arrive on the recipient's dock.


69: shippingContainerIdentifier.ProprietarySerialIdentifier

User Notes: The UCC structured identifier (barcode) of the outermost shipping package.


72: GlobalDocumentReferenceTypeCode

Entity Instances
Purchase Order
Sales Order
Work Order
Delivery Note
Quote
Contract
Invoice


80: GlobalTrackingReferenceTypeCode

Entity Instances
Master Airwaybill Number
House Airwaybill Number
Shipper Reference Number
Carrier Reference Number
Booking Number
Sales Order Number
Seal Identifier
Packing Slip Number
Bill of Lading Number
Trailer Number
Pro Number
Ocean Bill of Lading Number


82: transportedBy.PartnerDescription

Constraint: Mandatory when GlobalShipmentChangeDispositionCode is equal to "reassignment of carrier".

User Notes: The re-assigned carrier.


95: GlobalCountryCode

Entity Instances
AF: AFGHANISTAN
AL: ALBANIA
DZ: ALGERIA
AS: AMERICAN SAMOA
AD: ANDORRA
AO: ANGOLA
AI: ANGUILLA
AQ: ANTARCTICA
AG: ANTIGUA AND BARBUDA
AR: ARGENTINA
AM: ARMENIA
AW: ARUBA
AU: AUSTRALIA
AT: AUSTRIA
AZ: AZERBAIJAN
BS: BAHAMAS
BH: BAHRAIN
BD: BANGLADESH
BB: BARBADOS
BY: BELARUS
BE: BELGIUM
BZ: BELIZE
BJ: BENIN
BM: BERMUDA
BT: BHUTAN
BO: BOLIVIA
BA: BOSNIA AND HERZEGOVINA
BW: BOTSWANA
BV: BOUVET ISLAND
BR: BRAZIL
IO: BRITISH INDIAN OCEAN TERRITORY
BN: BRUNEI DARUSSALAM
BG: BULGARIA
BF: BURKINA FASO
BI: BURUNDI
KH: CAMBODIA
CM: CAMEROON
CA: CANADA
CV: CAPE VERDE
KY: CAYMAN ISLANDS
CF: CENTRAL AFRICAN REPUBLIC
TD: CHAD
CL: CHILE
CN: CHINA
CX: CHRISTMAS ISLAND
CC: COCOS (KEELING) ISLANDS
CO: COLOMBIA
KM: COMOROS
CG: CONGO
CK: COOK ISLANDS
CR: COSTA RICA
CI: CÔTE D'IVOIRE
HR: CROATIA
CU: CUBA
CY: CYPRUS
CZ: CZECH REPUBLIC
DK: DENMARK
DJ: DJIBOUTI
DM: DOMINICA
DO: DOMINICAN REPUBLIC
TP: EAST TIMOR
EC: ECUADOR
EG: EGYPT
SV: EL SALVADOR
GQ: EQUATORIAL GUINEA
ER: ERITREA
EE: ESTONIA
ET: ETHIOPIA
FK: FALKLAND ISLANDS (MALVINAS)
FO: FAROE ISLANDS
FJ: FIJI
FI: FINLAND
FR: FRANCE
GF: FRENCH GUIANA
PF: FRENCH POLYNESIA
TF: FRENCH SOUTHERN TERRITORIES
GA: GABON
GM: GAMBIA
GE: GEORGIA
DE: GERMANY
GH: GHANA
GI: GIBRALTAR
GR: GREECE
GL: GREENLAND
GD: GRENADA
GP: GUADELOUPE
GU: GUAM
GT: GUATEMALA
GN: GUINEA
GW: GUINEA-BISSAU
GY: GUYANA
HT: HAITI
HM: HEARD ISLAND AND MCDONALD ISLANDS
VA: HOLY SEE (VATICAN CITY STATE)
HN: HONDURAS
HK: HONG KONG
HU: HUNGARY
IS: ICELAND
IN: INDIA
ID: INDONESIA
IR: IRAN, ISLAMIC REPUBLIC OF
IQ: IRAQ
IE: IRELAND
SA: SAUDI ARABIA
SN: SENEGAL
SC: SEYCHELLES
SL: SIERRA LEONE
SG: SINGAPORE
SK: SLOVAKIA
SI: SLOVENIA
SB: SOLOMON ISLANDS
SO: SOMALIA
ZA: SOUTH AFRICA
GS: SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
ES: SPAIN
LK: SRI LANKA
SD: SUDAN
SR: SURINAME
SJ: SVALBARD AND JAN MAYEN ISLANDS
SZ: SWAZILAND
SE: SWEDEN
CH: SWITZERLAND
SY: SYRIAN ARAB REPUBLIC
TW: TAIWAN, PROVINCE OF CHINA
TJ: TAJIKISTAN
TZ: TANZANIA, UNITED REPUBLIC OF
TH: THAILAND
TG: TOGO
TK: TOKELAU
TO: TONGA
TT: TRINIDAD AND TOBAGO
TN: TUNISIA
TR: TURKEY
TM: TURKMENISTAN
TC: TURKS AND CAICOS ISLANDS
TV: TUVALU
UG: UGANDA
UA: UKRAINE
AE: UNITED ARAB EMIRATES
GB: UNITED KINGDOM
US: UNITED STATES
UM: UNITED STATES MINOR OUTLYING ISLANDS
UY: URUGUAY
UZ: UZBEKISTAN
VU: VANUATU
VE: VENEZUELA
VN: VIET NAM
VG: VIRGIN ISLANDS (BRITISH)
VI: VIRGIN ISLANDS (U.S.)
WF: WALLIS AND FUTUNA ISLANDS
EH: WESTERN SAHARA
YE: YEMEN
YU: YUGOSLAVIA
ZR: ZAIRE
ZM: ZAMBIA
ZW: ZIMBABWE
IL: ISRAEL
IT: ITALY
JM: JAMAICA
JP: JAPAN
JO: JORDAN
KZ: KAZAKSTAN
KE: KENYA
KI: KIRIBATI
KP: KOREA, DEMOCRATIC PEOPLE'S REP. OF
KR: KOREA, REPUBLIC OF
KW: KUWAIT
KG: KYRGYSTAN
LA: LAO PEOPLE'S DEMOCRATIC REPUBLIC
LV: LATVIA
LB: LEBANON
LS: LESOTHO
LR: LIBERIA
LY: LIBYAN ARAB JAMAHIRIYA
LI: LIECHTENSTEIN
LT: LITHUANIA
LU: LUXEMBOURG
MO: MACAU
MK: MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
MG: MADAGASCAR
MW: MALAWI
MY: MALAYSIA
MV: MALDIVES
ML: MALI
MT: MALTA
MH: MARSHALL ISLANDS
MQ: MARTINIQUE
MR: MAURITANIA
MU: MAURITIUS
YT: MAYOTTE
MX: MEXICO
FM: MICRONESIA, FEDERATED STATES
MD: MOLDOVA, REPUBLIC OF
MC: MONACO
MN: MONGOLIA
MS: MONTSERRAT
MA: MOROCCO
MZ: MOZAMBIQUE
MM: MYANMAR
NA: NAMIBIA
NR: NAURU
NP: NEPAL
NL: NETHERLANDS
AN: NETHERLANDS ANTILLES
NT: NEUTRAL ZONE
NC: NEW CALEDONIA
NZ: NEW ZEALAND
NI: NICARAGUA
NE: NIGER
NG: NIGERIA
NU: NIUE
NF: NORFOLK ISLAND
MP: NORTHERN MARIANA ISLANDS
NO: NORWAY
OM: OMAN
PK: PAKISTAN
PW: PALAU
PA: PANAMA
PG: PAPUA NEW GUINEA
PY: PARAGUAY
PE: PERU
PH: PHILIPPINES
PN: PITCAIRN
PL: POLAND
PT: PORTUGAL
PR: PUERTO RICO
QA: QATAR
RE: REUNION
RO: ROMANIA
RU: RUSSIAN FEDERATION
RW: RWANDA
SH: SAINT HELENA
KN: SAINT KITTS AND NEVIS
LC: SAINT LUCIA
PM: SAINT PIERRE AND MIQUELON
VC: SAINT VINCENT AND THE GRENADINES
WS: SAMOA
SM: SAN MARINO
ST: SAO TOME AND PRINCIPE


99: regionName.FreeFormText

User Notes: RosettaNet suggests the use of ISO defined codes for describing regionName.


109: GlobalPartnerRoleClassificationCode

Entity Instances
Transport Service Provider: The party that provides transportation services for a Shipment Requester.


113: GlobalSupplyChainCode

Entity Instances
Information Technology: The information technology supply chain.
Electronic Components: The electronic components supply chain.


114: GlobalPartnerClassificationCode

Entity Instances
Carrier: Product carrier for transporting goods in supply chain.
Distributor: Product distributor in supply chain.
End User: Product end user in supply chain.
End User Government: End user government.
Financier: Financial service provider in supply chain
Manufacturer: Product manufacturer in supply chain.
Retailer: Product retailer in supply chain.
Shopper: Product shopper in supply chain.
Freight Forwarder: Product freight forwarder for transporting goods in supply chain.
Broker: Representative of a third party.
Customs Broker: Product customs broker in supply chain.
Warehouser: Product warehouser in supply chain.
Distribution Center: Product distributor in supply chain.
Contract Manufacturer: The party responsible for the services rendered.
Reseller: A party buys goods from a manufacturer and resells them to customers unchanged.
Original Equipment Manufacturer: Product manufacturer of original equipment in the supply chain.



Business Properties

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.


Business Data Entities

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.


Fundamental Business Data Entities

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