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

X12 856 Ship Notice/Manifest

X12 Release 4030

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
  • ^ Repetition
EDI samples
  • None included
View the latest version of this implementation guide as an interactive webpage
https://www.stedi.com/app/guides/view/helzberg-diamonds/ship-noticemanifest/01HC2F8F4G4EXT619D57VHWERV
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
0100
Hierarchical Level
Max use 1
Required
TD1
1100
Carrier Details (Quantity and Weight)
Max use 20
Optional
TD5
1200
Carrier Details (Routing Sequence/Transit Time)
Max use 12
Optional
REF
1500
Reference Identification
Max use 1
Optional
PER
1510
Administrative Communications Contact
Max use 3
Optional
DTM
2000
Current Schedule Delivery
Max use 10
Optional
DTM
2000
Shipped
Max use 10
Required
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 identifying 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 identifying 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

Code indicating 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

Code indicating 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
I65
Repetition Separator
Required
String (AN)
Min 1Max 1

Type is not applicable; the repetition separator is a delimiter and not a data element; this field provides the delimiter used to separate repeated occurrences of a simple data element or a composite data structure; this value must be different than the data element separator, component element separator, and the segment terminator

^
Repetition Separator
ISA-12
I11
Interchange Control Version Number
Required
Identifier (ID)

Code specifying the version number of the interchange control segments

00403
Draft Standards for Trial Use Approved for Publication by ASC X12 Procedures Review Board through October 1999
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 indicating sender's request for an interchange acknowledgment

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

Code indicating 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 where CC represents the first two digits of the calendar year

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 identifying the issuer of the standard; this code is used in conjunction with Data Element 480

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

004030
Draft Standards Approved for Publication by ASC X12 Procedures Review Board through October 1999

Heading

ST
0100
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) is 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
0200
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

Usage notes

Ship notice number

Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD where CC represents the first two digits of the calendar year

  • BSN03 is the date the shipment transaction set is created.
Usage notes

Ship notice date

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

Ship notice time

Heading end

Detail

HL Loop
RequiredMax >1
Usage notes

The HL segment is used to identify levels of detail information using a hierarchical structure. BSN03 is the date the shipment transaction set is created.

HL01 shall contain a unique number for each occurrence of the HL segment within the transaction set. The value assigned to the first HL segment will be 1, and is incremented by one for each subsequent HL segment within the transaction set.

HL02 identifies the hierarchical ID of the HL segment to which it is subordinate (child of). HL02 will be omitted for the first occurrence of the HL segment in the transaction set, since it has no parent. HL03 identifies the application content of the series of segments following the current HL segment up to the next occurrence of an HL segment, or the CTT or SE segment, e.g., Shipment, Unit Load, Order, Tare, Pack, and Item.

HL
0100
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
1100
Detail > HL Loop > TD1

Carrier Details (Quantity and Weight)

OptionalMax use 20

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

Usage notes

This segment, at the shipment level, is used to specify total containers and gross weight of the shipment as specified on the bill of lading (see VICS EDI 856 Ship Notice/Manifest Guidelines for further detail).

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)

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

Part 1/2
CTN
Carton
Part 2/2
25
Corrugated or Solid
TD1-02
80
Lading Quantity
Optional
Numeric (N0)
Min 1Max 7

Number of units (pieces) of the lading commodity

Usage notes

The number of packages in the shipment as described in TD101.

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

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
1200
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

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

Usage notes

To obtain the SCAC code list for all carriers, contact:

National Motor Freight Trucking Association
2200 Mill Road
Alexandria, VA 22314

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

Code specifying the method or type of transportation for the shipment

Usage notes

If utilizing a air parcel service (UPS, FedEx, etc.), use code "A", otherwise
use code "U".

A
Air
U
Private Parcel Service
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

This is the carrier name from SCAC.

REF
1500
Detail > 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

CN
Carrier's Reference Number (PRO/Invoice)
REF-02
127
Reference Identification
Optional
String (AN)
Min 1Max 50

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

PER
1510
Detail > HL Loop > PER

Administrative Communications Contact

OptionalMax use 3

To identify a person or office to whom administrative communications should be directed

Usage notes

This segment is used to obtain supplier contact information should questions about the shipment arise.

Example
If either Communication Number Qualifier (PER-03) or Communication Number (PER-04) is present, then the other is required
If either Communication Number Qualifier (PER-05) or Communication Number (PER-06) is present, then the other is required
PER-01
366
Contact Function Code
Required
Identifier (ID)

Code identifying the major duty or responsibility of the person or group named

IC
Information Contact
Optional
String (AN)
Min 1Max 60

Free-form name

PER-03
365
Communication Number Qualifier
Optional
Identifier (ID)

Code identifying the type of communication number

WP
Work Phone Number
PER-04
364
Communication Number
Optional
String (AN)
Min 1Max 256

Complete communications number including country or area code when applicable

PER-05
365
Communication Number Qualifier
Optional
Identifier (ID)

Code identifying the type of communication number

EM
Electronic Mail
PER-06
364
Communication Number
Optional
String (AN)
Min 1Max 256

Complete communications number including country or area code when applicable

DTM
2000
Detail > HL Loop > DTM

Current Schedule Delivery

OptionalMax use 10

To specify pertinent dates and times

Usage notes

Two consecutive DTM segments can be generated at this position for each of the Date/Time Qualifiers listed in DTM01:

Shipped (DTM01 = 011): This segment is required, specifying the date and time the merchandise was shipped. The information provided in this segment represents the actual date and time that the carrier picked up the shipment.

Current Schedule Delivery (DTM01 = 067): This segment is required on Delivered Import shipments, specifying the estimated date of arrival of the shipment.

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

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

