H-E-B
/
OFX Ship Notice/Manifest
  • Specification
  • EDI Inspector
Stedi maintains this guide based on public documentation from H-E-B. Contact H-E-B for official EDI specifications. To report any errors in this guide, please contact us.
Go to Stedi Network
H-E-B logo

X12 856 OFX Ship Notice/Manifest

X12 Release 4010

This Draft Standard for Trial Use contains the format and establishes the data contents of the Ship Notice/Manifest Transaction Set (856) for use within the context of an Electronic Data Interchange (EDI) environment. The transaction set can be used to list the contents of a shipment of goods as well as additional information relating to the shipment, such as order information, product description, physical characteristics, type of packaging, marking, carrier information, and configuration of goods within the transportation equipment. The transaction set enables the sender to describe the contents and configuration of a shipment in various levels of detail and provides an ordered flexibility to convey information.

The sender of this transaction is the organization responsible for detailing and communicating the contents of a shipment, or shipments, to one or more receivers of the transaction set. The receiver of this transaction set can be any organization having an interest in the contents of a shipment or information about the contents of 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/h-e-b/ofx-ship-noticemanifest/01H913XG90E0F693QGJZ2H9RE0
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
detail
HL Loop
HL
010
Hierarchical Level
Max use 1
Required
TD1
110
Carrier Details (Quantity and Weight)
Max use 20
Optional
TD5
120
Carrier Details (Routing Sequence/Transit Time)
Max use 12
Optional
TD3
130
Carrier Details (Equipment)
Max use 12
Optional
TD4
140
Carrier Details (Special Handling, or Hazardous Materials, or Both)
Max use 5
Optional
REF
150
Reference Identification
Max use 1
Required
DTM
200
Date/Time Reference
Max use 10
Required
HL Loop Order
HL
010
Hierarchical Level
Max use 1
Required
PRF
050
Purchase Order Reference
Max use 1
Required
TD1
110
Carrier Details (Quantity and Weight)
Max use 20
Optional
TD5
120
Carrier Details (Routing Sequence/Transit Time)
Max use 12
Optional
REF
150
Reference Identification
Max use 1
Optional
DTM
200
Date/Time Reference
Max use 10
Optional
N1 Loop
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

SH
Ship Notice/Manifest (856)
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).
856
Ship Notice/Manifest
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

BSN
020
Heading > BSN

Beginning Segment for Ship Notice

RequiredMax use 1

To transmit identifying numbers, dates, and other basic data relating to the transaction set

Example
BSN-01
353
Transaction Set Purpose Code
Required
Identifier (ID)

Code identifying purpose of transaction set

00
Original
BSN-02
396
Shipment Identification
Required
String (AN)
Min 2Max 30

A unique control number assigned by the original shipper to identify a specific shipment

Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

  • BSN03 is the date the shipment transaction set is created.
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)

  • BSN04 is the time the shipment transaction set is created.
BSN-05
1005
Hierarchical Structure Code
Optional
Identifier (ID)

Code indicating the hierarchical application structure of a transaction set that utilizes the HL segment to define the structure of the transaction set

Usage notes

Shipment, Order, Tare, Packaging, Item

0001
Shipment, Order, Packaging, Item
0002
Shipment, Order, Item, Packaging
Heading end

Detail

HL Loop
RequiredMax >1
HL
010
Detail > HL Loop > HL

Hierarchical Level

RequiredMax use 1

To identify dependencies among and the content of hierarchically related groups of data segments

  • The HL segment is the only mandatory segment within the HL loop, and by itself, the HL segment has no meaning.
Example
HL-01
628
Hierarchical ID Number
Required
String (AN)
Min 1Max 12

A unique number assigned by the sender to identify a particular data segment in a hierarchical structure

  • HL01 shall contain a unique alphanumeric number for each occurrence of the HL segment in the transaction set. For example, HL01 could be used to indicate the number of occurrences of the HL segment, in which case the value of HL01 would be "1" for the initial HL segment and would be incremented by one in each subsequent HL segment within the transaction.
HL-03
735
Hierarchical Level Code
Required
Identifier (ID)

Code defining the characteristic of a level in a hierarchical structure

  • HL03 indicates the context of the series of segments following the current HL segment up to the next occurrence of an HL segment in the transaction. For example, HL03 is used to indicate that subsequent segments in the HL loop form a logical grouping of data referring to shipment, order, or item-level information.
S
Shipment
HL-04
736
Hierarchical Child Code
Optional
Identifier (ID)

Code indicating if there are hierarchical child data segments subordinate to the level being described

  • HL04 indicates whether or not there are subordinate (or child) HL segments related to the current HL segment.
1
Additional Subordinate HL Data Segment in This Hierarchical Structure.
TD1
110
Detail > HL Loop > TD1

Carrier Details (Quantity and Weight)

OptionalMax use 20

To specify the transportation details relative to commodity, weight, and quantity

Example
If Packaging Code (TD1-01) is present, then Lading Quantity (TD1-02) is required
If Weight Qualifier (TD1-06) is present, then Weight (TD1-07) is required
If either Weight (TD1-07) or Unit or Basis for Measurement Code (TD1-08) is present, then the other is required
TD1-01
103
Packaging Code
Optional
String (AN)
Min 3Max 5

Code identifying the type of packaging; Part 1: Packaging Form, Part 2: Packaging Material; if the Data Element is used, then Part 1 is always required

Usage notes

H-E-B Requires for Shipment 1st 3 bytes at ship level:
'PLT' - for palletized
'CTN - carton/container

Last 2 bytes:
'94' - Wood
'79' - Plastic
'31' - Fiber
'58' - Metal
'71' - Not otherwise specified

Codes used:
01 Aluminum
04 As Specified by the DOT
07 Burlap
10 Chemically Hardened Fibre
13 Cloth
16 Cloth Top
19 Cloth or Fabric
22 Compressed
25 Corrugated or Solid
28 Double-wall Paper
31 Fibre
34 Fibre (Paperboard)
37 Fiberboard
40 Fiberboard Metal
43 Glass
46 In Inner Containers
48 Wire/Cord
49 Insulated
50 Steel - Vinyl Coated
51 Wire Mesh
52 Iron or Steel
53 Jumbo
54 Special Jumbo
55 Lead
58 Metal
59 Metal Cans
61 Moisture Resistant
64 Molded Plastic
67 Multiple-wall Paper (2 or more walls)
70 Multiple-wall Paper (3 or more walls)
71 Not Otherwise Specified
72 Paper - VCI
73 Other than Glass
74 Other than Metal or Plastic Tubes, or Glass
75 Plastic - Vacuum Formed
76 Paper
77 Plastic - Structural Foam
78 Plastic - Injection Molded
79 Plastic
80 Polyethylene Lined
81 Plastic - Virgin
82 Pulpboard
83 Plastic - Regrind
84 Polystyrene
85 Rubber
86 Foam
88 Rubber and Fabric
89 Special
90 Standard
91 Stainless Steel
92 Tubes, Metal or Plastic
94 Wood
95 Single Wall Corrugated Board
96 Double Wall Corrugated Board
97 Triple Wall Corrugated Board

TD1-02
80
Lading Quantity
Optional
Numeric (N0)
Min 1Max 7

Number of units (pieces) of the lading commodity

Usage notes
# pallets (or shipping containers comprising shipment).
TD1-06
187
Weight Qualifier
Optional
Identifier (ID)

Code defining the type of weight

G
Gross Weight
TD1-07
81
Weight
Optional
Decimal number (R)
Min 1Max 6

Numeric value of weight

Usage notes

H-E-B only uses 6 digits when describing weight. Even though EDI accept 10 digit weights, H-E-B will truncate the 4 left most digits.

TD1-08
355
Unit or Basis for Measurement Code
Optional
Identifier (ID)

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

LB
Pound
TD5
120
Detail > HL Loop > TD5

Carrier Details (Routing Sequence/Transit Time)

OptionalMax use 12

To specify the carrier and sequence of routing and provide transit time information

Example
If Identification Code Qualifier (TD5-02) is present, then Identification Code (TD5-03) is required
TD5-01
133
Routing Sequence Code
Optional
Identifier (ID)

Code describing the relationship of a carrier to a specific shipment movement

