Hapag Lloyd
/
Terminal Operations and Intermodal Ramp Activity
  • Specification
  • EDI Inspector
Stedi maintains this guide based on public documentation from Hapag Lloyd. Contact Hapag Lloyd for official EDI specifications. To report any errors in this guide, please contact us.
Go to Stedi Network
Hapag Lloyd logo

X12 322 Terminal Operations and Intermodal Ramp Activity

X12 Release 4010

This Draft Standard for Trial Use contains the format and establishes the data contents of the Terminal Operations and Intermodal Ramp Activity Transaction Set (322) for use within the context of an Electronic Data Interchange (EDI) environment. The transaction set can be used to provide all the information necessary for a terminal operation, port authority or intermodal ramp to communicate terminal and intermodal ramp activities (e.g., "ingates" and "outgates") to authorized parties to a shipment.

Delimiters
  • ~ Segment
  • * Element
  • > Component
EDI samples
  • None included
View the latest version of this implementation guide as an interactive webpage
https://www.stedi.com/app/guides/view/hapag-lloyd/terminal-operations-and-intermodal-ramp-activity/01HDSFEXD0Y7THFS7QYFX700TK
Powered by
Build EDI implementation guides at stedi.com
Overview
ISA
-
Interchange Control Header
Max use 1
Required
GS
-
Functional Group Header
Max use 1
Required
heading
ST
010
Transaction Set Header
Max use 1
Required
Q5
016
Status Details
Max use 1
Required
N7 Loop
N7
020
Equipment Details
Max use 1
Required
V4
030
Cargo Location Reference
Max use 1
Optional
DTM
040
Date/Time Reference
Max use 2
Optional
M7
050
Seal Numbers
Max use 5
Optional
W09
060
Equipment and Temperature
Max use 1
Optional
W2
070
Equipment Identification
Max use 1
Required
NA
080
Cross-Reference Equipment
Max use 30
Optional
V1
110
Vessel Identification
Max use 1
Optional
N1 Loop
N9
170
Reference Identification
Max use 10
Required
SE
220
Transaction Set Trailer
Max use 1
Required
GE
-
Functional Group Trailer
Max use 1
Required
IEA
-
Interchange Control Trailer
Max use 1
Required
ISA

Interchange Control Header

RequiredMax use 1

To start and identify an interchange of zero or more functional groups and interchange-related control segments

Example
ISA-01
I01
Authorization Information Qualifier
Required
Identifier (ID)

Code to identify the type of information in the Authorization Information

00
No Authorization Information Present (No Meaningful Information in I02)
ISA-02
I02
Authorization Information
Required
String (AN)
Min 10Max 10

Information used for additional identification or authorization of the interchange sender or the data in the interchange; the type of information is set by the Authorization Information Qualifier (I01)

ISA-03
I03
Security Information Qualifier
Required
Identifier (ID)

Code to identify the type of information in the Security Information

00
No Security Information Present (No Meaningful Information in I04)
ISA-04
I04
Security Information
Required
String (AN)
Min 10Max 10

This is used for identifying the security information about the interchange sender or the data in the interchange; the type of information is set by the Security Information Qualifier (I03)

ISA-05
I05
Interchange ID Qualifier
Required
Identifier (ID)
Min 2Max 2

Qualifier to designate the system/method of code structure used to designate the sender or receiver ID element being qualified

Codes
ISA-06
I06
Interchange Sender ID
Required
String (AN)
Min 15Max 15

Identification code published by the sender for other parties to use as the receiver ID to route data to them; the sender always codes this value in the sender ID element

ISA-07
I05
Interchange ID Qualifier
Required
Identifier (ID)
Min 2Max 2

Qualifier to designate the system/method of code structure used to designate the sender or receiver ID element being qualified

Codes
ISA-08
I07
Interchange Receiver ID
Required
String (AN)
Min 15Max 15

Identification code published by the receiver of the data; When sending, it is used by the sender as their sending ID, thus other parties sending to them will use this as a receiving ID to route data to them

ISA-09
I08
Interchange Date
Required
Date (DT)
YYMMDD format

Date of the interchange