067
Current Schedule Delivery
Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD where CC represents the first two digits of the calendar year

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
2000
Detail > HL Loop > DTM

Shipped

RequiredMax use 10

To specify pertinent dates and times

Usage notes

Two consecutive DTM segments can be generated at this position for each of the Date/Time Qualifiers listed in DTM01:

Shipped (DTM01 = 011): This segment is required, specifying the date and time the merchandise was shipped. The information provided in this segment represents the actual date and time that the carrier picked up the shipment.

Current Schedule Delivery (DTM01 = 067): This segment is required on Delivered Import shipments, specifying the estimated date of arrival of the shipment.

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

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

011
Shipped
Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD where CC represents the first two digits of the calendar year

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
2200
Detail > HL Loop > N1 Loop > N1

Name

RequiredMax use 1

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

Usage notes

Ship To (N101 = ST): This loop is required. It will contain one N1 segment identifying the Ship To location number.

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)

92
Assigned by Buyer or Buyer's Agent
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

This is the location code as defined by N103. The location refers to a store, warehouse, etc. Location codes are used to alleviate the need to send complete names and addresses.

N3
2400
Detail > HL Loop > 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
2500
Detail > HL Loop > 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

Usage notes

ISO Numeric code required if country is not USA.

N1 Loop end
HL Loop
RequiredMax >1
Usage notes

The HL02 segment is used to identify levels of detail information using a hierarchical structure.

HL01 shall contain a unique number for each occurrence of the HL segment within the transaction set. The value assigned to the first HL segment will be 1, and is incremented by one for each subsequent HL segment within the transaction set.

HL02 identifies the hierarchical ID of the HL segment to which it is subordinate (child of). HL02 will be omitted for the first occurrence of the HL segment in the transaction set since it has no parent. HL03 identifies the application content of the series of segments following the current HL segment up to the next occurrence of an HL segment, or the CTT or SE segment, e.g., Shipment, Unit Load, Order, Tare, Pack, and Item.

HL
0100
Detail > 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.
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.
1
Additional Subordinate HL Data Segment in This Hierarchical Structure.
PRF
0500
Detail > HL Loop > HL Loop > PRF

Purchase Order Reference

OptionalMax 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

Usage notes

Retailer's original purchase order number.

Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD where CC represents the first two digits of the calendar year

  • PRF04 is the date assigned by the purchaser to purchase order.
Usage notes

Retailer's original purchase order date.

PRF-06
367
Contract Number
Optional
String (AN)
Min 1Max 30

Contract number

Usage notes

This element can be used to include the consignment or memo contract
number that is associated with the purchase order.

TD5
1200
Detail > HL Loop > 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

Usage notes

This segment, at the order level, is used to specify the status of the order.

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

CC
Shipment Complete on (Date)
CP
Partial Shipment on (Date), Considered No Backorder
SS
Split Shipment
HL Loop
RequiredMax >1
Usage notes

The HL segment is used to identify levels of detail information using a hierarchical structure.

HL01 shall contain a unique number for each occurrence of the HL segment within the transaction set. The value assigned to the first HL segment will be 1, and is incremented by one for each subsequent HL segment within the transaction set.

HL02 identifies the hierarchical ID of the HL segment to which it is subordinate (child of). HL02 will be omitted for the first occurrence of the HL segment in the transaction set, since it has no parent. HL03 identifies the application content of the series of segments following the current HL segment up to the next occurrence of an HL segment, or the CTT or SE segment, e.g., Shipment, Unit Load, Order, Tare, Pack, and Item.

HL
0100
Detail > HL Loop > 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
0200
Detail > HL Loop > HL Loop > HL Loop > LIN

Item Identification

OptionalMax use 1

To specify basic item identification data

Usage notes

The item numbers in LIN03 and LIN05 must match the original purchase order item numbers.

Example
If either Product/Service ID Qualifier (LIN-04) or Product/Service ID (LIN-05) 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.
IN
Buyer's Item Number
LIN-03
234
Product/Service ID
Required
String (AN)
Min 1Max 48

Identifying number for a product or service

Usage notes

This is the Retailer's identification number for the item.

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)

VN
Vendor's (Seller's) Item Number
LIN-05
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

Usage notes

This is the Manufacturing Style Number for the item.

SN1
0300
Detail > HL Loop > HL Loop > HL Loop > SN1

Item Detail (Shipment)

OptionalMax use 1

To specify line-item detail relative to shipment

Usage notes

This segment is used to specify the quantities associated with the item identified in the LIN at the item level.

When specifying an item, which is comprised of two or more components that are in unique shipping containers, SN103 will contain code ST for set and the quantity specified in SN102 is the number of sets as identified in the LIN segment. Each different component is identified in one pack level. See the VICS Note on the SLN segment at the pack level.

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

Total quantity of the associated item number/manufacturing style number
described in the LIN shipped.

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
EA
Each
PR
Pair
ST
Set
SN1-05
330
Quantity Ordered
Optional
Decimal number (R)
Min 1Max 15

Quantity ordered

Usage notes

The quantity ordered comes from the original quantity on the purchase
order, less any cancellations the supplier makes to the original quantity.

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

CA
Case
EA
Each
PR
Pair
ST
Set
PID
0700
Detail > HL Loop > HL Loop > HL Loop > PID

Product/Item Description

OptionalMax use 200

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

Usage notes

The PID segment is used to provide product/item descriptions in text and/or coded formats.

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-02
750
Product/Process Characteristic Code
Optional
Identifier (ID)

Code identifying the general class of a product or process characteristic

08
Product
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

This contains the supplier's item description for the product.

HL Loop end
HL Loop end
HL Loop end
Detail end

Summary

CTT
0100
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

Usage notes

The number of HL segments present in the transaction set.

SE
0200
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.