B
Origin/Delivery Carrier (Any Mode)
O
Origin Carrier (Air, Motor, or Ocean)
TD5-02
66
Identification Code Qualifier
Optional
Identifier (ID)

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

  • When specifying a routing sequence to be used for the shipment movement in lieu of specifying each carrier within the movement, use TD502 to identify the party responsible for defining the routing sequence, and use TD503 to identify the actual routing sequence, specified by the party identified in TD502.
2
Standard Carrier Alpha Code (SCAC)
TD5-03
67
Identification Code
Optional
String (AN)
Min 2Max 80

Code identifying a party or other code

TD5-04
91
Transportation Method/Type Code
Optional
Identifier (ID)

Code specifying the method or type of transportation for the shipment

A
Air
H
Customer Pickup
M
Motor (Common Carrier)
R
Rail
S
Ocean
TD5-05
387
Routing
Optional
String (AN)
Min 1Max 35

Free-form description of the routing or requested routing for shipment, or the originating carrier's identity

Usage notes

Carrier Name

TD5-06
368
Shipment/Order Status Code
Optional
Identifier (ID)

Code indicating the status of an order or shipment or the disposition of any difference between the quantity ordered and the quantity shipped for a line item or transaction

BK
Back Ordered from Previous Order
CC
Shipment Complete on (Date)
CL
Complete
CS
Shipment Complete with Substitution
DE
Deleted Order
PR
Partial Shipment
TD5-08
310
Location Identifier
Optional
String (AN)
Min 1Max 30

Code which identifies a specific location

Usage notes

Use US Census Sched. D

TD3
130
Detail > HL Loop > TD3

Carrier Details (Equipment)

OptionalMax use 12

To specify transportation details relating to the equipment used by the carrier

Example
Only one of Equipment Description Code (TD3-01) or Equipment Type (TD3-10) may be present
TD3-01
40
Equipment Description Code
Optional
Identifier (ID)
Min 2Max 2

Code identifying type of equipment used for shipment

TD3-03
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)

Usage notes

Actual # of Equipment used.

TD3-10
24
Equipment Type
Optional
Identifier (ID)
Min 4Max 4

Code identifying equipment type

TD4
140
Detail > HL Loop > TD4

Carrier Details (Special Handling, or Hazardous Materials, or Both)

OptionalMax use 5

To specify transportation special handling requirements, or hazardous materials information, or both

Example
TD4-01
152
Special Handling Code
Optional
Identifier (ID)
Min 2Max 3

Code specifying special transportation handling instructions

REF
150
Detail > HL Loop > REF

Reference Identification

RequiredMax use >1

To specify identifying information

Example
REF-01
128
Reference Identification Qualifier
Required
Identifier (ID)

Code qualifying the Reference Identification

AF
Airlines Flight Identification Number
AO
Appointment Number
BM
Bill of Lading Number
CN
Carrier's Reference Number (PRO/Invoice)
MB
Master Bill of Lading
ZZ
Mutually Defined
REF-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

DTM
200
Detail > HL Loop > DTM

Date/Time Reference

RequiredMax use 10

To specify pertinent dates and times

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

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

011
Shipped
017
Estimated Delivery
067
Current Schedule Delivery
068
Current Schedule Ship
Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

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)

N1 Ship From
RequiredMax 1
Variants (all may be used)
Ship To
N1
220
Detail > HL Loop > Ship From > N1

Name

RequiredMax use 1

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

Example
At least one of Name (N1-02) or Identification Code Qualifier (N1-03) is required
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)

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

SF
Ship From
Optional
String (AN)
Min 1Max 60

Free-form name

N1-03
66
Identification Code Qualifier
Optional
Identifier (ID)

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

9
D-U-N-S+4, D-U-N-S Number with Four Character Suffix
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.
Usage notes

For Shipments to H-E-B warehouse, the +4 will be the Warehouse # followed by a trailing zero.

N2
230
Detail > HL Loop > Ship From > N2

Additional Name Information

OptionalMax use 2

To specify additional names or those longer than 35 characters in length

Example
Required
String (AN)
Min 1Max 60

Free-form name

Optional
String (AN)
Min 1Max 60

Free-form name

N3
240
Detail > HL Loop > Ship From > N3

Address Information

OptionalMax use 2

To specify the location of the named party

Example
N3-01
166
Address Information
Required
String (AN)
Min 1Max 55

Address information

N3-02
166
Address Information
Optional
String (AN)
Min 1Max 55

Address information

N4
250
Detail > HL Loop > Ship From > N4

Geographic Location

OptionalMax use 1

To specify the geographic place of the named party

Example
N4-01
19
City Name
Optional
String (AN)
Min 2Max 30

Free-form text for city name

  • A combination of either N401 through N404, or N405 and N406 may be adequate to specify a location.
N4-02
156
State or Province Code
Optional
Identifier (ID)
Min 2Max 2

Code (Standard State/Province) as defined by appropriate government agency

  • N402 is required only if city name (N401) is in the U.S. or Canada.
N4-03
116
Postal Code
Optional
Identifier (ID)
Min 3Max 15

Code defining international postal zone code excluding punctuation and blanks (zip code for United States)

N4-04
26
Country Code
Optional
Identifier (ID)
Min 2Max 3

Code identifying the country

N4-05
309
Location Qualifier
Optional
Identifier (ID)

Code identifying type of location

D
Census Schedule D
IA
International Air Transport Association (IATA) Location Qualifier
K
Census Schedule K
W
Worldwide Geographic Location Code
N1 Ship From end
N1 Ship To
RequiredMax 1
Variants (all may be used)
Ship From
N1
220
Detail > HL Loop > Ship To > N1

Name

RequiredMax use 1

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

Example
At least one of Name (N1-02) or Identification Code Qualifier (N1-03) is required
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)

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

ST
Ship To
Optional
String (AN)
Min 1Max 60

Free-form name

N1-03
66
Identification Code Qualifier
Optional
Identifier (ID)

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

9
D-U-N-S+4, D-U-N-S Number with Four Character Suffix
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.
Usage notes

For Shipments to H-E-B warehouse, the +4 will be the Warehouse # followed by a trailing zero.

N2
230
Detail > HL Loop > Ship To > N2

Additional Name Information

OptionalMax use 2

To specify additional names or those longer than 35 characters in length

Example
Required
String (AN)
Min 1Max 60

Free-form name

Optional
String (AN)
Min 1Max 60

Free-form name

N3
240
Detail > HL Loop > Ship To > N3

Address Information

OptionalMax use 2

To specify the location of the named party

Example
N3-01
166
Address Information
Required
String (AN)
Min 1Max 55

Address information

N3-02
166
Address Information
Optional
String (AN)
Min 1Max 55

Address information

N4
250
Detail > HL Loop > Ship To > N4

Geographic Location

OptionalMax use 1

To specify the geographic place of the named party

Example
N4-01
19
City Name
Optional
String (AN)
Min 2Max 30

Free-form text for city name

  • A combination of either N401 through N404, or N405 and N406 may be adequate to specify a location.
N4-02
156
State or Province Code
Optional
Identifier (ID)
Min 2Max 2

Code (Standard State/Province) as defined by appropriate government agency

  • N402 is required only if city name (N401) is in the U.S. or Canada.
N4-03
116
Postal Code
Optional
Identifier (ID)
Min 3Max 15

Code defining international postal zone code excluding punctuation and blanks (zip code for United States)

N4-04
26
Country Code
Optional
Identifier (ID)
Min 2Max 3

Code identifying the country

N4-05
309
Location Qualifier
Optional
Identifier (ID)

Code identifying type of location

D
Census Schedule D
IA
International Air Transport Association (IATA) Location Qualifier
K
Census Schedule K
W
Worldwide Geographic Location Code
N1 Ship To end
HL Loop Order
RequiredMax >1
HL
010
Detail > HL Loop > HL Loop Order > HL

Hierarchical Level

RequiredMax use 1

To identify dependencies among and the content of hierarchically related groups of data segments

  • The HL segment is the only mandatory segment within the HL loop, and by itself, the HL segment has no meaning.
Example
HL-01
628
Hierarchical ID Number
Required
String (AN)
Min 1Max 12

A unique number assigned by the sender to identify a particular data segment in a hierarchical structure

  • HL01 shall contain a unique alphanumeric number for each occurrence of the HL segment in the transaction set. For example, HL01 could be used to indicate the number of occurrences of the HL segment, in which case the value of HL01 would be "1" for the initial HL segment and would be incremented by one in each subsequent HL segment within the transaction.