ISA-10
I09
Interchange Time
Required
Time (TM)
HHMM format

Time of the interchange

ISA-11
I10
Interchange Control Standards Identifier
Required
Identifier (ID)

Code to identify the agency responsible for the control standard used by the message that is enclosed by the interchange header and trailer

U
U.S. EDI Community of ASC X12, TDCC, and UCS
ISA-12
I11
Interchange Control Version Number
Required
Identifier (ID)

This version number covers the interchange control segments

00401
Draft Standards for Trial Use Approved for Publication by ASC X12 Procedures Review Board through October 1997
ISA-13
I12
Interchange Control Number
Required
Numeric (N0)
Min 9Max 9

A control number assigned by the interchange sender

ISA-14
I13
Acknowledgment Requested
Required
Identifier (ID)
Min 1Max 1

Code sent by the sender to request an interchange acknowledgment (TA1)

0
No Acknowledgment Requested
1
Interchange Acknowledgment Requested
ISA-15
I14
Usage Indicator
Required
Identifier (ID)
Min 1Max 1

Code to indicate whether data enclosed by this interchange envelope is test, production or information

I
Information
P
Production Data
T
Test Data
ISA-16
I15
Component Element Separator
Required
String (AN)
Min 1Max 1

Type is not applicable; the component element separator is a delimiter and not a data element; this field provides the delimiter used to separate component data elements within a composite data structure; this value must be different than the data element separator and the segment terminator

>
Component Element Separator

Functional Group Header

RequiredMax use 1

To indicate the beginning of a functional group and to provide control information

Example
GS-01
479
Functional Identifier Code
Required
Identifier (ID)

Code identifying a group of application related transaction sets

SO
Ocean Shipment Information (304, 306, 309, 311, 317, 319, 321, 322, 323, 324, 325, 350, 352, 353, 354, 355, 356, 357, 358, 361)
GS-02
142
Application Sender's Code
Required
String (AN)
Min 2Max 15

Code identifying party sending transmission; codes agreed to by trading partners

GS-03
124
Application Receiver's Code
Required
String (AN)
Min 2Max 15

Code identifying party receiving transmission. Codes agreed to by trading partners

Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

Required
Time (TM)
HHMM, HHMMSS, HHMMSSD, or HHMMSSDD format

Time expressed in 24-hour clock time as follows: HHMM, or HHMMSS, or HHMMSSD, or HHMMSSDD, where H = hours (00-23), M = minutes (00-59), S = integer seconds (00-59) and DD = decimal seconds; decimal seconds are expressed as follows: D = tenths (0-9) and DD = hundredths (00-99)

GS-06
28
Group Control Number
Required
Numeric (N0)
Min 1Max 9

Assigned number originated and maintained by the sender

GS-07
455
Responsible Agency Code
Required
Identifier (ID)
Min 1Max 2

Code used in conjunction with Data Element 480 to identify the issuer of the standard

T
Transportation Data Coordinating Committee (TDCC)
X
Accredited Standards Committee X12
GS-08
480
Version / Release / Industry Identifier Code
Required
String (AN)

Code indicating the version, release, subrelease, and industry identifier of the EDI standard being used, including the GS and GE segments; if code in DE455 in GS segment is X, then in DE 480 positions 1-3 are the version number; positions 4-6 are the release and subrelease, level of the version; and positions 7-12 are the industry or trade association identifiers (optionally assigned by user); if code in DE455 in GS segment is T, then other formats are allowed

004010
Draft Standards Approved for Publication by ASC X12 Procedures Review Board through October 1997

Heading

ST
010
Heading > ST

Transaction Set Header

RequiredMax use 1

To indicate the start of a transaction set and to assign a control number

Example
ST-01
143
Transaction Set Identifier Code
Required
Identifier (ID)

Code uniquely identifying a Transaction Set

  • The transaction set identifier (ST01) used by the translation routines of the interchange partners to select the appropriate transaction set definition (e.g., 810 selects the Invoice Transaction Set).
322
Terminal Operations and Intermodal Ramp Activity
ST-02
329
Transaction Set Control Number
Required
Numeric (N)
Min 4Max 9

Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set