HL-02
734
Hierarchical Parent ID Number
Required
String (AN)
Min 1Max 12

Identification number of the next higher hierarchical data segment that the data segment being described is subordinate to

  • HL02 identifies the hierarchical ID number of the HL segment to which the current HL segment is subordinate.
HL-03
735
Hierarchical Level Code
Required
Identifier (ID)

Code defining the characteristic of a level in a hierarchical structure

  • HL03 indicates the context of the series of segments following the current HL segment up to the next occurrence of an HL segment in the transaction. For example, HL03 is used to indicate that subsequent segments in the HL loop form a logical grouping of data referring to shipment, order, or item-level information.
O
Order
HL-04
736
Hierarchical Child Code
Optional
Identifier (ID)

Code indicating if there are hierarchical child data segments subordinate to the level being described

  • HL04 indicates whether or not there are subordinate (or child) HL segments related to the current HL segment.
0
No Subordinate HL Segment in This Hierarchical Structure.
1
Additional Subordinate HL Data Segment in This Hierarchical Structure.
PRF
050
Detail > HL Loop > HL Loop Order > PRF

Purchase Order Reference

RequiredMax use 1

To provide reference to a specific purchase order

Example
PRF-01
324
Purchase Order Number
Required
String (AN)
Min 1Max 22

Identifying number for Purchase Order assigned by the orderer/purchaser

PRF-02
328
Release Number
Optional
String (AN)
Min 1Max 30

Number identifying a release against a Purchase Order previously placed by the parties involved in the transaction

Usage notes

Release against PO number.

Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

  • PRF04 is the date assigned by the purchaser to purchase order.
TD1
110
Detail > HL Loop > HL Loop Order > TD1

Carrier Details (Quantity and Weight)

OptionalMax use 20

To specify the transportation details relative to commodity, weight, and quantity

Example
If Weight Qualifier (TD1-06) is present, then Weight (TD1-07) is required
If either Weight (TD1-07) or Unit or Basis for Measurement Code (TD1-08) is present, then the other is required
If either Volume (TD1-09) or Unit or Basis for Measurement Code (TD1-10) is present, then the other is required
TD1-01
103
Packaging Code
Optional
String (AN)
Min 3Max 5

Code identifying the type of packaging; Part 1: Packaging Form, Part 2: Packaging Material; if the Data Element is used, then Part 1 is always required

Usage notes

H-E-B Requires Order Level HL Loop:
1st 3 bytes at ship level
'PLT' - for palletized
'CTN - carton/container

Last 2 bytes:
'94' - Wood
'79' - Plastic
'31' - Fiber
'58' - Metal
'71' - Not otherwise specified

TD1-02
80
Lading Quantity
Optional
Numeric (N0)
Min 1Max 7

Number of units (pieces) of the lading commodity

Usage notes
# pallets (or shipping containers comprising shipment).
TD1-06
187
Weight Qualifier
Optional
Identifier (ID)

Code defining the type of weight

G
Gross Weight
TD1-07
81
Weight
Optional
Decimal number (R)
Min 1Max 10

Numeric value of weight

Usage notes

H-E-B only uses 6 digits when describing weight. Even though EDI accept 10 digit weights, H-E-B will truncate the 4 left most digits.

TD1-08
355
Unit or Basis for Measurement Code
Optional
Identifier (ID)

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

LB
Pound
TD1-09
183
Volume
Optional
Decimal number (R)
Min 1Max 8

Value of volumetric measure

Usage notes

Gross Volume

TD1-10
355
Unit or Basis for Measurement Code
Optional
Identifier (ID)

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

CF
Cubic Feet
TD5
120
Detail > HL Loop > HL Loop Order > TD5

Carrier Details (Routing Sequence/Transit Time)

OptionalMax use 12

To specify the carrier and sequence of routing and provide transit time information

Example
TD5-06
368
Shipment/Order Status Code
Optional
Identifier (ID)

Code indicating the status of an order or shipment or the disposition of any difference between the quantity ordered and the quantity shipped for a line item or transaction

BK
Back Ordered from Previous Order
BP
Shipment Partial, Back Order to Ship on (Date)
CC
Shipment Complete on (Date)
CL
Complete
CM
Shipment Complete with Additional Quantity
CS
Shipment Complete with Substitution
DE
Deleted Order
DS
Out Of Stock Condition
PR
Partial Shipment
SS
Split Shipment
REF
150
Detail > HL Loop > HL Loop Order > REF

Reference Identification

OptionalMax use >1

To specify identifying information

Example
REF-01
128
Reference Identification Qualifier
Required
Identifier (ID)

Code qualifying the Reference Identification

6B
U.S. Customs Service (USCS) Entry Number
BM
Bill of Lading Number
DP
Department Number
IA
Internal Vendor Number
IV
Seller's Invoice Number
PD
Promotion/Deal Number
VN
Vendor Order Number
REF-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

DTM
200
Detail > HL Loop > HL Loop Order > DTM

Date/Time Reference

OptionalMax use 10

To specify pertinent dates and times

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

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

371
Estimated Arrival Date
Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

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)

N1 Loop
OptionalMax >1
N1
220
Detail > HL Loop > HL Loop Order > N1 Loop > N1

Name

RequiredMax use 1

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

Example
At least one of Name (N1-02) or Identification Code Qualifier (N1-03) is required
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)

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

BY
Buying Party (Purchaser)
Optional
String (AN)
Min 1Max 60

Free-form name

N1-03
66
Identification Code Qualifier
Optional
Identifier (ID)

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

9
D-U-N-S+4, D-U-N-S Number with Four Character Suffix
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.
Usage notes

For Shipments to H-E-B warehouse, the +4 will be the Warehouse # followed by a trailing zero.

N2
230
Detail > HL Loop > HL Loop Order > N1 Loop > N2

Additional Name Information

OptionalMax use 2

To specify additional names or those longer than 35 characters in length

Example
Required
String (AN)
Min 1Max 60

Free-form name

Optional
String (AN)
Min 1Max 60

Free-form name

N3
240
Detail > HL Loop > HL Loop Order > N1 Loop > N3

Address Information

OptionalMax use 2

To specify the location of the named party

Example
N3-01
166
Address Information
Required
String (AN)
Min 1Max 55

Address information

N3-02
166
Address Information
Optional
String (AN)
Min 1Max 55

Address information

N4
250
Detail > HL Loop > HL Loop Order > N1 Loop > N4

Geographic Location

OptionalMax use 1

To specify the geographic place of the named party

Example
N4-01
19
City Name
Optional
String (AN)
Min 2Max 30

Free-form text for city name

  • A combination of either N401 through N404, or N405 and N406 may be adequate to specify a location.
N4-02
156
State or Province Code
Optional
Identifier (ID)
Min 2Max 2

Code (Standard State/Province) as defined by appropriate government agency

  • N402 is required only if city name (N401) is in the U.S. or Canada.
N4-03
116
Postal Code
Optional
Identifier (ID)
Min 3Max 15

Code defining international postal zone code excluding punctuation and blanks (zip code for United States)

N4-04
26
Country Code
Optional
Identifier (ID)
Min 2Max 3

Code identifying the country

N1 Loop end
HL SOPI
OptionalMax >1
Variants (all may be used)
SOTPI
HL
010
Detail > HL Loop > HL Loop Order > SOPI > HL

Hierarchical Level

RequiredMax use 1

To identify dependencies among and the content of hierarchically related groups of data segments

  • The HL segment is the only mandatory segment within the HL loop, and by itself, the HL segment has no meaning.
Example
HL-01
628
Hierarchical ID Number
Required
String (AN)
Min 1Max 12

A unique number assigned by the sender to identify a particular data segment in a hierarchical structure

  • HL01 shall contain a unique alphanumeric number for each occurrence of the HL segment in the transaction set. For example, HL01 could be used to indicate the number of occurrences of the HL segment, in which case the value of HL01 would be "1" for the initial HL segment and would be incremented by one in each subsequent HL segment within the transaction.
HL-02
734
Hierarchical Parent ID Number
Required
String (AN)
Min 1Max 12

Identification number of the next higher hierarchical data segment that the data segment being described is subordinate to

  • HL02 identifies the hierarchical ID number of the HL segment to which the current HL segment is subordinate.
HL-03
735
Hierarchical Level Code
Required
Identifier (ID)

Code defining the characteristic of a level in a hierarchical structure

  • HL03 indicates the context of the series of segments following the current HL segment up to the next occurrence of an HL segment in the transaction. For example, HL03 is used to indicate that subsequent segments in the HL loop form a logical grouping of data referring to shipment, order, or item-level information.
P
Pack
HL-04
736
Hierarchical Child Code
Optional
Identifier (ID)

Code indicating if there are hierarchical child data segments subordinate to the level being described

  • HL04 indicates whether or not there are subordinate (or child) HL segments related to the current HL segment.
1
Additional Subordinate HL Data Segment in This Hierarchical Structure.
LIN
020
Detail > HL Loop > HL Loop Order > SOPI > LIN

Item Identification

RequiredMax use 1

To specify basic item identification data

Example
If either Product/Service ID Qualifier (LIN-04) or Product/Service ID (LIN-05) is present, then the other is required
If either Product/Service ID Qualifier (LIN-06) or Product/Service ID (LIN-07) is present, then the other is required
If either Product/Service ID Qualifier (LIN-08) or Product/Service ID (LIN-09) is present, then the other is required
LIN-02
235
Product/Service ID Qualifier
Required
Identifier (ID)

Code identifying the type/source of the descriptive number used in Product/Service ID (234)

  • LIN02 through LIN31 provide for fifteen different product/service IDs for each item. For example: Case, Color, Drawing No., U.P.C. No., ISBN No., Model No., or SKU.
UK
U.P.C./EAN Shipping Container Code (1-2-5-5-1)

A 14-digit code that uniquely identifies the
manufacturer's shipping unit, including the packaging indicator and check digit; the first digit is the packaging indicator, the next two digits are the number system characters, the next five digits are the manufacturer ID number, the second five digits are the item code, and the final digit is the check digit.

LIN-03
234
Product/Service ID
Required
String (AN)
Min 1Max 48

Identifying number for a product or service

Usage notes

Pack Level Loop

If LIN_02 = UK, LIN_03 is a 14 digit Case UPC (1-2-5-5-1 format).

LIN-04
235
Product/Service ID Qualifier
Optional
Identifier (ID)

Code identifying the type/source of the descriptive number used in Product/Service ID (234)

LT
Lot Number
LIN-05
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

Usage notes

Appropriate ID

LIN-06
235
Product/Service ID Qualifier
Optional
Identifier (ID)

Code identifying the type/source of the descriptive number used in Product/Service ID (234)

PJ
Product Date Code (A code indicating the period during which a product was manufactured.)
LIN-07
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

Usage notes

Appropriate ID

LIN-08
235
Product/Service ID Qualifier
Optional
Identifier (ID)

Code identifying the type/source of the descriptive number used in Product/Service ID (234)

U2
U.P.C. Shipping Container Code (1-2-5-5)

A 13-digit code that uniquely identifies the
manufacturer's shipping unit, including the packaging indicator; the first digit is the packaging indicator, the next two digits are the number system characters, the next five digits are the manufacturer ID number, and the remaining five digits are the item code.

UA
U.P.C./EAN Case Code (2-5-5)
UK
U.P.C./EAN Shipping Container Code (1-2-5-5-1)

A 14-digit code that uniquely identifies the
manufacturer's shipping unit, including the packaging indicator and check digit; the first digit is the packaging indicator, the next two digits are the number system characters, the next five digits are the manufacturer ID number, the second five digits are the item code, and the final digit is the check digit.

LIN-09
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

SN1
030
Detail > HL Loop > HL Loop Order > SOPI > SN1

Item Detail (Shipment)

RequiredMax use 1

To specify line-item detail relative to shipment

Example
SN1-02
382
Number of Units Shipped
Required
Decimal number (R)
Min 1Max 10

Numeric value of units shipped in manufacturer's shipping units for a line item or transaction set

Usage notes
# of units of item in LIN segment.
SN1-03
355
Unit or Basis for Measurement Code
Required
Identifier (ID)

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

  • SN103 defines the unit of measurement for both SN102 and SN104.
CA
Case
PO4
060
Detail > HL Loop > HL Loop Order > SOPI > PO4

Item Physical Details

OptionalMax use 1

To specify the physical qualities, packaging, weights, and dimensions relating to the item

Example
If either Gross Weight per Pack (PO4-06) or Unit or Basis for Measurement Code (PO4-07) is present, then the other is required
If Length (PO4-10) is present, then Unit or Basis for Measurement Code (PO4-13) is required
If Width (PO4-11) is present, then Unit or Basis for Measurement Code (PO4-13) is required
If Height (PO4-12) is present, then Unit or Basis for Measurement Code (PO4-13) is required
If Unit or Basis for Measurement Code (PO4-13) is present, then at least one of Length (PO4-10), Width (PO4-11) or Height (PO4-12) is required
Optional
Numeric (N0)
Min 1Max 6

The number of inner containers, or number of eaches if there are no inner containers, per outer container

PO4-06
384
Gross Weight per Pack
Optional
Decimal number (R)
Min 1Max 9

Numeric value of gross weight per pack

Usage notes

Weight of Pack Level container.

PO4-07
355
Unit or Basis for Measurement Code
Optional
Identifier (ID)

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

LB
Pound
PO4-10
82
Length
Optional
Decimal number (R)
Min 1Max 8

Largest horizontal dimension of an object measured when the object is in the upright position

Optional
Decimal number (R)
Min 1Max 8

Shorter measurement of the two horizontal dimensions measured with the object in the upright position

PO4-12
65
Height
Optional
Decimal number (R)
Min 1Max 8

Vertical dimension of an object measured when the object is in the upright position

PO4-13
355
Unit or Basis for Measurement Code
Optional
Identifier (ID)

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

  • PO413 defines the unit of measure for PO410, PO411, and PO412.
FT
Foot
IN
Inch
PO4-14
810
Inner Pack
Optional
Numeric (N0)
Min 1Max 6

The number of eaches per inner container

MAN
190
Detail > HL Loop > HL Loop Order > SOPI > MAN

Marks and Numbers

OptionalMax use >1

To indicate identifying marks and numbers for shipping containers

Example
MAN-01
88
Marks and Numbers Qualifier
Required
Identifier (ID)

Code specifying the application or source of Marks and Numbers (87)

  • MAN01/MAN02 and MAN04/MAN05 may be used to identify two different marks and numbers assigned to the same physical container.
  • When MAN01 contains code "UC" (U.P.C. Shipping Container Code) and MAN05/MAN06 contain a range of ID numbers, MAN03 is not used. The reason for this is that the U.P.C. Shipping Container code is the same on every carton that is represented in the range in MAN05/MAN06.
CP
Carrier-Assigned Package ID Number
SM
Shipper Assigned
UC
U.P.C. Shipping Container Code
MAN-02
87
Marks and Numbers
Required
String (AN)
Min 1Max 48

Marks and numbers used to identify a shipment or parts of a shipment

  • When both MAN02 and MAN03 are used, MAN02 is the starting number of a sequential range and MAN03 is the ending number of that range.
MAN-03
87
Marks and Numbers
Optional
String (AN)
Min 1Max 48

Marks and numbers used to identify a shipment or parts of a shipment

  • MAN03 and/or MAN06 are only used when sending a range(s) of ID numbers.
  • When both MAN02/MAN03 and MAN05/MAN06 are used to send ranges of ID numbers, the integrity of the two ID numbers must be maintained.
DTM
200
Detail > HL Loop > HL Loop Order > SOPI > DTM

Expiration

OptionalMax use 1

To specify pertinent dates and times

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

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

036
Expiration

Date coverage expires.

Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

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)

DTM
200
Detail > HL Loop > HL Loop Order > SOPI > DTM

Production

OptionalMax use 1

To specify pertinent dates and times

Example
Variants (all may be used)
DTMExpirationDTMShelf Life Expiration
DTM-01
374
Date/Time Qualifier
Required
Identifier (ID)

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

405
Production

Used to identify dates and times that operations or processes were performed.

Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

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)

DTM
200
Detail > HL Loop > HL Loop Order > SOPI > DTM

Shelf Life Expiration

OptionalMax use 1

To specify pertinent dates and times