Q5
016
Heading > Q5

Status Details

RequiredMax use 1

To specify the status of the shipment in terms of dates, time, reference numbers, and location

Example
Q5-01
157
Shipment Status Code
Optional
Identifier (ID)
Min 1Max 2

Code indicating the status of a shipment

Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

  • Q502 is the date of the status reported in Q501.
Optional
Time (TM)
HHMM, HHMMSS, HHMMSSD, or HHMMSSDD format

Time expressed in 24-hour clock time as follows: HHMM, or HHMMSS, or HHMMSSD, or HHMMSSDD, where H = hours (00-23), M = minutes (00-59), S = integer seconds (00-59) and DD = decimal seconds; decimal seconds are expressed as follows: D = tenths (0-9) and DD = hundredths (00-99)

  • Q503 is the time of the status reported in Q501.
N7 Loop
RequiredMax >1
N7
020
Heading > N7 Loop > N7

Equipment Details

RequiredMax use 1

To identify the equipment

Example
If either Weight (N7-03) or Weight Qualifier (N7-04) is present, then the other is required
N7-01
206
Equipment Initial
Optional
String (AN)
Min 1Max 4

Prefix or alphabetic part of an equipment unit's identifying number

  • N701 is mandatory for rail transactions.
N7-02
207
Equipment Number
Required
String (AN)
Min 1Max 10

Sequencing or serial part of an equipment unit's identifying number (pure numeric form for equipment number is preferred)

N7-03
81
Weight
Optional
Decimal number (R)
Min 1Max 10

Numeric value of weight

Usage notes

A6 = Verified Gross weight

N7-04
187
Weight Qualifier
Optional
Identifier (ID)
Min 1Max 2

Code defining the type of weight

N7-05
167
Tare Weight
Optional
Numeric (N0)
Min 3Max 8

Weight of the equipment

N7-11
40
Equipment Description Code
Optional
Identifier (ID)
Min 2Max 2

Code identifying type of equipment used for shipment

N7-12
140
Standard Carrier Alpha Code
Optional
Identifier (ID)
Min 2Max 4

Standard Carrier Alpha Code

  • N712 is the owner of the equipment.
N7-14
219
Position
Optional
String (AN)
Min 1Max 3

Relative position of shipment in car, trailer, or container (mutually defined)

N7-17
188
Weight Unit Code
Optional
Identifier (ID)
Min 1Max 1

Code specifying the weight unit

N7-18
761
Equipment Number Check Digit
Optional
Numeric (N0)
Min 1Max 1

Number which designates the check digit applied to a piece of equipment

N7-22
24
Equipment Type
Optional
Identifier (ID)
Min 4Max 4

Code identifying equipment type

V4
030
Heading > N7 Loop > V4

Cargo Location Reference

OptionalMax use 1

To specify the cargo location on board the vessel

Example
V4-01
877
Vessel Stowage Location
Required
String (AN)
Min 1Max 12

Location of cargo stowed on board an ocean vessel

DTM
040
Heading > N7 Loop > DTM

Date/Time Reference

OptionalMax use 2

To specify pertinent dates and times

Example
DTM-01
374
Date/Time Qualifier
Required
Identifier (ID)
Min 3Max 3

Code specifying type of date or time, or both date and time

Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

M7
050
Heading > N7 Loop > M7

Seal Numbers

OptionalMax use 5

To record seal numbers used and the organization that applied the seals

Example
M7-01
225
Seal Number
Required
String (AN)
Min 2Max 15

Unique number on seal used to close a shipment

M7-05
98
Entity Identifier Code
Optional
Identifier (ID)
Min 2Max 3

Code identifying an organizational entity, a physical location, property or an individual

  • M705 indicates the name of the organization which applied the seal(s).
W09
060
Heading > N7 Loop > W09

Equipment and Temperature

OptionalMax use 1

To relate equipment type and required temperatures

Example
If either Temperature (W09-02) or Unit or Basis for Measurement Code (W09-03) is present, then the other is required
W09-01
40
Equipment Description Code
Required
Identifier (ID)
Min 2Max 2

Code identifying type of equipment used for shipment