Example
Variants (all may be used)
DTMExpirationDTMProduction
DTM-01
374
Date/Time Qualifier
Required
Identifier (ID)

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

511
Shelf Life Expiration
Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

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)

HL Loop
RequiredMax >1
HL
010
Detail > HL Loop > HL Loop Order > SOPI > HL Loop > HL

Hierarchical Level

RequiredMax use 1

To identify dependencies among and the content of hierarchically related groups of data segments

  • The HL segment is the only mandatory segment within the HL loop, and by itself, the HL segment has no meaning.
Example
HL-01
628
Hierarchical ID Number
Required
String (AN)
Min 1Max 12

A unique number assigned by the sender to identify a particular data segment in a hierarchical structure

  • HL01 shall contain a unique alphanumeric number for each occurrence of the HL segment in the transaction set. For example, HL01 could be used to indicate the number of occurrences of the HL segment, in which case the value of HL01 would be "1" for the initial HL segment and would be incremented by one in each subsequent HL segment within the transaction.
HL-02
734
Hierarchical Parent ID Number
Required
String (AN)
Min 1Max 12

Identification number of the next higher hierarchical data segment that the data segment being described is subordinate to

  • HL02 identifies the hierarchical ID number of the HL segment to which the current HL segment is subordinate.
HL-03
735
Hierarchical Level Code
Required
Identifier (ID)

Code defining the characteristic of a level in a hierarchical structure

  • HL03 indicates the context of the series of segments following the current HL segment up to the next occurrence of an HL segment in the transaction. For example, HL03 is used to indicate that subsequent segments in the HL loop form a logical grouping of data referring to shipment, order, or item-level information.
I
Item
HL-04
736
Hierarchical Child Code
Optional
Identifier (ID)

Code indicating if there are hierarchical child data segments subordinate to the level being described

  • HL04 indicates whether or not there are subordinate (or child) HL segments related to the current HL segment.
0
No Subordinate HL Segment in This Hierarchical Structure.
LIN
020
Detail > HL Loop > HL Loop Order > SOPI > HL Loop > LIN

Item Identification

RequiredMax use 1

To specify basic item identification data

Example
LIN-02
235
Product/Service ID Qualifier
Required
Identifier (ID)

Code identifying the type/source of the descriptive number used in Product/Service ID (234)

  • LIN02 through LIN31 provide for fifteen different product/service IDs for each item. For example: Case, Color, Drawing No., U.P.C. No., ISBN No., Model No., or SKU.
IN
Buyer's Item Number
SK
Stock Keeping Unit (SKU)
U2
U.P.C. Shipping Container Code (1-2-5-5)

A 13-digit code that uniquely identifies the
manufacturer's shipping unit, including the packaging indicator; the first digit is the packaging indicator, the next two digits are the number system characters, the next five digits are the manufacturer ID number, and the remaining five digits are the item code.

UA
U.P.C./EAN Case Code (2-5-5)
UK
U.P.C./EAN Shipping Container Code (1-2-5-5-1)

A 14-digit code that uniquely identifies the
manufacturer's shipping unit, including the packaging indicator and check digit; the first digit is the packaging indicator, the next two digits are the number system characters, the next five digits are the manufacturer ID number, the second five digits are the item code, and the final digit is the check digit.

UP
U.P.C. Consumer Package Code (1-5-5-1)
LIN-03
234
Product/Service ID
Required
String (AN)
Min 1Max 48

Identifying number for a product or service

Usage notes

If LIN_02 = UP, LIN_03 is a 12 digit Consumer Package UPC.

SN1
030
Detail > HL Loop > HL Loop Order > SOPI > HL Loop > SN1

Item Detail (Shipment)

RequiredMax use 1

To specify line-item detail relative to shipment

Example
If either Quantity Ordered (SN1-05) or Unit or Basis for Measurement Code (SN1-06) is present, then the other is required
SN1-02
382
Number of Units Shipped
Required
Decimal number (R)
Min 1Max 10

Numeric value of units shipped in manufacturer's shipping units for a line item or transaction set

Usage notes
# of units of item in LIN segment.
SN1-03
355
Unit or Basis for Measurement Code
Required
Identifier (ID)

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

  • SN103 defines the unit of measurement for both SN102 and SN104.
EA
Each
SN1-04
646
Quantity Shipped to Date
Optional
Decimal number (R)
Min 1Max 15

Number of units shipped to date

SN1-05
330
Quantity Ordered
Optional
Decimal number (R)
Min 1Max 15

Quantity ordered

SN1-06
355
Unit or Basis for Measurement Code
Optional
Identifier (ID)

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

EA
Each
PO4
060
Detail > HL Loop > HL Loop Order > SOPI > HL Loop > PO4

Item Physical Details

OptionalMax use 1

To specify the physical qualities, packaging, weights, and dimensions relating to the item

Example
If either Gross Weight per Pack (PO4-06) or Unit or Basis for Measurement Code (PO4-07) is present, then the other is required
If either Gross Volume per Pack (PO4-08) or Unit or Basis for Measurement Code (PO4-09) is present, then the other is required
Optional
Numeric (N0)
Min 1Max 6

The number of inner containers, or number of eaches if there are no inner containers, per outer container

Optional
Decimal number (R)
Min 1Max 8

Size of supplier units in pack

PO4-06
384
Gross Weight per Pack
Optional
Decimal number (R)
Min 1Max 9

Numeric value of gross weight per pack

Usage notes

Weight of Item Level container.

PO4-07
355
Unit or Basis for Measurement Code
Optional
Identifier (ID)

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

LB
Pound
PO4-08
385
Gross Volume per Pack
Optional
Decimal number (R)
Min 1Max 9

Numeric value of gross volume per pack

PO4-09
355
Unit or Basis for Measurement Code
Optional
Identifier (ID)

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

CF
Cubic Feet
PO4-14
810
Inner Pack
Optional
Numeric (N0)
Min 1Max 6

The number of eaches per inner container

PID
070
Detail > HL Loop > HL Loop Order > SOPI > HL Loop > PID

Product/Item Description

OptionalMax use 200

To describe a product or process in coded or free-form format

Example
PID-01
349
Item Description Type
Required
Identifier (ID)

Code indicating the format of a description

  • If PID01 equals "F", then PID05 is used. If PID01 equals "S", then PID04 is used. If PID01 equals "X", then both PID04 and PID05 are used.
F
Free-form
PID-05
352
Description
Optional
String (AN)
Min 1Max 80

A free-form description to clarify the related data elements and their content

Usage notes

Actual Description

REF
150
Detail > HL Loop > HL Loop Order > SOPI > HL Loop > REF

Reference Identification

OptionalMax use >1

To specify identifying information

Example
REF-01
128
Reference Identification Qualifier
Required
Identifier (ID)

Code qualifying the Reference Identification

SE
Serial Number
REF-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

DTM
200
Detail > HL Loop > HL Loop Order > SOPI > HL Loop > DTM

Date Packed

OptionalMax use 1

To specify pertinent dates and times

Example
Variants (all may be used)
DTMExpirationDTMShelf Life Expiration
DTM-01
374
Date/Time Qualifier
Required
Identifier (ID)

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

510
Date Packed
Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

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)

DTM
200
Detail > HL Loop > HL Loop Order > SOPI > HL Loop > DTM

Expiration

OptionalMax use 1

To specify pertinent dates and times

Example
Variants (all may be used)
DTMDate PackedDTMShelf Life Expiration
DTM-01
374
Date/Time Qualifier
Required
Identifier (ID)

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

036
Expiration
Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

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)

DTM
200
Detail > HL Loop > HL Loop Order > SOPI > HL Loop > DTM

Shelf Life Expiration

OptionalMax use 1

To specify pertinent dates and times

Example
Variants (all may be used)
DTMDate PackedDTMExpiration
DTM-01
374
Date/Time Qualifier
Required
Identifier (ID)

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

511
Shelf Life Expiration
Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

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)

HL Loop end
HL SOPI end
HL SOTPI
OptionalMax >1
Variants (all may be used)
SOPI
HL
010
Detail > HL Loop > HL Loop Order > SOTPI > HL

Hierarchical Level

RequiredMax use 1

To identify dependencies among and the content of hierarchically related groups of data segments

  • The HL segment is the only mandatory segment within the HL loop, and by itself, the HL segment has no meaning.
Example
HL-01
628
Hierarchical ID Number
Required
String (AN)
Min 1Max 12

A unique number assigned by the sender to identify a particular data segment in a hierarchical structure

  • HL01 shall contain a unique alphanumeric number for each occurrence of the HL segment in the transaction set. For example, HL01 could be used to indicate the number of occurrences of the HL segment, in which case the value of HL01 would be "1" for the initial HL segment and would be incremented by one in each subsequent HL segment within the transaction.
HL-02
734
Hierarchical Parent ID Number
Required
String (AN)
Min 1Max 12

Identification number of the next higher hierarchical data segment that the data segment being described is subordinate to

  • HL02 identifies the hierarchical ID number of the HL segment to which the current HL segment is subordinate.
HL-03
735
Hierarchical Level Code
Required
Identifier (ID)

Code defining the characteristic of a level in a hierarchical structure

  • HL03 indicates the context of the series of segments following the current HL segment up to the next occurrence of an HL segment in the transaction. For example, HL03 is used to indicate that subsequent segments in the HL loop form a logical grouping of data referring to shipment, order, or item-level information.
T
Shipping Tare
HL-04
736
Hierarchical Child Code
Optional
Identifier (ID)

Code indicating if there are hierarchical child data segments subordinate to the level being described

  • HL04 indicates whether or not there are subordinate (or child) HL segments related to the current HL segment.
1
Additional Subordinate HL Data Segment in This Hierarchical Structure.
MAN
190
Detail > HL Loop > HL Loop Order > SOTPI > MAN

Marks and Numbers

RequiredMax use >1

To indicate identifying marks and numbers for shipping containers

Example
MAN-01
88
Marks and Numbers Qualifier
Required
Identifier (ID)

Code specifying the application or source of Marks and Numbers (87)

  • MAN01/MAN02 and MAN04/MAN05 may be used to identify two different marks and numbers assigned to the same physical container.
  • When MAN01 contains code "UC" (U.P.C. Shipping Container Code) and MAN05/MAN06 contain a range of ID numbers, MAN03 is not used. The reason for this is that the U.P.C. Shipping Container code is the same on every carton that is represented in the range in MAN05/MAN06.
AA
SSCC-18
AI
UCC/EAN-128 Application Identifier (AI) and Data
GM
SSCC-18 and Application Identifier
SM
Shipper Assigned
UC
U.P.C. Shipping Container Code
MAN-02
87
Marks and Numbers
Required
String (AN)
Min 1Max 48

Marks and numbers used to identify a shipment or parts of a shipment

  • When both MAN02 and MAN03 are used, MAN02 is the starting number of a sequential range and MAN03 is the ending number of that range.
MAN-03
87
Marks and Numbers
Optional
String (AN)
Min 1Max 48

Marks and numbers used to identify a shipment or parts of a shipment

  • MAN03 and/or MAN06 are only used when sending a range(s) of ID numbers.
  • When both MAN02/MAN03 and MAN05/MAN06 are used to send ranges of ID numbers, the integrity of the two ID numbers must be maintained.
PAL
215
Detail > HL Loop > HL Loop Order > SOTPI > PAL

Pallet Information

OptionalMax use 1

To identify the type and physical attributes of the pallet, and, gross weight, gross volume, and height of the load and the pallet

Example
If either Unit Weight (PAL-05) or Unit or Basis for Measurement Code (PAL-06) is present, then the other is required
If Length (PAL-07) is present, then Unit or Basis for Measurement Code (PAL-10) is required
If Width (PAL-08) is present, then Unit or Basis for Measurement Code (PAL-10) is required
If Height (PAL-09) is present, then Unit or Basis for Measurement Code (PAL-10) is required
If Unit or Basis for Measurement Code (PAL-10) is present, then at least one of Length (PAL-07), Width (PAL-08) or Height (PAL-09) is required
If either Gross Weight per Pack (PAL-11) or Unit or Basis for Measurement Code (PAL-12) is present, then the other is required
If either Gross Volume per Pack (PAL-13) or Unit or Basis for Measurement Code (PAL-14) is present, then the other is required
PAL-01
883
Pallet Type Code
Optional
Identifier (ID)
Min 1Max 2

Code indicating the type of pallet

PAL-02
884
Pallet Tiers
Optional
Numeric (N0)
Min 1Max 3

The number of layers per pallet

Usage notes
# of layers per pallet
PAL-03
885
Pallet Blocks
Optional
Numeric (N0)
Min 1Max 3

The number of pieces (cartons) per layer on the pallet

Optional
Numeric (N0)
Min 1Max 6

The number of inner containers, or number of eaches if there are no inner containers, per outer container

  • PAL04 (Pack) is the number of pieces on the pallet.
PAL-05
395
Unit Weight
Optional
Decimal number (R)
Min 1Max 8

Numeric value of weight per unit

  • PAL05 (Unit Weight) is the weight of the pallet alone, before loading.
PAL-06
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

Usage notes

Type of Weight (lbs/kilos)

PAL-07
82
Length
Optional
Decimal number (R)
Min 1Max 8

Largest horizontal dimension of an object measured when the object is in the upright position

  • PAL07 and PAL08 (Length and Width) are the dimensions of the pallet before loading.
Optional
Decimal number (R)
Min 1Max 8

Shorter measurement of the two horizontal dimensions measured with the object in the upright position

PAL-09
65
Height
Optional
Decimal number (R)
Min 1Max 8

Vertical dimension of an object measured when the object is in the upright position

  • PAL09 (Height) is the height of the pallet and load.
PAL-10
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

Usage notes

UOM for Length/Width/Height

PAL-11
384
Gross Weight per Pack
Optional
Decimal number (R)
Min 1Max 9

Numeric value of gross weight per pack

  • PAL11 and PAL13 (Gross Weight and Gross Volume) are measured after loading and includes the pallet.
PAL-12
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

Usage notes

UOM for Pack Weight

PAL-13
385
Gross Volume per Pack
Optional
Decimal number (R)
Min 1Max 9

Numeric value of gross volume per pack

PAL-14
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

Usage notes

UOM for Pack Volume

PAL-15
399
Pallet Exchange Code
Optional
Identifier (ID)
Min 1Max 1

Code specifying pallet exchange instructions

N1 Loop
OptionalMax >1
N1
220
Detail > HL Loop > HL Loop Order > SOTPI > N1 Loop > N1

Name

RequiredMax use 1

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

Example
At least one of Name (N1-02) or Identification Code Qualifier (N1-03) is required
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)

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

SN
Store
Optional
String (AN)
Min 1Max 60

Free-form name

Usage notes

Store Name

N1-03
66
Identification Code Qualifier
Optional
Identifier (ID)

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

ZZ
Mutually Defined

ZZ - for Store

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

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.
Usage notes

HEB five digit Store number

N1 Loop end
HL Loop
RequiredMax >1
HL
010
Detail > HL Loop > HL Loop Order > SOTPI > HL Loop > HL

Hierarchical Level

RequiredMax use 1

To identify dependencies among and the content of hierarchically related groups of data segments

  • The HL segment is the only mandatory segment within the HL loop, and by itself, the HL segment has no meaning.
Example
HL-01
628
Hierarchical ID Number
Required
String (AN)
Min 1Max 12

A unique number assigned by the sender to identify a particular data segment in a hierarchical structure

  • HL01 shall contain a unique alphanumeric number for each occurrence of the HL segment in the transaction set. For example, HL01 could be used to indicate the number of occurrences of the HL segment, in which case the value of HL01 would be "1" for the initial HL segment and would be incremented by one in each subsequent HL segment within the transaction.
HL-02
734
Hierarchical Parent ID Number
Required
String (AN)
Min 1Max 12

Identification number of the next higher hierarchical data segment that the data segment being described is subordinate to

  • HL02 identifies the hierarchical ID number of the HL segment to which the current HL segment is subordinate.
HL-03
735
Hierarchical Level Code
Required
Identifier (ID)

Code defining the characteristic of a level in a hierarchical structure

  • HL03 indicates the context of the series of segments following the current HL segment up to the next occurrence of an HL segment in the transaction. For example, HL03 is used to indicate that subsequent segments in the HL loop form a logical grouping of data referring to shipment, order, or item-level information.
P
Pack
HL-04
736
Hierarchical Child Code
Optional
Identifier (ID)