W09-02
408
Temperature
Optional
Decimal number (R)
Min 1Max 4

Temperature

  • W0902 is the minimum allowable temperature condition for shipment; (the qualifying temperature scale is specified in W0903).
W09-03
355
Unit or Basis for Measurement Code
Optional
Identifier (ID)
Min 2Max 2

Code specifying the units in which a value is being expressed, or manner in which a measurement has been taken

W09-07
1122
Vent Setting Code
Optional
Identifier (ID)
Min 1Max 1

Code describing the setting on the air vents on ocean-type containers

W2
070
Heading > N7 Loop > W2

Equipment Identification

RequiredMax use 1

To identify equipment and the commodity being carried

Example
If either Equipment Initial (W2-11) or Equipment Number (W2-12) is present, then the other is required
W2-01
206
Equipment Initial
Required
String (AN)
Min 1Max 4

Prefix or alphabetic part of an equipment unit's identifying number

W2-02
207
Equipment Number
Required
String (AN)
Min 1Max 10

Sequencing or serial part of an equipment unit's identifying number (pure numeric form for equipment number is preferred)

W2-04
40
Equipment Description Code
Required
Identifier (ID)
Min 2Max 2

Code identifying type of equipment used for shipment

W2-05
578
Equipment Status Code
Required
Identifier (ID)
Min 1Max 2

Code indicating status of equipment

W2-11
206
Equipment Initial
Optional
String (AN)
Min 1Max 4

Prefix or alphabetic part of an equipment unit's identifying number

  • W211 (when available) is the chassis initial if W204 equals "CC". If unknown, use NONZ for chassis initial.
W2-12
207
Equipment Number
Optional
String (AN)
Min 1Max 10

Sequencing or serial part of an equipment unit's identifying number (pure numeric form for equipment number is preferred)

  • W212 (when available) is the chassis number if W204 equals "CC".
NA
080
Heading > N7 Loop > NA

Cross-Reference Equipment

OptionalMax use 30

To cross-reference additional equipment to a primary piece of equipment

Example
NA-03
206
Equipment Initial
Required
String (AN)
Min 1Max 4

Prefix or alphabetic part of an equipment unit's identifying number

  • NA03 contains the equipment initial of an associated shipment and is required by rail. If unknown, use NONZ for van or NONU for container.
NA-04
207
Equipment Number
Required
String (AN)
Min 1Max 10

Sequencing or serial part of an equipment unit's identifying number (pure numeric form for equipment number is preferred)

  • NA04 contains the equipment number of an associated shipment.
V1
110
Heading > N7 Loop > V1

Vessel Identification

OptionalMax use 1

To provide vessel details and voyage number

Example
At least one of Vessel Code (V1-01) or Vessel Name (V1-02) is required
V1-01
597
Vessel Code
Optional
Identifier (ID)
Min 1Max 8

Code identifying vessel

V1-02
182
Vessel Name
Optional
String (AN)
Min 2Max 28

Name of ship as documented in "Lloyd's Register of Ships"

V1-04
55
Flight/Voyage Number
Optional
String (AN)
Min 2Max 10

Identifying designator for the particular flight or voyage on which the cargo travels

R4 Loop
RequiredMax >1
R4
120
Heading > N7 Loop > R4 Loop > R4

Port or Terminal

RequiredMax use 1

Contractual or operational port or point relevant to the movement of the cargo

Example
If either Location Qualifier (R4-02) or Location Identifier (R4-03) is present, then the other is required
R4-01
115
Port or Terminal Function Code
Required
Identifier (ID)
Min 1Max 1

Code defining function performed at the port or terminal with respect to a shipment

R4-02
309
Location Qualifier
Optional
Identifier (ID)
Min 1Max 2

Code identifying type of location

R4-03
310
Location Identifier
Optional
String (AN)
Min 1Max 30

Code which identifies a specific location

R4-04
114
Port Name
Optional
String (AN)
Min 2Max 24

Free-form name for the place at which an offshore carrier originates or terminates (by transshipment or otherwise) its actual ocean carriage of property

R4-06
174
Terminal Name
Optional
String (AN)
Min 2Max 30