Code indicating if there are hierarchical child data segments subordinate to the level being described

  • HL04 indicates whether or not there are subordinate (or child) HL segments related to the current HL segment.
1
Additional Subordinate HL Data Segment in This Hierarchical Structure.
LIN
020
Detail > HL Loop > HL Loop Order > SOTPI > HL Loop > LIN

Item Identification

RequiredMax use 1

To specify basic item identification data

Example
If either Product/Service ID Qualifier (LIN-04) or Product/Service ID (LIN-05) is present, then the other is required
If either Product/Service ID Qualifier (LIN-06) or Product/Service ID (LIN-07) is present, then the other is required
If either Product/Service ID Qualifier (LIN-08) or Product/Service ID (LIN-09) is present, then the other is required
LIN-02
235
Product/Service ID Qualifier
Required
Identifier (ID)

Code identifying the type/source of the descriptive number used in Product/Service ID (234)

  • LIN02 through LIN31 provide for fifteen different product/service IDs for each item. For example: Case, Color, Drawing No., U.P.C. No., ISBN No., Model No., or SKU.
UK
U.P.C./EAN Shipping Container Code (1-2-5-5-1)

A 14-digit code that uniquely identifies the
manufacturer's shipping unit, including the packaging indicator and check digit; the first digit is the packaging indicator, the next two digits are the number system characters, the next five digits are the manufacturer ID number, the second five digits are the item code, and the final digit is the check digit.

LIN-03
234
Product/Service ID
Required
String (AN)
Min 1Max 48

Identifying number for a product or service

Usage notes

Pack Level Loop

If LIN_02 = UK, LIN_03 is a 14 digit Case UPC (1-2-5-5-1 format).

LIN-04
235
Product/Service ID Qualifier
Optional
Identifier (ID)

Code identifying the type/source of the descriptive number used in Product/Service ID (234)

LT
Lot Number
LIN-05
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

Usage notes

Appropriate ID

LIN-06
235
Product/Service ID Qualifier
Optional
Identifier (ID)

Code identifying the type/source of the descriptive number used in Product/Service ID (234)

PJ
Product Date Code (A code indicating the period during which a product was manufactured.)
LIN-07
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

Usage notes

Appropriate ID

LIN-08
235
Product/Service ID Qualifier
Optional
Identifier (ID)

Code identifying the type/source of the descriptive number used in Product/Service ID (234)

U2
U.P.C. Shipping Container Code (1-2-5-5)

A 13-digit code that uniquely identifies the
manufacturer's shipping unit, including the packaging indicator; the first digit is the packaging indicator, the next two digits are the number system characters, the next five digits are the manufacturer ID number, and the remaining five digits are the item code.

UA
U.P.C./EAN Case Code (2-5-5)
UK
U.P.C./EAN Shipping Container Code (1-2-5-5-1)

A 14-digit code that uniquely identifies the
manufacturer's shipping unit, including the packaging indicator and check digit; the first digit is the packaging indicator, the next two digits are the number system characters, the next five digits are the manufacturer ID number, the second five digits are the item code, and the final digit is the check digit.

LIN-09
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

SN1
030
Detail > HL Loop > HL Loop Order > SOTPI > HL Loop > SN1

Item Detail (Shipment)

RequiredMax use 1

To specify line-item detail relative to shipment

Example
SN1-02
382
Number of Units Shipped
Required
Decimal number (R)
Min 1Max 10

Numeric value of units shipped in manufacturer's shipping units for a line item or transaction set

Usage notes
# of units of item in LIN segment.
SN1-03
355
Unit or Basis for Measurement Code
Required
Identifier (ID)

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

  • SN103 defines the unit of measurement for both SN102 and SN104.
CA
Case
PO4
060
Detail > HL Loop > HL Loop Order > SOTPI > HL Loop > PO4

Item Physical Details

OptionalMax use 1

To specify the physical qualities, packaging, weights, and dimensions relating to the item

Example
If either Gross Weight per Pack (PO4-06) or Unit or Basis for Measurement Code (PO4-07) is present, then the other is required
If Length (PO4-10) is present, then Unit or Basis for Measurement Code (PO4-13) is required
If Width (PO4-11) is present, then Unit or Basis for Measurement Code (PO4-13) is required
If Height (PO4-12) is present, then Unit or Basis for Measurement Code (PO4-13) is required
If Unit or Basis for Measurement Code (PO4-13) is present, then at least one of Length (PO4-10), Width (PO4-11) or Height (PO4-12) is required
Optional
Numeric (N0)
Min 1Max 6

The number of inner containers, or number of eaches if there are no inner containers, per outer container

PO4-06
384
Gross Weight per Pack
Optional
Decimal number (R)
Min 1Max 9

Numeric value of gross weight per pack

Usage notes

Weight of Pack Level container.

PO4-07
355
Unit or Basis for Measurement Code
Optional
Identifier (ID)

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

LB
Pound
PO4-10
82
Length
Optional
Decimal number (R)
Min 1Max 8

Largest horizontal dimension of an object measured when the object is in the upright position

Optional
Decimal number (R)
Min 1Max 8

Shorter measurement of the two horizontal dimensions measured with the object in the upright position

PO4-12
65
Height
Optional
Decimal number (R)
Min 1Max 8

Vertical dimension of an object measured when the object is in the upright position

PO4-13
355
Unit or Basis for Measurement Code
Optional
Identifier (ID)

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

  • PO413 defines the unit of measure for PO410, PO411, and PO412.
FT
Foot
IN
Inch
PO4-14
810
Inner Pack
Optional
Numeric (N0)
Min 1Max 6

The number of eaches per inner container

MAN
190
Detail > HL Loop > HL Loop Order > SOTPI > HL Loop > MAN

Marks and Numbers

OptionalMax use >1

To indicate identifying marks and numbers for shipping containers

Example
MAN-01
88
Marks and Numbers Qualifier
Required
Identifier (ID)

Code specifying the application or source of Marks and Numbers (87)

  • MAN01/MAN02 and MAN04/MAN05 may be used to identify two different marks and numbers assigned to the same physical container.
  • When MAN01 contains code "UC" (U.P.C. Shipping Container Code) and MAN05/MAN06 contain a range of ID numbers, MAN03 is not used. The reason for this is that the U.P.C. Shipping Container code is the same on every carton that is represented in the range in MAN05/MAN06.
CP
Carrier-Assigned Package ID Number
SM
Shipper Assigned
UC
U.P.C. Shipping Container Code
MAN-02
87
Marks and Numbers
Required
String (AN)
Min 1Max 48

Marks and numbers used to identify a shipment or parts of a shipment

  • When both MAN02 and MAN03 are used, MAN02 is the starting number of a sequential range and MAN03 is the ending number of that range.
MAN-03
87
Marks and Numbers
Optional
String (AN)
Min 1Max 48

Marks and numbers used to identify a shipment or parts of a shipment

  • MAN03 and/or MAN06 are only used when sending a range(s) of ID numbers.
  • When both MAN02/MAN03 and MAN05/MAN06 are used to send ranges of ID numbers, the integrity of the two ID numbers must be maintained.
DTM
200
Detail > HL Loop > HL Loop Order > SOTPI > HL Loop > DTM

Expiration

OptionalMax use 1

To specify pertinent dates and times

Example
Variants (all may be used)
DTMProductionDTMShelf Life Expiration
DTM-01
374
Date/Time Qualifier
Required
Identifier (ID)

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

036
Expiration

Date coverage expires.

Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

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)

DTM
200
Detail > HL Loop > HL Loop Order > SOTPI > HL Loop > DTM

Production

OptionalMax use 1

To specify pertinent dates and times

Example
Variants (all may be used)
DTMExpirationDTMShelf Life Expiration
DTM-01
374
Date/Time Qualifier
Required
Identifier (ID)

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

405
Production

Used to identify dates and times that operations or processes were performed.

Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

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)

DTM
200
Detail > HL Loop > HL Loop Order > SOTPI > HL Loop > DTM

Shelf Life Expiration

OptionalMax use 1

To specify pertinent dates and times

Example
Variants (all may be used)
DTMExpirationDTMProduction
DTM-01
374
Date/Time Qualifier
Required
Identifier (ID)

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

511
Shelf Life Expiration
Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

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)

HL Loop
RequiredMax >1
HL
010
Detail > HL Loop > HL Loop Order > SOTPI > HL Loop > HL Loop > HL

Hierarchical Level

RequiredMax use 1

To identify dependencies among and the content of hierarchically related groups of data segments

  • The HL segment is the only mandatory segment within the HL loop, and by itself, the HL segment has no meaning.
Example
HL-01
628
Hierarchical ID Number
Required
String (AN)
Min 1Max 12

A unique number assigned by the sender to identify a particular data segment in a hierarchical structure

  • HL01 shall contain a unique alphanumeric number for each occurrence of the HL segment in the transaction set. For example, HL01 could be used to indicate the number of occurrences of the HL segment, in which case the value of HL01 would be "1" for the initial HL segment and would be incremented by one in each subsequent HL segment within the transaction.
HL-02
734
Hierarchical Parent ID Number
Required
String (AN)
Min 1Max 12

Identification number of the next higher hierarchical data segment that the data segment being described is subordinate to

  • HL02 identifies the hierarchical ID number of the HL segment to which the current HL segment is subordinate.
HL-03
735
Hierarchical Level Code
Required
Identifier (ID)

Code defining the characteristic of a level in a hierarchical structure

  • HL03 indicates the context of the series of segments following the current HL segment up to the next occurrence of an HL segment in the transaction. For example, HL03 is used to indicate that subsequent segments in the HL loop form a logical grouping of data referring to shipment, order, or item-level information.
I
Item
HL-04
736
Hierarchical Child Code
Optional
Identifier (ID)

Code indicating if there are hierarchical child data segments subordinate to the level being described

  • HL04 indicates whether or not there are subordinate (or child) HL segments related to the current HL segment.
0
No Subordinate HL Segment in This Hierarchical Structure.
LIN
020
Detail > HL Loop > HL Loop Order > SOTPI > HL Loop > HL Loop > LIN

Item Identification

RequiredMax use 1

To specify basic item identification data

Example
LIN-02
235
Product/Service ID Qualifier
Required
Identifier (ID)

Code identifying the type/source of the descriptive number used in Product/Service ID (234)

  • LIN02 through LIN31 provide for fifteen different product/service IDs for each item. For example: Case, Color, Drawing No., U.P.C. No., ISBN No., Model No., or SKU.
IN
Buyer's Item Number
SK
Stock Keeping Unit (SKU)
U2
U.P.C. Shipping Container Code (1-2-5-5)

A 13-digit code that uniquely identifies the
manufacturer's shipping unit, including the packaging indicator; the first digit is the packaging indicator, the next two digits are the number system characters, the next five digits are the manufacturer ID number, and the remaining five digits are the item code.

UA
U.P.C./EAN Case Code (2-5-5)
UK
U.P.C./EAN Shipping Container Code (1-2-5-5-1)

A 14-digit code that uniquely identifies the
manufacturer's shipping unit, including the packaging indicator and check digit; the first digit is the packaging indicator, the next two digits are the number system characters, the next five digits are the manufacturer ID number, the second five digits are the item code, and the final digit is the check digit.

UP
U.P.C. Consumer Package Code (1-5-5-1)
LIN-03
234
Product/Service ID
Required
String (AN)
Min 1Max 48

Identifying number for a product or service

Usage notes

If LIN_02 = UP, LIN_03 is a 12 digit Consumer Package UPC.

SN1
030
Detail > HL Loop > HL Loop Order > SOTPI > HL Loop > HL Loop > SN1

Item Detail (Shipment)

RequiredMax use 1

To specify line-item detail relative to shipment

Example
If either Quantity Ordered (SN1-05) or Unit or Basis for Measurement Code (SN1-06) is present, then the other is required
SN1-02
382
Number of Units Shipped
Required
Decimal number (R)
Min 1Max 10

Numeric value of units shipped in manufacturer's shipping units for a line item or transaction set

Usage notes
# of units of item in LIN segment.
SN1-03
355
Unit or Basis for Measurement Code
Required
Identifier (ID)

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

  • SN103 defines the unit of measurement for both SN102 and SN104.
EA
Each
SN1-04
646
Quantity Shipped to Date
Optional
Decimal number (R)
Min 1Max 15

Number of units shipped to date

SN1-05
330
Quantity Ordered
Optional
Decimal number (R)
Min 1Max 15

Quantity ordered

SN1-06
355
Unit or Basis for Measurement Code
Optional
Identifier (ID)

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

EA
Each
PO4
060
Detail > HL Loop > HL Loop Order > SOTPI > HL Loop > HL Loop > PO4

Item Physical Details

OptionalMax use 1

To specify the physical qualities, packaging, weights, and dimensions relating to the item

Example
If either Gross Weight per Pack (PO4-06) or Unit or Basis for Measurement Code (PO4-07) is present, then the other is required
If either Gross Volume per Pack (PO4-08) or Unit or Basis for Measurement Code (PO4-09) is present, then the other is required
Optional
Numeric (N0)
Min 1Max 6

The number of inner containers, or number of eaches if there are no inner containers, per outer container

Optional
Decimal number (R)
Min 1Max 8

Size of supplier units in pack

PO4-06
384
Gross Weight per Pack
Optional
Decimal number (R)
Min 1Max 9

Numeric value of gross weight per pack

Usage notes

Weight of Item Level container.

PO4-07
355
Unit or Basis for Measurement Code
Optional
Identifier (ID)

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

LB
Pound
PO4-08
385
Gross Volume per Pack
Optional
Decimal number (R)
Min 1Max 9

Numeric value of gross volume per pack

PO4-09
355
Unit or Basis for Measurement Code
Optional
Identifier (ID)

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

CF
Cubic Feet
PO4-14
810
Inner Pack
Optional
Numeric (N0)
Min 1Max 6

The number of eaches per inner container

PID
070
Detail > HL Loop > HL Loop Order > SOTPI > HL Loop > HL Loop > PID

Product/Item Description

OptionalMax use 200

To describe a product or process in coded or free-form format

Example
PID-01
349
Item Description Type
Required
Identifier (ID)

Code indicating the format of a description

  • If PID01 equals "F", then PID05 is used. If PID01 equals "S", then PID04 is used. If PID01 equals "X", then both PID04 and PID05 are used.
F
Free-form
PID-05
352
Description
Optional
String (AN)
Min 1Max 80

A free-form description to clarify the related data elements and their content

Usage notes

Actual Description

REF
150
Detail > HL Loop > HL Loop Order > SOTPI > HL Loop > HL Loop > REF

Reference Identification

OptionalMax use >1

To specify identifying information

Example
REF-01
128
Reference Identification Qualifier
Required
Identifier (ID)

Code qualifying the Reference Identification

SE
Serial Number
REF-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

DTM
200
Detail > HL Loop > HL Loop Order > SOTPI > HL Loop > HL Loop > DTM

Date Packed

OptionalMax use 10

To specify pertinent dates and times

Example
Variants (all may be used)
DTMExpirationDTMShelf Life Expiration
DTM-01
374
Date/Time Qualifier
Required
Identifier (ID)

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

510
Date Packed
Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

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)

DTM
200
Detail > HL Loop > HL Loop Order > SOTPI > HL Loop > HL Loop > DTM

Expiration

OptionalMax use 10

To specify pertinent dates and times

Example
Variants (all may be used)
DTMDate PackedDTMShelf Life Expiration
DTM-01
374
Date/Time Qualifier
Required
Identifier (ID)

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

036
Expiration
Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

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)

DTM
200
Detail > HL Loop > HL Loop Order > SOTPI > HL Loop > HL Loop > DTM

Shelf Life Expiration

OptionalMax use 10

To specify pertinent dates and times

Example
Variants (all may be used)
DTMDate PackedDTMExpiration
DTM-01
374
Date/Time Qualifier
Required
Identifier (ID)

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

511
Shelf Life Expiration
Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

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)

HL Loop end
HL Loop end
HL SOTPI end
HL Loop Order end
HL Loop end
Detail end

Summary

CTT
010
Summary > CTT

Transaction Totals

OptionalMax use 1

To transmit a hash total for a specific element in the transaction set

  • Number of line items (CTT01) is the accumulation of the number of HL segments.
    If used, hash total (CTT02) is the sum of the value of units shipped (SN102) for each SN1 segment.
Example
CTT-01
354
Number of Line Items
Required
Numeric (N0)
Min 1Max 6

Total number of line items in the transaction set

SE
020
Summary > 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

Summary 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.