Free-form field for terminal name

DTM
130
Heading > N7 Loop > R4 Loop > DTM

Date/Time Reference

OptionalMax use 15

To specify pertinent dates and times

Example
DTM-01
374
Date/Time Qualifier
Required
Identifier (ID)
Min 3Max 3

Code specifying type of date or time, or both date and time

Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

R4 Loop end
N1 Loop
OptionalMax >1
N1
150
Heading > N7 Loop > N1 Loop > N1

Name

RequiredMax use 1

To identify a party by type of organization, name, and code

Example
If either Identification Code Qualifier (N1-03) or Identification Code (N1-04) is present, then the other is required
N1-01
98
Entity Identifier Code
Required
Identifier (ID)
Min 2Max 3

Code identifying an organizational entity, a physical location, property or an individual

N1-03
66
Identification Code Qualifier
Optional
Identifier (ID)
Min 1Max 2

Code designating the system/method of code structure used for Identification Code (67)

N1-04
67
Identification Code
Optional
String (AN)
Min 2Max 80

Code identifying a party or other code

  • This segment, used alone, provides the most efficient method of providing organizational identification. To obtain this efficiency the "ID Code" (N104) must provide a key to the table maintained by the transaction processing party.
N1 Loop end
N9
170
Heading > N7 Loop > N9

Reference Identification

RequiredMax use 10

To transmit identifying information as specified by the Reference Identification Qualifier

Example
N9-01
128
Reference Identification Qualifier
Required
Identifier (ID)
Min 2Max 3

Code qualifying the Reference Identification

N9-02
127
Reference Identification
Optional
String (AN)
Min 1Max 30

Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier

L0 Loop
OptionalMax >1
L0
180
Heading > N7 Loop > L0 Loop > L0

Line Item - Quantity and Weight

RequiredMax use 1

To specify quantity, weight, volume, and type of service for a line item including applicable "quantity/rate-as" data

Example
H1
200
Heading > N7 Loop > L0 Loop > H1

Hazardous Material

OptionalMax use 3

To specify information relative to hazardous material

Example
H1-01
62
Hazardous Material Code
Required
String (AN)
Min 4Max 10

Code relating to hazardous material code qualifier for regulated hazardous materials

H1-02
209
Hazardous Material Class Code
Optional
String (AN)
Min 1Max 4

Code specifying the kind of hazard for a material

L0 Loop end
N7 Loop end
SE
220
Heading > SE

Transaction Set Trailer

RequiredMax use 1

To indicate the end of the transaction set and provide the count of the transmitted segments (including the beginning (ST) and ending (SE) segments)

Example
SE-01
96
Number of Included Segments
Required
Numeric (N0)
Min 1Max 10

Total number of segments included in a transaction set including ST and SE segments

SE-02
329
Transaction Set Control Number
Required
Numeric (N)
Min 4Max 9

Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set

Heading end

Functional Group Trailer

RequiredMax use 1

To indicate the end of a functional group and to provide control information

Example
GE-01
97
Number of Transaction Sets Included
Required
Numeric (N0)
Min 1Max 6

Total number of transaction sets included in the functional group or interchange (transmission) group terminated by the trailer containing this data element

GE-02
28
Group Control Number
Required
Numeric (N0)
Min 1Max 9

Assigned number originated and maintained by the sender

Interchange Control Trailer

RequiredMax use 1

To define the end of an interchange of zero or more functional groups and interchange-related control segments

Example
IEA-01
I16
Number of Included Functional Groups
Required
Numeric (N0)
Min 1Max 5

A count of the number of functional groups included in an interchange

IEA-02
I12
Interchange Control Number
Required
Numeric (N0)
Min 9Max 9

A control number assigned by the interchange sender

Stedi is a registered trademark of Stedi, Inc. All names, logos, and brands of third parties listed on this page are trademarks of their respective owners (including “X12”, which is a trademark of X12 Incorporated). Stedi, Inc. and its products and services are not endorsed by, sponsored by, or affiliated with these third parties. Use of these names, logos, and brands is for identification purposes only, and does not imply any such endorsement, sponsorship, or affiliation.