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

X12 856 Ship Notice/Manifest (Merchandise)

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/costco/ship-noticemanifest-merchandise/01JADKT2QWK91512HEXS1RE4XX
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 Shipment
HL
010
Hierarchical Level
Max use 1
Required
TD1
110
Carrier Details (Quantity and Weight)
Max use 20
Required
TD5
120
Carrier Details (Routing Sequence/Transit Time)
Max use 12
Required
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 Appointment Number
Max use 1
Optional
REF
150
Reference Identification Bill of Lading Number or Master Bill of Lading
Max use 1
Optional
REF
150
Reference Identification Booking Number
Max use 1
Optional
REF
150
Reference Identification Carrier's Reference Number (PRO/Invoice)
Max use 1
Optional
REF
150
Reference Identification Routing Instruction Number
Max use 1
Optional
REF
150
Reference Identification Seller's Invoice Number
Max use 1
Optional
REF
150
Reference Identification Serial Number
Max use 1
Optional
REF
150
Reference Identification Tracking Number
Max use 1
Optional
DTM
200
Date/Time Reference Current Schedule Delivery
Max use 1
Optional
DTM
200
Date/Time Reference Current Schedule Ship
Max use 1
Optional
DTM
200
Date/Time Reference Delivery Appointment Date and Time
Max use 10
Optional
DTM
200
Date/Time Reference Estimated Delivery
Max use 1
Required
DTM
200
Date/Time Reference Estimated Departure Date or Estimated Arrival Date
Max use 1
Optional
DTM
200
Date/Time Reference Estimated Point of Discharge
Max use 1
Optional
DTM
200
Date/Time Reference Invoice
Max use 1
Optional
DTM
200
Date/Time Reference Shipped
Max use 1
Required
FOB
210
F.O.B. Related Instructions
Max use 1
Required
N1 Loop Importer
HL Loop Order
HL
010
Hierarchical Level
Max use 1
Required
PRF
050
Purchase Order Reference
Max use 1
Required
REF
150
Reference Identification Promotion/Deal Number
Max use 1
Optional
REF
150
Reference Identification Vendor ID Number
Max use 1
Required
HL Loop Shipping Tare
HL
010
Hierarchical Level
Max use 1
Required
MAN
190
Marks and Numbers
Max use 1
Required
DTM
200
Date/Time Reference Date Packed
Max use 1
Optional
DTM
200
Date/Time Reference Expiration
Max use 10
Optional
DTM
200
Date/Time Reference Production
Max use 1
Optional
DTM
200
Date/Time Reference Shelf Life Expiration
Max use 1
Optional
PAL
215
Pallet Information
Max use 1
Required
GE
-
Functional Group Trailer
Max use 1
Required
IEA
-
Interchange Control Trailer
Max use 1
Required
ISA

Interchange Control Header

RequiredMax use 1

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

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

Code to identify the type of information in the Authorization Information

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

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

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

Code to identify the type of information in the Security Information

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

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

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

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

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

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

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

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

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

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

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

Date of the interchange

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

Time of the interchange

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

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

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

This version number covers the interchange control segments

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

A control number assigned by the interchange sender

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

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

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

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

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

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

>
Component Element Separator

Functional Group Header

RequiredMax use 1

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

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

Code identifying a group of application related transaction sets

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

Usage notes

Example: BSN00123456789123456789201512041429000133

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

Code identifying purpose of transaction set

00
Original
01
Cancellation
05
Replace
17
Cancel, to be Reissued
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
Required
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

0001
Shipment, Order, Packaging, Item

SOPI
SOIP
SOTI
SOTPI

BSN-06
640
Transaction Type Code
Optional
Identifier (ID)

Code specifying the type of transaction

  • BSN06 is limited to shipment related codes.
  • BSN06 and BSN07 differentiate the functionality of use for the transaction set.
33
Normal
AD
Notice of Availability
AS
Shipment Advice
DT
Detail
ZW
Sort and Segregate Detail
Heading end

Detail

HL Loop Shipment
RequiredMax >1
Usage notes

Example: HL*1**S

HL
010
Detail > HL Loop Shipment > 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 Shipment > TD1

Carrier Details (Quantity and Weight)

RequiredMax use 20

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

Usage notes

Example: TD1CTN5500*G25166*LB14CF

Example
TD1-01
103
Packaging Code
Required
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/1
CTN
Carton
PLT
Pallet
TD1-02
80
Lading Quantity
Required
Numeric (N0)
Min 1Max 7

Number of units (pieces) of the lading commodity

TD1-06
187
Weight Qualifier
Required
Identifier (ID)

Code defining the type of weight

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

Numeric value of weight

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

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

Value of volumetric measure

TD1-10
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

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

Carrier Details (Routing Sequence/Transit Time)

RequiredMax use 12

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

Usage notes

Example: TD5B2FEXFMFEDEX FREIGHTCC***CD4*01

Example
If Transit Time Direction Qualifier (TD5-10) is present, then Transit Time (TD5-11) is required
TD5-01
133
Routing Sequence Code
Optional
Identifier (ID)
Min 1Max 2

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

TD5-02
66
Identification Code Qualifier
Required
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
Required
String (AN)
Min 2Max 80

Code identifying a party or other code

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

Code specifying the method or type of transportation for the shipment

A
Air
D
Parcel Post
LT
Less Than Trailer Load (LTL)
M
Motor (Common Carrier)
S
Ocean
X
Intermodal (Piggyback)
TD5-05
387
Routing
Required
String (AN)
Min 1Max 35

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

TD5-06
368
Shipment/Order Status Code
Required
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)
CM
Shipment Complete with Additional Quantity
CP
Partial Shipment on (Date), Considered No Backorder
TD5-10
732
Transit Time Direction Qualifier
Optional
Identifier (ID)

Code specifying the value of time used to measure the transit time

Usage notes

Mandatory for Import Shipments

CD
Calendar Days (Includes weekends and Holidays)
HO
Hours
TD5-11
733
Transit Time
Optional
Decimal number (R)
Min 1Max 4

The numeric amount of transit time

Usage notes

Mandatory for Import Shipments

TD5-12
284
Service Level Code
Optional
Identifier (ID)
Min 2Max 2

Code indicating the level of transportation service or the billing service offered by the transportation carrier

Usage notes

Mandatory for Small Package and Drop Shipments

TD3
130
Detail > HL Loop Shipment > TD3

Carrier Details (Equipment)

OptionalMax use 12

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

Usage notes

Example: TD320FEXF1212121212*****11111

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

Code identifying type of equipment used for shipment

2B
20 ft. IL Container (Closed Top)
4B
40 ft. IL Container (Closed Top)
20
20 ft. IL Container (Open Top)
40
40 ft. IL Container (Open Top)
CN
Container
CZ
Refrigerated Container
HC
Hopper Car (Covered)
TF
Trailer, Dry Freight
TL
Trailer (not otherwise specified)
TW
Trailer, Refrigerated
TD3-02
206
Equipment Initial
Optional
String (AN)
Min 1Max 4

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

TD3-03
207
Equipment Number
Required
String (AN)
Min 1Max 10

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

TD3-09
225
Seal Number
Optional
String (AN)
Min 2Max 15

Unique number on seal used to close a shipment

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

Code identifying equipment type

TD4
140
Detail > HL Loop Shipment > 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

Usage notes

Example: TD4HMD3248LIQUID INFLAMMABLE

Example
If Hazardous Material Code Qualifier (TD4-02) is present, then Hazardous Material Class Code (TD4-03) is required
TD4-01
152
Special Handling Code
Required
Identifier (ID)

Code specifying special transportation handling instructions

CCH
Certification
HM
Endorsed as Hazardous Material
TD4-02
208
Hazardous Material Code Qualifier
Optional
Identifier (ID)

Code which qualifies the Hazardous Material Class Code (209)

D
Hazardous Materials ID, DOT
X
Hazard Class or Division
TD4-03
209
Hazardous Material Class Code
Optional
String (AN)
Min 1Max 4

Code specifying the kind of hazard for a material

TD4-04
352
Description
Required
String (AN)
Min 1Max 80

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

REF
150
Detail > HL Loop Shipment > REF

Reference Identification Appointment Number

OptionalMax use 1

To specify identifying information

Usage notes

Example: REFAO444555666

Example
Variants (all may be used)
REFReference Identification Bill of Lading Number or Master Bill of LadingREFReference Identification Booking NumberREFReference Identification Carrier's Reference Number (PRO/Invoice)REFReference Identification Routing Instruction NumberREFReference Identification Seller's Invoice NumberREFReference Identification Serial NumberREFReference Identification Tracking Number
REF-01
128
Reference Identification Qualifier
Required
Identifier (ID)

Code qualifying the Reference Identification

AO
Appointment Number
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

REF
150
Detail > HL Loop Shipment > REF

Reference Identification Bill of Lading Number or Master Bill of Lading

OptionalMax use >1

To specify identifying information

Usage notes

Example: REFBM123123123123123

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

Code qualifying the Reference Identification

BM
Bill of Lading Number
MB
Master Bill of Lading
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

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

Code qualifying the Reference Identification

BN
Booking Number
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

Usage notes

Ocean Booking Number

REF
150
Detail > HL Loop Shipment > REF

Reference Identification Carrier's Reference Number (PRO/Invoice)

OptionalMax use 1

To specify identifying information

Usage notes

Mandatory segment for LTL Shipments.

Example: REFCN3546565431654313

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
Required
String (AN)
Min 1Max 30

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

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

Code qualifying the Reference Identification

Usage notes

TMS Load Number (Mandatory for shipments which are tendered to and handled by Costco Fleet).

S5
Routing Instruction Number
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

Usage notes

TMS Load Number (created in Costco TMS system).

REF
150
Detail > HL Loop Shipment > REF

Reference Identification Seller's Invoice Number

OptionalMax use 1

To specify identifying information

Usage notes

Mandatory segment for shipments that contain meat and other items regulated by Country of Origin Labeling(COOL) requirements.

Example: REFIV155882

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

Code qualifying the Reference Identification

IV
Seller's Invoice Number
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

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

Code qualifying the Reference Identification

SE
Serial Number
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

Usage notes

Temperature Recorder Serial Number

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

Code qualifying the Reference Identification

2I
Tracking Number
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

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

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

Usage notes

Please Use UTC Time

Example: DTM06720151204*1429370

067
Current Schedule Delivery
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)

DTM
200
Detail > HL Loop Shipment > DTM

Date/Time Reference Current Schedule Ship

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Example: DTM06820151204*1429370

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

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

068
Current Schedule Ship
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)

DTM
200
Detail > HL Loop Shipment > DTM

Date/Time Reference Delivery Appointment Date and Time

OptionalMax use 10

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for shipments that require an appointment number (REF01 = AO).

Example: DTM70420151204*142901

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

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

704
Delivery Appointment Date and Time
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)

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

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

017
Estimated Delivery
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)

DTM
200
Detail > HL Loop Shipment > DTM

Date/Time Reference Estimated Departure Date or Estimated Arrival Date

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for Import Shipments.

Example: DTM36920151202*142937

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

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

369
Estimated Departure Date
371
Estimated Arrival Date
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)

DTM
200
Detail > HL Loop Shipment > DTM

Date/Time Reference Estimated Point of Discharge

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for Import Shipments.

Example: DTMAA220151202*1429370

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

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

AA2
Estimated Point of Discharge
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)

DTM
200
Detail > HL Loop Shipment > DTM

Date/Time Reference Invoice

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for shipments that contain meat and other items regulated by Country of Origin Labeling(COOL) requirements (REF01 = IV).

Example: DTM00320151201*14293700

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

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

003
Invoice
Required
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-01
374
Date/Time Qualifier
Required
Identifier (ID)

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

011
Shipped
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)

FOB
210
Detail > HL Loop Shipment > FOB

F.O.B. Related Instructions

RequiredMax use 1

To specify transportation instructions relating to shipment

Usage notes

Example: FOBCCDL*01EXS

Example
If Transportation Terms Qualifier Code (FOB-04) is present, then Transportation Terms Code (FOB-05) is required
FOB-01
146
Shipment Method of Payment
Required
Identifier (ID)

Code identifying payment terms for transportation charges

  • FOB01 indicates which party will pay the carrier.
CC
Collect
PP
Prepaid (by Seller)
FOB-02
309
Location Qualifier
Optional
Identifier (ID)

Code identifying type of location

  • FOB02 is the code specifying transportation responsibility location.
Usage notes

Mandatory for Import Shipments

DL
Delivery Location
FOB-04
334
Transportation Terms Qualifier Code
Optional
Identifier (ID)

Code identifying the source of the transportation terms

Usage notes

Mandatory for Import Shipments

01
Incoterms
FOB-05
335
Transportation Terms Code
Optional
Identifier (ID)

Code identifying the trade terms which apply to the shipment transportation responsibility

Usage notes

Mandatory for Import Shipments

EXS
Ex Ship
EXW
Ex Works
FAS
Free Alongside Ship
FCA
Free Carrier
FCI
Freight Carriage and Insurance Paid To
FCP
Freight Carriage Paid To
FOB
Free on Board

Mandatory for Import Shipments

N1 Loop Consignee or Ship To
RequiredMax 1
N1
220
Detail > HL Loop Shipment > N1 Loop Consignee or Ship To > N1

Name

RequiredMax use 1

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

Usage notes

Example: N1STCOSTCO9200960

Example
N1-01
98
Entity Identifier Code
Required
Identifier (ID)

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

CN
Consignee
ST
Ship To
Required
String (AN)
Min 1Max 60

Free-form name

N1-03
66
Identification Code Qualifier
Required
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
92
Assigned by Buyer or Buyer's Agent
N1-04
67
Identification Code
Required
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

Costco Facility ID (Depot ID #, CWI #, etc.) or Customs Importer of Record #.

N3
240
Detail > HL Loop Shipment > N1 Loop Consignee or Ship To > N3

Address Information

RequiredMax use 2

To specify the location of the named party

Usage notes

Example: N3456 EASIER STREETDOOR 2

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 Shipment > N1 Loop Consignee or Ship To > N4

Geographic Location

RequiredMax use 1

To specify the geographic place of the named party

Usage notes

Example: N4MIRA LOMACA917520000USA

Example
N4-01
19
City Name
Required
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
Required
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
Required
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
Required
Identifier (ID)
Min 2Max 3

Code identifying the country

N1 Loop Consignee or Ship To end
N1 Loop Importer
OptionalMax 1
N1
220
Detail > HL Loop Shipment > N1 Loop Importer > N1

Name

RequiredMax use 1

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

Usage notes

Mandatory segment for Import Shipments.

Example: N1IMIMPORTER NAME

Example
N1-01
98
Entity Identifier Code
Required
Identifier (ID)

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

IM
Importer
Required
String (AN)
Min 1Max 60

Free-form name

N1 Loop Importer end
N1 Loop Manufacturer of Goods
OptionalMax 1
N1
220
Detail > HL Loop Shipment > N1 Loop Manufacturer of Goods > N1

Name

RequiredMax use 1

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

Usage notes

Mandatory segment for Import Shipments.

Example: N1MFMANUFACTURER NAME91987654

Example
N1-01
98
Entity Identifier Code
Required
Identifier (ID)

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

MF
Manufacturer of Goods
Required
String (AN)

Free-form name

Costco
Costco
N1-03
66
Identification Code Qualifier
Required
Identifier (ID)

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

91
Assigned by Seller or Seller's Agent
UL
UCC/EAN Location Code
N1-04
67
Identification Code
Required
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.
N3
240
Detail > HL Loop Shipment > N1 Loop Manufacturer of Goods > N3

Address Information

OptionalMax use 2

To specify the location of the named party

Usage notes

Example: N3456 EASIER STREETDOOR 2

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 Shipment > N1 Loop Manufacturer of Goods > N4

Geographic Location

OptionalMax use 1

To specify the geographic place of the named party

Usage notes

Example: N4MIRA LOMACA917520000USA

Example
N4-01
19
City Name
Required
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
Required
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
Required
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
Required
Identifier (ID)
Min 2Max 3

Code identifying the country

N1 Loop Manufacturer of Goods end
N1 Loop Ship From
RequiredMax >1
N1
220
Detail > HL Loop Shipment > N1 Loop Ship From > N1

Name

RequiredMax use 1

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

Usage notes

Example: N1SFVENDOR NAME95555555554444

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

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

SF
Ship From
Required
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
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.
N3
240
Detail > HL Loop Shipment > N1 Loop Ship From > N3

Address Information

RequiredMax use 2

To specify the location of the named party

Usage notes

Example: N31234 EASY STREETDOOR 6

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 Shipment > N1 Loop Ship From > N4

Geographic Location

RequiredMax use 1

To specify the geographic place of the named party

Usage notes

Example: N4MILWAUKEEWI53201USA

Example
N4-01
19
City Name
Required
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
Required
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
Required
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
Required
Identifier (ID)
Min 2Max 3

Code identifying the country

N1 Loop Ship From end
SAC Loop
OptionalMax >1
SAC
320
Detail > HL Loop Shipment > SAC Loop > SAC

Service, Promotion, Allowance, or Charge Information

RequiredMax use 1

To request or identify a service, promotion, allowance, or charge; to specify the amount or percentage for the service, promotion, allowance, or charge

Usage notes

Example: SACCD240***300

Example
SAC-01
248
Allowance or Charge Indicator
Required
Identifier (ID)

Code which indicates an allowance or charge for the service specified

  • If SAC01 is "A" or "C", then at least one of SAC05, SAC07, or SAC08 is required.
C
Charge
SAC-02
1300
Service, Promotion, Allowance, or Charge Code
Required
Identifier (ID)

Code identifying the service, promotion, allowance, or charge

D240
Freight
H850
Tax
SAC-05
610
Amount
Required
Numeric (N2)
Min 1Max 15

Monetary amount

  • SAC05 is the total amount for the service, promotion, allowance, or charge.
  • If SAC05 is present with SAC07 or SAC08, then SAC05 takes precedence.
SAC Loop end
V1 Loop
OptionalMax >1
V1
360
Detail > HL Loop Shipment > V1 Loop > V1

Vessel Identification

RequiredMax use 1

To provide vessel details and voyage number

Usage notes

Mandatory segment for Import Shipments.

Example: V188888888VESSEL NAMEUSA2222222222

Example
V1-01
597
Vessel Code
Required
Identifier (ID)
Min 1Max 8

Code identifying vessel

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

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

V1-03
26
Country Code
Required
Identifier (ID)
Min 2Max 3

Code identifying the country

  • V103 is the code identifying the country in which the ship (vessel) is registered.
V1-04
55
Flight/Voyage Number
Required
String (AN)
Min 2Max 10

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

Usage notes

Voyage Number (Ocean), Flight Number (Air), Truck Number (Cross Border).

R4
370
Detail > HL Loop Shipment > V1 Loop > R4

Port or Terminal Origin (Operational)

OptionalMax use >1

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

Usage notes

Mandatory segment for Import Shipments.

Example: R4OUN*CCPPP

Example
R4-01
115
Port or Terminal Function Code
Required
Identifier (ID)

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

O
Origin (Operational)
R4-02
309
Location Qualifier
Required
Identifier (ID)

Code identifying type of location

IA
International Air Transport Association (IATA) Location Qualifier
UN
United Nations Location Code (UNLOCODE)
R4-03
310
Location Identifier
Required
String (AN)
Min 1Max 30

Code which identifies a specific location

R4
370
Detail > HL Loop Shipment > V1 Loop > R4

Port or Terminal Port of Discharge (Operational)

OptionalMax use 1

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

Usage notes

Mandatory segment for Import Shipments.

Example: R4DUN*CCPPP

Example
R4-01
115
Port or Terminal Function Code
Required
Identifier (ID)

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

D
Port of Discharge (Operational)
R4-02
309
Location Qualifier
Required
Identifier (ID)

Code identifying type of location

IA
International Air Transport Association (IATA) Location Qualifier
UN
United Nations Location Code (UNLOCODE)
R4-03
310
Location Identifier
Required
String (AN)
Min 1Max 30

Code which identifies a specific location

R4
370
Detail > HL Loop Shipment > V1 Loop > R4

Port or Terminal Port of Entry (Operational)

OptionalMax use 1

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

Usage notes

Mandatory segment for Import Shipments.

Example: R4GUN*CCPPP

Example
R4-01
115
Port or Terminal Function Code
Required
Identifier (ID)

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

G
Port of Entry (Operational)
R4-02
309
Location Qualifier
Required
Identifier (ID)

Code identifying type of location

IA
International Air Transport Association (IATA) Location Qualifier
UN
United Nations Location Code (UNLOCODE)
R4-03
310
Location Identifier
Required
String (AN)
Min 1Max 30

Code which identifies a specific location

R4
370
Detail > HL Loop Shipment > V1 Loop > R4

Port or Terminal Port of Loading (Operational)

OptionalMax use 1

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

Usage notes

Mandatory segment for Import Shipments.

Example: R4LUN*CCPPP

Example
R4-01
115
Port or Terminal Function Code
Required
Identifier (ID)

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

L
Port of Loading (Operational)
R4-02
309
Location Qualifier
Required
Identifier (ID)

Code identifying type of location

IA
International Air Transport Association (IATA) Location Qualifier
UN
United Nations Location Code (UNLOCODE)
R4-03
310
Location Identifier
Required
String (AN)
Min 1Max 30

Code which identifies a specific location

V1 Loop end
HL Loop Order
RequiredMax >1
Usage notes

Example: HL21*O

HL
010
Detail > HL Loop Shipment > 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 Shipment > HL Loop Order > PRF

Purchase Order Reference

RequiredMax use 1

To provide reference to a specific purchase order

Usage notes

Example: PRF333555999**20151130

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

Identifying number for Purchase Order assigned by the orderer/purchaser

Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

  • PRF04 is the date assigned by the purchaser to purchase order.
REF
150
Detail > HL Loop Shipment > HL Loop Order > REF

Reference Identification Promotion/Deal Number

OptionalMax use 1

To specify identifying information

Usage notes

Example: REFPD777777777

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

Code qualifying the Reference Identification

PD
Promotion/Deal Number
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

REF
150
Detail > HL Loop Shipment > HL Loop Order > REF

Reference Identification Vendor ID Number

RequiredMax use >1

To specify identifying information

Usage notes

Example: REFVR0010013321

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

Code qualifying the Reference Identification

VR
Vendor ID Number
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

N1 Loop Established Location
OptionalMax 1
N1
220
Detail > HL Loop Shipment > HL Loop Order > N1 Loop Established Location > N1

Name

RequiredMax use 1

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

Usage notes

Mandatory segment for shipments that contain meat or other items regulated by Country of Origin Labeling(COOL) requirements.

Example: N1ELESTABLISHED LOCATION NAME97777777774444

Example
N1-01
98
Entity Identifier Code
Required
Identifier (ID)

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

EL
Established Location
Required
String (AN)
Min 1Max 60

Free-form name

N1-03
66
Identification Code Qualifier
Required
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
Required
String (AN)
Min 2Max 80

Code identifying a party or other code

  • This segment, used alone, provides the most efficient method of providing organizational identification. To obtain this efficiency the "ID Code" (N104) must provide a key to the table maintained by the transaction processing party.
N1 Loop Established Location end
N1 Loop Manufacturing Plant
OptionalMax >1
N1
220
Detail > HL Loop Shipment > HL Loop Order > N1 Loop Manufacturing Plant > N1

Name

RequiredMax use 1

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

Usage notes

Mandatory segment for shipments that contain meat or other items regulated by Country of Origin Labeling(COOL) requirements.

Example: N1MPMANUFACTURING PLANT NAME96666666664444

Example
N1-01
98
Entity Identifier Code
Required
Identifier (ID)

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

MP
Manufacturing Plant
Required
String (AN)
Min 1Max 60

Free-form name

N1-03
66
Identification Code Qualifier
Required
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
Required
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.
N3
240
Detail > HL Loop Shipment > HL Loop Order > N1 Loop Manufacturing Plant > N3

Address Information

OptionalMax use 2

To specify the location of the named party

Usage notes

Mandatory segment for shipments that contain meat or other items regulated by Country of Origin Labeling(COOL) requirements.

Example: N3987 EASIEST STREETBLDG 2

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 Shipment > HL Loop Order > N1 Loop Manufacturing Plant > N4

Geographic Location

OptionalMax use 1

To specify the geographic place of the named party

Usage notes

Mandatory segment for shipments that contain meat or other items regulated by Country of Origin Labeling(COOL) requirements.

Example: N4WAUKESHAWI531860002USA

Example
N4-01
19
City Name
Required
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
Required
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
Required
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
Required
Identifier (ID)
Min 2Max 3

Code identifying the country

N1 Loop Manufacturing Plant end
N1 Loop Mutually Defined
OptionalMax 1
N1
220
Detail > HL Loop Shipment > HL Loop Order > N1 Loop Mutually Defined > N1

Name

RequiredMax use 1

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

Usage notes

Example: N1ZZFARMER JOE FIELD A91987654

Example
N1-01
98
Entity Identifier Code
Required
Identifier (ID)

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

ZZ
Mutually Defined

Growing Area GPS - FDA requirement

Required
String (AN)
Min 1Max 60

Free-form name

N1-03
66
Identification Code Qualifier
Required
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
91
Assigned by Seller or Seller's Agent
UL
UCC/EAN Location Code
UR
Uniform Resource Locator (URL)
N1-04
67
Identification Code
Required
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.
N3
240
Detail > HL Loop Shipment > HL Loop Order > N1 Loop Mutually Defined > N3

Address Information

OptionalMax use 2

To specify the location of the named party

Usage notes

Example: N3234 EASY STREETLEFT SIDE

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 Shipment > HL Loop Order > N1 Loop Mutually Defined > N4

Geographic Location

OptionalMax use 1

To specify the geographic place of the named party

Usage notes

Example: N4SmithfieldVA23430USA2836.9824N76.6311W

Example
N4-01
19
City Name
Required
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
Required
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
Required
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
Required
Identifier (ID)
Min 2Max 3

Code identifying the country

N4-05
309
Location Qualifier
Required
Identifier (ID)

Code identifying type of location

28
Latitude-Longitude Source
N4-06
310
Location Identifier
Required
String (AN)
Min 1Max 30

Code which identifies a specific location

PER
270
Detail > HL Loop Shipment > HL Loop Order > N1 Loop Mutually Defined > PER

Administrative Communications Contact

OptionalMax use 3

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

Usage notes

Example: PERICFRED FARMERTE5065561234

Example
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
Required
String (AN)
Min 1Max 60

Free-form name

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

Code identifying the type of communication number

EM
Electronic Mail
TE
Telephone
PER-04
364
Communication Number
Required
String (AN)
Min 1Max 80

Complete communications number including country or area code when applicable

N1 Loop Mutually Defined end
HL Loop Item
OptionalMax >1
Usage notes

Example: HL54*I

Variants (all may be used)
HL Loop PackHL Loop Shipping Tare
HL
010
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > 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.
1
Additional Subordinate HL Data Segment in This Hierarchical Structure.
LIN
020
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > LIN

Item Identification

RequiredMax use 1

To specify basic item identification data

Usage notes

Example: LIN0001IN123456VNBG112233CHCNUK12233333444445LT314GEBANGLECLGOLDSZL1UQ*1606

Example
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-10) or Product/Service ID (LIN-11) is present, then the other is required
If either Product/Service ID Qualifier (LIN-12) or Product/Service ID (LIN-13) is present, then the other is required
If either Product/Service ID Qualifier (LIN-14) or Product/Service ID (LIN-15) is present, then the other is required
If either Product/Service ID Qualifier (LIN-16) or Product/Service ID (LIN-17) is present, then the other is required
If either Product/Service ID Qualifier (LIN-18) or Product/Service ID (LIN-19) is present, then the other is required
LIN-01
350
Assigned Identification
Optional
String (AN)
Min 1Max 20

Alphanumeric characters assigned for differentiation within a transaction set

  • LIN01 is the line item identification
Usage notes

Costco purchase order line number.

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

Costco item number.

LIN-04
235
Product/Service ID Qualifier
Required
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
Required
String (AN)
Min 1Max 48

Identifying number for a product or service

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)

Usage notes

Mandatory for Imports, Jewelry, Optical and Furniture.

CH
Country of Origin Code
LIN-07
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

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

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

UK
U.P.C./EAN Shipping Container Code (1-2-5-5-1)
UP
U.P.C. Consumer Package Code (1-5-5-1)
LIN-09
234
Product/Service ID
Required
String (AN)
Min 1Max 48

Identifying number for a product or service

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

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

Usage notes

Should be included for items like tobacco, candy, food, liquor, bakery and produce.

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

Identifying number for a product or service

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

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

Usage notes

Mandatory for items that are regulated by Country of Origin Labeling (COOL) requirements.

GE
Generic Name Description
LIN-13
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

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

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

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

Identifying number for a product or service

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

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

SZ
Vendor Alphanumeric Size Code (NRMA)
LIN-17
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

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

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

Usage notes

Mandatory for HazMat Shipments.

UQ
United Nations (UN) Number (Dangerous Goods)
LIN-19
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

SN1
030
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > SN1

Item Detail (Shipment)

OptionalMax use 1

To specify line-item detail relative to shipment

Usage notes

Example: SN1000130472*EA*****AC

Example
SN1-01
350
Assigned Identification
Optional
String (AN)
Min 1Max 20

Alphanumeric characters assigned for differentiation within a transaction set

  • SN101 is the ship notice line-item identification.
Usage notes

Mandatory for ASNs sent in SOTI structure.

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

SOTPI and SOTI structure: Number of units per pallet of the item shipped.

SOPI structure: Number of units per case of the item shipped.

SN1-03
355
Unit or Basis for Measurement Code
Required
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

  • SN103 defines the unit of measurement for both SN102 and SN104.
Usage notes

Must match the UOM on the Purchase Order.

SN1-08
668
Line Item Status Code
Optional
Identifier (ID)

Code specifying the action taken by the seller on a line item requested by the buyer

Usage notes

Mandatory for drop shipments and small packages.

AC
Item Accepted and Shipped
ID
Item Deleted
IF
Item on Hold, Incomplete Description
IR
Item Rejected
R1
Item Rejected, Not a Contract Item
R2
Item Rejected, Invalid Item Product Number
R4
Item Rejected, Contract Item not Available
PO4
060
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > PO4

Item Physical Details

OptionalMax use 1

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

Usage notes

Example: PO42764*G8238*KG21314*01*****28971

Example
Required
Numeric (N0)
Min 1Max 6

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

Usage notes

The number of inner containers/eaches per outer container. This can be defaulted to '1' if there are no inner containers per outer container.

PO4-05
187
Weight Qualifier
Required
Identifier (ID)

Code defining the type of weight

Usage notes

Mandatory for items that are measured in catch weight such as meat, fresh foods, frozen food, produce, and bakery items.

G
Gross Weight
N
Actual Net Weight
PO4-06
384
Gross Weight per Pack
Required
Decimal number (R)
Min 1Max 9

Numeric value of gross weight per pack

PO4-07
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

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

Numeric value of gross volume per pack

PO4-09
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

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

The number of eaches per inner container

Usage notes

The number of eaches per inner container.

PID
070
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > PID

Product/Item Description

OptionalMax use 200

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

Usage notes

Example: PIDFMSG***ITEM DESCRIPTION GOES HERE

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
Required
Identifier (ID)

Code identifying the general class of a product or process characteristic

GEN
General Description
MSG
Market Segment
PID-05
352
Description
Required
String (AN)
Min 1Max 80

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

Usage notes

Country of Origin Label

FDA Traceability

REF
150
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > REF

Reference Identification Destination of Shipment Harmonized-Based Code

OptionalMax use 1

To specify identifying information

Usage notes

Mandatory segment for Import Shipments.

Example: REFLY885522774411

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

Code qualifying the Reference Identification

LY
Destination of Shipment Harmonized-Based Code
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

REF
150
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > REF

Reference Identification Internal Vendor Number

RequiredMax use 1

To specify identifying information

Usage notes

Example: REFIABUYER VENDOR NUMBER

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

Code qualifying the Reference Identification

Usage notes

This must match the PO.

Please pull this from the PO in the REF*ZZ segment (Buyer Vendor Number).

IA
Internal Vendor Number
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

Usage notes

Buyer Vendor Number

REF
150
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > REF

Reference Identification Serial Number

OptionalMax use >1

To specify identifying information

Usage notes

Example: REFSE123456789

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

Code qualifying the Reference Identification

SE
Serial Number
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

REF
150
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > REF

Reference Identification Suffix

RequiredMax use 1

To specify identifying information

Usage notes

Example: REFW8BUYERSUFFIX

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

Code qualifying the Reference Identification

Usage notes

This must match the PO.

Please pull this from the PO in the REF*ZZ segment (BUYER VENDOR SUFFIX).

W8
Suffix
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

Usage notes

Buyer Vendor Suffix.

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > DTM

Date/Time Reference Collection

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM90620151204

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

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

906
Collection
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

Usage notes

Harvest Date

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > DTM

Date/Time Reference Date Packed

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM51020151205

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

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

510
Date Packed
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > DTM

Date/Time Reference Expiration

OptionalMax use 10

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM03620161203

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

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

036
Expiration
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > DTM

Date/Time Reference Production

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM40520151204

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

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

405
Production
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > DTM

Date/Time Reference Shelf Life Expiration

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM51120161202

Example
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
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

HL Loop Pack
RequiredMax >1
Usage notes

Example: HL43*P

HL
010
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > HL Loop Pack > 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.
0
No Subordinate HL Segment in This Hierarchical Structure.
LIN
020
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > HL Loop Pack > LIN

Item Identification

OptionalMax use 1

To specify basic item identification data

Usage notes

Example: LIN*IN12351

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
If either Product/Service ID Qualifier (LIN-10) or Product/Service ID (LIN-11) is present, then the other is required
LIN-01
350
Assigned Identification
Optional
String (AN)
Min 1Max 20

Alphanumeric characters assigned for differentiation within a transaction set

  • LIN01 is the line item identification
Usage notes

COSTCO PURCHASE ORDER LINE NUMBER - PO1 Line item #

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

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)

Usage notes

Mandatory for items like tobacco, candy, food, liquor, bakery and produce.

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

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)

Usage notes

Mandatory for Imports, Jewelry, Optical and Furniture.

CH
Country of Origin Code
LIN-07
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

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)

UK
U.P.C./EAN Shipping Container Code (1-2-5-5-1)
UP
U.P.C. Consumer Package Code (1-5-5-1)
LIN-09
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

LIN-10
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-11
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

SN1
030
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > HL Loop Pack > SN1

Item Detail (Shipment)

OptionalMax use 1

To specify line-item detail relative to shipment

Usage notes

Example: SN1000111253*CA

Example
SN1-01
350
Assigned Identification
Optional
String (AN)
Min 1Max 20

Alphanumeric characters assigned for differentiation within a transaction set

  • SN101 is the ship notice line-item identification.
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

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
PL
Pallet/Unit Load
PO4
060
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > HL Loop Pack > PO4

Item Physical Details

OptionalMax use 1

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

Usage notes

Example: PO424*G5.25*LB******6

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 Weight Qualifier (PO4-05) is present, then Gross Weight per Pack (PO4-06) 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
Required
Numeric (N0)
Min 1Max 6

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

Usage notes

Number of inner packs per case.

PO4-05
187
Weight Qualifier
Optional
Identifier (ID)

Code defining the type of weight

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

Numeric value of gross weight per pack

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

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

Numeric value of gross volume per pack

Usage notes

Mandatory for ASNs sent in SOPI structure.

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
Required
Numeric (N0)
Min 1Max 6

The number of eaches per inner container

Usage notes

Number of sellable units per inner pack.

MAN
190
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > HL Loop Pack > MAN

Marks and Numbers

RequiredMax use >1

To indicate identifying marks and numbers for shipping containers

Usage notes

Mandatory segment when sending Pack Level data.

Example: MANAI456456456456

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

Container shipping identifier.

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > HL Loop Pack > DTM

Date/Time Reference Date Packed

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM51020151205

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

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

510
Date Packed
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > HL Loop Pack > DTM

Date/Time Reference Expiration

OptionalMax use 10

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM03620161203

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

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

036
Expiration
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > HL Loop Pack > DTM

Date/Time Reference Production

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM40520151204

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

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

405
Production
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Item > HL Loop Pack > DTM

Date/Time Reference Shelf Life Expiration

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM51120161202

Example
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
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

HL Loop Pack end
HL Loop Item end
HL Loop Pack
OptionalMax >1
Usage notes

Example: HL43*P

Variants (all may be used)
HL Loop ItemHL Loop Shipping Tare
HL
010
Detail > HL Loop Shipment > HL Loop Order > HL Loop Pack > 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 Shipment > HL Loop Order > HL Loop Pack > LIN

Item Identification

OptionalMax use 1

To specify basic item identification data

Usage notes

Example: LIN*IN12351

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
If either Product/Service ID Qualifier (LIN-10) or Product/Service ID (LIN-11) is present, then the other is required
LIN-01
350
Assigned Identification
Optional
String (AN)
Min 1Max 20

Alphanumeric characters assigned for differentiation within a transaction set

  • LIN01 is the line item identification
Usage notes

COSTCO PURCHASE ORDER LINE NUMBER - PO1 Line item #

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

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)

Usage notes

Mandatory for items like tobacco, candy, food, liquor, bakery and produce.

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

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)

Usage notes

Mandatory for Imports, Jewelry, Optical and Furniture.

CH
Country of Origin Code
LIN-07
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

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)

UK
U.P.C./EAN Shipping Container Code (1-2-5-5-1)
UP
U.P.C. Consumer Package Code (1-5-5-1)
LIN-09
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

LIN-10
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-11
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

SN1
030
Detail > HL Loop Shipment > HL Loop Order > HL Loop Pack > SN1

Item Detail (Shipment)

OptionalMax use 1

To specify line-item detail relative to shipment

Usage notes

Example: SN1000111253*CA

Example
SN1-01
350
Assigned Identification
Optional
String (AN)
Min 1Max 20

Alphanumeric characters assigned for differentiation within a transaction set

  • SN101 is the ship notice line-item identification.
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

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
PL
Pallet/Unit Load
PO4
060
Detail > HL Loop Shipment > HL Loop Order > HL Loop Pack > PO4

Item Physical Details

OptionalMax use 1

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

Usage notes

Example: PO424*G5.25*LB******6

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 Weight Qualifier (PO4-05) is present, then Gross Weight per Pack (PO4-06) 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
Required
Numeric (N0)
Min 1Max 6

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

Usage notes

Number of inner packs per case.

PO4-05
187
Weight Qualifier
Optional
Identifier (ID)

Code defining the type of weight

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

Numeric value of gross weight per pack

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

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

Numeric value of gross volume per pack

Usage notes

Mandatory for ASNs sent in SOPI structure.

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
Required
Numeric (N0)
Min 1Max 6

The number of eaches per inner container

Usage notes

Number of sellable units per inner pack.

MAN
190
Detail > HL Loop Shipment > HL Loop Order > HL Loop Pack > MAN

Marks and Numbers

RequiredMax use >1

To indicate identifying marks and numbers for shipping containers

Usage notes

Mandatory segment when sending Pack Level data.

Example: MANAI456456456456

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

Container shipping identifier.

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Pack > DTM

Date/Time Reference Date Packed

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM51020151205

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

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

510
Date Packed
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Pack > DTM

Date/Time Reference Expiration

OptionalMax use 10

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM03620161203

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

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

036
Expiration
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Pack > DTM

Date/Time Reference Production

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM40520151204

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

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

405
Production
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Pack > DTM

Date/Time Reference Shelf Life Expiration

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM51120161202

Example
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
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

HL Loop Item
RequiredMax >1
Usage notes

Example: HL54*I

HL
010
Detail > HL Loop Shipment > HL Loop Order > HL Loop Pack > HL Loop Item > 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 Shipment > HL Loop Order > HL Loop Pack > HL Loop Item > LIN

Item Identification

RequiredMax use 1

To specify basic item identification data

Usage notes

Example: LIN0001IN123456VNBG112233CHCNUK12233333444445LT314GEBANGLECLGOLDSZL1UQ*1606

Example
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-10) or Product/Service ID (LIN-11) is present, then the other is required
If either Product/Service ID Qualifier (LIN-12) or Product/Service ID (LIN-13) is present, then the other is required
If either Product/Service ID Qualifier (LIN-14) or Product/Service ID (LIN-15) is present, then the other is required
If either Product/Service ID Qualifier (LIN-16) or Product/Service ID (LIN-17) is present, then the other is required
If either Product/Service ID Qualifier (LIN-18) or Product/Service ID (LIN-19) is present, then the other is required
LIN-01
350
Assigned Identification
Optional
String (AN)
Min 1Max 20

Alphanumeric characters assigned for differentiation within a transaction set

  • LIN01 is the line item identification
Usage notes

Costco purchase order line number.

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

Costco item number.

LIN-04
235
Product/Service ID Qualifier
Required
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
Required
String (AN)
Min 1Max 48

Identifying number for a product or service

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)

Usage notes

Mandatory for Imports, Jewelry, Optical and Furniture.

CH
Country of Origin Code
LIN-07
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

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

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

UK
U.P.C./EAN Shipping Container Code (1-2-5-5-1)
UP
U.P.C. Consumer Package Code (1-5-5-1)
LIN-09
234
Product/Service ID
Required
String (AN)
Min 1Max 48

Identifying number for a product or service

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

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

Usage notes

Should be included for items like tobacco, candy, food, liquor, bakery and produce.

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

Identifying number for a product or service

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

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

Usage notes

Mandatory for items that are regulated by Country of Origin Labeling (COOL) requirements.

GE
Generic Name Description
LIN-13
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

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

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

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

Identifying number for a product or service

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

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

SZ
Vendor Alphanumeric Size Code (NRMA)
LIN-17
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

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

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

Usage notes

Mandatory for HazMat Shipments.

UQ
United Nations (UN) Number (Dangerous Goods)
LIN-19
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

SN1
030
Detail > HL Loop Shipment > HL Loop Order > HL Loop Pack > HL Loop Item > SN1

Item Detail (Shipment)

OptionalMax use 1

To specify line-item detail relative to shipment

Usage notes

Example: SN1000130472*EA*****AC

Example
SN1-01
350
Assigned Identification
Optional
String (AN)
Min 1Max 20

Alphanumeric characters assigned for differentiation within a transaction set

  • SN101 is the ship notice line-item identification.
Usage notes

Mandatory for ASNs sent in SOTI structure.

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

SOTPI and SOTI structure: Number of units per pallet of the item shipped.

SOPI structure: Number of units per case of the item shipped.

SN1-03
355
Unit or Basis for Measurement Code
Required
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

  • SN103 defines the unit of measurement for both SN102 and SN104.
Usage notes

Must match the UOM on the Purchase Order.

SN1-08
668
Line Item Status Code
Optional
Identifier (ID)

Code specifying the action taken by the seller on a line item requested by the buyer

Usage notes

Mandatory for drop shipments and small packages.

AC
Item Accepted and Shipped
ID
Item Deleted
IF
Item on Hold, Incomplete Description
IR
Item Rejected
R1
Item Rejected, Not a Contract Item
R2
Item Rejected, Invalid Item Product Number
R4
Item Rejected, Contract Item not Available
PO4
060
Detail > HL Loop Shipment > HL Loop Order > HL Loop Pack > HL Loop Item > PO4

Item Physical Details

OptionalMax use 1

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

Usage notes

Example: PO42764*G8238*KG21314*01*****28971

Example
Required
Numeric (N0)
Min 1Max 6

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

Usage notes

The number of inner containers/eaches per outer container. This can be defaulted to '1' if there are no inner containers per outer container.

PO4-05
187
Weight Qualifier
Required
Identifier (ID)

Code defining the type of weight

Usage notes

Mandatory for items that are measured in catch weight such as meat, fresh foods, frozen food, produce, and bakery items.

G
Gross Weight
N
Actual Net Weight
PO4-06
384
Gross Weight per Pack
Required
Decimal number (R)
Min 1Max 9

Numeric value of gross weight per pack

PO4-07
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

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

Numeric value of gross volume per pack

PO4-09
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

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

The number of eaches per inner container

Usage notes

The number of eaches per inner container.

PID
070
Detail > HL Loop Shipment > HL Loop Order > HL Loop Pack > HL Loop Item > PID

Product/Item Description

OptionalMax use 200

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

Usage notes

Example: PIDFMSG***ITEM DESCRIPTION GOES HERE

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
Required
Identifier (ID)

Code identifying the general class of a product or process characteristic

GEN
General Description
MSG
Market Segment
PID-05
352
Description
Required
String (AN)
Min 1Max 80

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

Usage notes

Country of Origin Label

FDA Traceability

REF
150
Detail > HL Loop Shipment > HL Loop Order > HL Loop Pack > HL Loop Item > REF

Reference Identification Destination of Shipment Harmonized-Based Code

OptionalMax use 1

To specify identifying information

Usage notes

Mandatory segment for Import Shipments.

Example: REFLY885522774411

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

Code qualifying the Reference Identification

LY
Destination of Shipment Harmonized-Based Code
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

REF
150
Detail > HL Loop Shipment > HL Loop Order > HL Loop Pack > HL Loop Item > REF

Reference Identification Internal Vendor Number

RequiredMax use 1

To specify identifying information

Usage notes

Example: REFIABUYER VENDOR NUMBER

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

Code qualifying the Reference Identification

Usage notes

This must match the PO.

Please pull this from the PO in the REF*ZZ segment (Buyer Vendor Number).

IA
Internal Vendor Number
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

Usage notes

Buyer Vendor Number

REF
150
Detail > HL Loop Shipment > HL Loop Order > HL Loop Pack > HL Loop Item > REF

Reference Identification Serial Number

OptionalMax use >1

To specify identifying information

Usage notes

Example: REFSE123456789

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

Code qualifying the Reference Identification

SE
Serial Number
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

REF
150
Detail > HL Loop Shipment > HL Loop Order > HL Loop Pack > HL Loop Item > REF

Reference Identification Suffix

RequiredMax use 1

To specify identifying information

Usage notes

Example: REFW8BUYERSUFFIX

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

Code qualifying the Reference Identification

Usage notes

This must match the PO.

Please pull this from the PO in the REF*ZZ segment (BUYER VENDOR SUFFIX).

W8
Suffix
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

Usage notes

Buyer Vendor Suffix

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Pack > HL Loop Item > DTM

Date/Time Reference Collection

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM90620151204

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

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

906
Collection
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

Usage notes

Harvest date

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Pack > HL Loop Item > DTM

Date/Time Reference Date Packed

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM51020151205

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

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

510
Date Packed
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Pack > HL Loop Item > DTM

Date/Time Reference Expiration

OptionalMax use 10

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM03620161203

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

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

036
Expiration
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Pack > HL Loop Item > DTM

Date/Time Reference Production

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM40520151204

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

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

405
Production
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Pack > HL Loop Item > DTM

Date/Time Reference Shelf Life Expiration

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM51120161202

Example
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
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

HL Loop Item end
HL Loop Pack end
HL Loop Shipping Tare
OptionalMax >1
Usage notes

Example: HL31*T

Variants (all may be used)
HL Loop ItemHL Loop Pack
HL
010
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > 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.
0
No Subordinate HL Segment in This Hierarchical Structure.
1
Additional Subordinate HL Data Segment in This Hierarchical Structure.
MAN
190
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > MAN

Marks and Numbers

RequiredMax use >1

To indicate identifying marks and numbers for shipping containers

Usage notes

Mandatory segment when sending Tare Level data.

Example: MANAI112233445566778899*W1

Example
If either Marks and Numbers Qualifier (MAN-04) or Marks and Numbers (MAN-05) is present, then the other is required
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
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-04
88
Marks and Numbers Qualifier
Optional
Identifier (ID)

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

SI
Self-Identifying Container via Radio Frequency ID Device
W
Pallet Number
MAN-05
87
Marks and Numbers
Optional
String (AN)
Min 1Max 48

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

  • When both MAN05 and MAN06 are used, MAN05 is the starting number of a sequential range, and MAN06 is the ending number of that range.
DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > DTM

Date/Time Reference Date Packed

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM51020151204

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

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

510
Date Packed
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > DTM

Date/Time Reference Expiration

OptionalMax use 10

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM03620161201

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

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

036
Expiration
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > DTM

Date/Time Reference Production

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM40520151204

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

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

405
Production
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > DTM

Date/Time Reference Shelf Life Expiration

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM51120161201

Example
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
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

PAL
215
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > PAL

Pallet Information

RequiredMax 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

Usage notes

Mandatory segment when sending Tare Level data.

Example: PAL122412315LB51587460IN

Example
PAL-01
883
Pallet Type Code
Required
Identifier (ID)
Min 1Max 2

Code indicating the type of pallet

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

The number of layers per pallet

PAL-03
885
Pallet Blocks
Required
Numeric (N0)
Min 1Max 3

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

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

Number of sell units by pallet.

PAL-05
395
Unit Weight
Required
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
Required
Identifier (ID)

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

KG
Kilogram
LB
Pound
PAL-07
82
Length
Required
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.
Required
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
Required
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
Required
Identifier (ID)

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

IN
Inch
N1 Loop
OptionalMax >1
N1
220
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > N1 Loop > N1

Name

RequiredMax use 1

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

Usage notes

Mandatory segment for pre-sorted pallets.

Example: N1MAULTIMATE PARTY9200960

Example
N1-01
98
Entity Identifier Code
Required
Identifier (ID)

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

MA
Party for whom Item is Ultimately Intended
Required
String (AN)
Min 1Max 60

Free-form name

N1-03
66
Identification Code Qualifier
Required
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
Required
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

"Mark For" ID, i.e., the final node of consumption (warehouse number).

N1 Loop end
HL Loop Item
OptionalMax >1
Usage notes

Example: HL54*I

Variants (all may be used)
HL Loop Pack
HL
010
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Item > 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 Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Item > LIN

Item Identification

RequiredMax use 1

To specify basic item identification data

Usage notes

Example: LIN0001IN123456VNBG112233CHCNUK12233333444445LT314GEBANGLECLGOLDSZL1UQ*1606

Example
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-10) or Product/Service ID (LIN-11) is present, then the other is required
If either Product/Service ID Qualifier (LIN-12) or Product/Service ID (LIN-13) is present, then the other is required
If either Product/Service ID Qualifier (LIN-14) or Product/Service ID (LIN-15) is present, then the other is required
If either Product/Service ID Qualifier (LIN-16) or Product/Service ID (LIN-17) is present, then the other is required
If either Product/Service ID Qualifier (LIN-18) or Product/Service ID (LIN-19) is present, then the other is required
LIN-01
350
Assigned Identification
Optional
String (AN)
Min 1Max 20

Alphanumeric characters assigned for differentiation within a transaction set

  • LIN01 is the line item identification
Usage notes

Costco purchase order line number.

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

Costco item number.

LIN-04
235
Product/Service ID Qualifier
Required
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
Required
String (AN)
Min 1Max 48

Identifying number for a product or service

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)

Usage notes

Mandatory for Imports, Jewelry, Optical and Furniture.

CH
Country of Origin Code
LIN-07
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

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

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

UK
U.P.C./EAN Shipping Container Code (1-2-5-5-1)
UP
U.P.C. Consumer Package Code (1-5-5-1)
LIN-09
234
Product/Service ID
Required
String (AN)
Min 1Max 48

Identifying number for a product or service

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

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

Usage notes

Should be included for items like tobacco, candy, food, liquor, bakery and produce.

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

Identifying number for a product or service

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

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

Usage notes

Mandatory for items that are regulated by Country of Origin Labeling (COOL) requirements.

GE
Generic Name Description
LIN-13
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

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

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

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

Identifying number for a product or service

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

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

SZ
Vendor Alphanumeric Size Code (NRMA)
LIN-17
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

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

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

Usage notes

Mandatory for HazMat Shipments.

UQ
United Nations (UN) Number (Dangerous Goods)
LIN-19
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

SN1
030
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Item > SN1

Item Detail (Shipment)

OptionalMax use 1

To specify line-item detail relative to shipment

Usage notes

Example: SN1000130472*EA*****AC

Example
SN1-01
350
Assigned Identification
Required
String (AN)
Min 1Max 20

Alphanumeric characters assigned for differentiation within a transaction set

  • SN101 is the ship notice line-item identification.
Usage notes

Mandatory for ASNs sent in SOTI structure.

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

SOTPI and SOTI structure: Number of units per pallet of the item shipped.

SOPI structure: Number of units per case of the item shipped.

SN1-03
355
Unit or Basis for Measurement Code
Required
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

  • SN103 defines the unit of measurement for both SN102 and SN104.
Usage notes

Must match the UOM on the Purchase Order.

SN1-08
668
Line Item Status Code
Optional
Identifier (ID)

Code specifying the action taken by the seller on a line item requested by the buyer

Usage notes

Mandatory for drop shipments and small packages.

AC
Item Accepted and Shipped
ID
Item Deleted
IF
Item on Hold, Incomplete Description
IR
Item Rejected
R1
Item Rejected, Not a Contract Item
R2
Item Rejected, Invalid Item Product Number
R4
Item Rejected, Contract Item not Available
PO4
060
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Item > PO4

Item Physical Details

OptionalMax use 1

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

Usage notes

Example: PO42764*G8238*KG21314*01*****28971

Example
Required
Numeric (N0)
Min 1Max 6

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

Usage notes

The number of inner containers/eaches per outer container. This can be defaulted to '1' if there are no inner containers per outer container.

PO4-05
187
Weight Qualifier
Required
Identifier (ID)

Code defining the type of weight

Usage notes

Mandatory for items that are measured in catch weight such as meat, fresh foods, frozen food, produce, and bakery items.

G
Gross Weight
N
Actual Net Weight
PO4-06
384
Gross Weight per Pack
Required
Decimal number (R)
Min 1Max 9

Numeric value of gross weight per pack

PO4-07
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

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

Numeric value of gross volume per pack

PO4-09
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

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

The number of eaches per inner container

Usage notes

The number of eaches per inner container.

PID
070
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Item > PID

Product/Item Description

OptionalMax use 200

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

Usage notes

Example: PIDFMSG***ITEM DESCRIPTION GOES HERE

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
Required
Identifier (ID)

Code identifying the general class of a product or process characteristic

GEN
General Description
MSG
Market Segment
PID-05
352
Description
Required
String (AN)
Min 1Max 80

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

Usage notes

Country of Origin Label

FDA Traceability

REF
150
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Item > REF

Reference Identification Destination of Shipment Harmonized-Based Code

OptionalMax use 1

To specify identifying information

Usage notes

Mandatory segment for Import Shipments.

Example: REFLY885522774411

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

Code qualifying the Reference Identification

LY
Destination of Shipment Harmonized-Based Code
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

REF
150
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Item > REF

Reference Identification Internal Vendor Number

RequiredMax use 1

To specify identifying information

Usage notes

Example: REFIABUYER VENDOR NUMBER

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

Code qualifying the Reference Identification

Usage notes

This must match the PO.

Please pull this from the PO in the REF*ZZ segment (Buyer Vendor Number).

IA
Internal Vendor Number
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

Usage notes

Buyer Vendor Number

REF
150
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Item > REF

Reference Identification Serial Number

OptionalMax use >1

To specify identifying information

Usage notes

Example: REFSE123456789

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

Code qualifying the Reference Identification

SE
Serial Number
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

REF
150
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Item > REF

Reference Identification Suffix

RequiredMax use 1

To specify identifying information

Usage notes

Example: REFW8BUYERSUFFIX

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

Code qualifying the Reference Identification

Usage notes

This must match the PO.

Please pull this from the PO in the REF*ZZ segment (BUYER VENDOR SUFFIX).

W8
Suffix
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

Usage notes

Buyer Vendor Suffix

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Item > DTM

Date/Time Reference Collection

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM90620151204

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

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

906
Collection
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

Usage notes

Harvest date

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Item > DTM

Date/Time Reference Date Packed

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM51020151205

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

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

510
Date Packed
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Item > DTM

Date/Time Reference Expiration

OptionalMax use 10

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM03620161203

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

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

036
Expiration
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Item > DTM

Date/Time Reference Production

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM40520151204

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

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

405
Production
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Item > DTM

Date/Time Reference Shelf Life Expiration

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM51120161202

Example
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
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

HL Loop Item end
HL Loop Pack
OptionalMax >1
Usage notes

Example: HL43*P

Variants (all may be used)
HL Loop Item
HL
010
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > 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 Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > LIN

Item Identification

OptionalMax use 1

To specify basic item identification data

Usage notes

Example: LIN*IN12351

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
If either Product/Service ID Qualifier (LIN-10) or Product/Service ID (LIN-11) is present, then the other is required
LIN-01
350
Assigned Identification
Optional
String (AN)
Min 1Max 20

Alphanumeric characters assigned for differentiation within a transaction set

  • LIN01 is the line item identification
Usage notes

COSTCO PURCHASE ORDER LINE NUMBER - PO1 Line item #

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

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)

Usage notes

Mandatory for items like tobacco, candy, food, liquor, bakery and produce.

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

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)

Usage notes

Mandatory for Imports, Jewelry, Optical and Furniture.

CH
Country of Origin Code
LIN-07
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

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)

UK
U.P.C./EAN Shipping Container Code (1-2-5-5-1)
UP
U.P.C. Consumer Package Code (1-5-5-1)
LIN-09
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

LIN-10
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-11
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

SN1
030
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > SN1

Item Detail (Shipment)

OptionalMax use 1

To specify line-item detail relative to shipment

Usage notes

Example: SN1000111253*CA

Example
SN1-01
350
Assigned Identification
Optional
String (AN)
Min 1Max 20

Alphanumeric characters assigned for differentiation within a transaction set

  • SN101 is the ship notice line-item identification.
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

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
PL
Pallet/Unit Load
PO4
060
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > PO4

Item Physical Details

OptionalMax use 1

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

Usage notes

Example: PO424*G5.25*LB******6

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 Weight Qualifier (PO4-05) is present, then Gross Weight per Pack (PO4-06) 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
Required
Numeric (N0)
Min 1Max 6

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

Usage notes

Number of inner packs per case.

PO4-05
187
Weight Qualifier
Optional
Identifier (ID)

Code defining the type of weight

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

Numeric value of gross weight per pack

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

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

Numeric value of gross volume per pack

Usage notes

Mandatory for ASNs sent in SOPI structure.

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
Required
Numeric (N0)
Min 1Max 6

The number of eaches per inner container

Usage notes

Number of sellable units per inner pack.

MAN
190
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > MAN

Marks and Numbers

RequiredMax use >1

To indicate identifying marks and numbers for shipping containers

Usage notes

Mandatory segment when sending Pack Level data.

Example: MANAI456456456456

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

Container shipping identifier.

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > DTM

Date/Time Reference Date Packed

OptionalMax use 10

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM51020151205

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

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

510
Date Packed
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > DTM

Date/Time Reference Expiration

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM03620161203

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

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

036
Expiration
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

Usage notes

Harvest date

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > DTM

Date/Time Reference Production

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM40520151204

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

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

405
Production
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > DTM

Date/Time Reference Shelf Life Expiration

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM51120161202

Example
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
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

HL Loop Item
RequiredMax >1
Usage notes

Example: HL54*I

HL
010
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > HL Loop Item > 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 Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > HL Loop Item > LIN

Item Identification

RequiredMax use 1

To specify basic item identification data

Usage notes

Example: LIN0001IN123456VNBG112233CHCNUK12233333444445LT314GEBANGLECLGOLDSZL1UQ*1606

Example
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-10) or Product/Service ID (LIN-11) is present, then the other is required
If either Product/Service ID Qualifier (LIN-12) or Product/Service ID (LIN-13) is present, then the other is required
If either Product/Service ID Qualifier (LIN-14) or Product/Service ID (LIN-15) is present, then the other is required
If either Product/Service ID Qualifier (LIN-16) or Product/Service ID (LIN-17) is present, then the other is required
If either Product/Service ID Qualifier (LIN-18) or Product/Service ID (LIN-19) is present, then the other is required
LIN-01
350
Assigned Identification
Optional
String (AN)
Min 1Max 20

Alphanumeric characters assigned for differentiation within a transaction set

  • LIN01 is the line item identification
Usage notes

Costco purchase order line number.

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

Costco item number.

LIN-04
235
Product/Service ID Qualifier
Required
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
Required
String (AN)
Min 1Max 48

Identifying number for a product or service

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)

Usage notes

Mandatory for Imports, Jewelry, Optical and Furniture.

CH
Country of Origin Code
LIN-07
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

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

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

UK
U.P.C./EAN Shipping Container Code (1-2-5-5-1)
UP
U.P.C. Consumer Package Code (1-5-5-1)
LIN-09
234
Product/Service ID
Required
String (AN)
Min 1Max 48

Identifying number for a product or service

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

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

Usage notes

Should be included for items like tobacco, candy, food, liquor, bakery and produce.

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

Identifying number for a product or service

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

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

Usage notes

Mandatory for items that are regulated by Country of Origin Labeling (COOL) requirements.

GE
Generic Name Description
LIN-13
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

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

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

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

Identifying number for a product or service

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

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

SZ
Vendor Alphanumeric Size Code (NRMA)
LIN-17
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

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

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

Usage notes

Mandatory for HazMat Shipments.

UQ
United Nations (UN) Number (Dangerous Goods)
LIN-19
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

SN1
030
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > HL Loop Item > SN1

Item Detail (Shipment)

OptionalMax use 1

To specify line-item detail relative to shipment

Usage notes

Example: SN1000130472*EA*****AC

Example
SN1-01
350
Assigned Identification
Optional
String (AN)
Min 1Max 20

Alphanumeric characters assigned for differentiation within a transaction set

  • SN101 is the ship notice line-item identification.
Usage notes

Mandatory for ASNs sent in SOTI structure.

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

SOTPI and SOTI structure: Number of units per pallet of the item shipped.

SOPI structure: Number of units per case of the item shipped.

SN1-03
355
Unit or Basis for Measurement Code
Required
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

  • SN103 defines the unit of measurement for both SN102 and SN104.
Usage notes

Must match the UOM on the Purchase Order.

SN1-08
668
Line Item Status Code
Optional
Identifier (ID)

Code specifying the action taken by the seller on a line item requested by the buyer

Usage notes

Mandatory for drop shipments and small packages.

AC
Item Accepted and Shipped
ID
Item Deleted
IF
Item on Hold, Incomplete Description
IR
Item Rejected
R1
Item Rejected, Not a Contract Item
R2
Item Rejected, Invalid Item Product Number
R4
Item Rejected, Contract Item not Available
PO4
060
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > HL Loop Item > PO4

Item Physical Details

OptionalMax use 1

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

Usage notes

Example: PO42764*G8238*KG21314*01*****28971

Example
Required
Numeric (N0)
Min 1Max 6

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

Usage notes

The number of inner containers/eaches per outer container. This can be defaulted to '1' if there are no inner containers per outer container.

PO4-05
187
Weight Qualifier
Required
Identifier (ID)

Code defining the type of weight

Usage notes

Mandatory for items that are measured in catch weight such as meat, fresh foods, frozen food, produce, and bakery items.

G
Gross Weight
N
Actual Net Weight
PO4-06
384
Gross Weight per Pack
Required
Decimal number (R)
Min 1Max 9

Numeric value of gross weight per pack

PO4-07
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

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

Numeric value of gross volume per pack

PO4-09
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

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

The number of eaches per inner container

Usage notes

The number of eaches per inner container.

PID
070
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > HL Loop Item > PID

Product/Item Description

OptionalMax use 200

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

Usage notes

Example: PIDFMSG***ITEM DESCRIPTION GOES HERE

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
Required
Identifier (ID)

Code identifying the general class of a product or process characteristic

GEN
General Description
MSG
Market Segment
PID-05
352
Description
Required
String (AN)
Min 1Max 80

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

Usage notes

Country of Origin Label

FDA Traceability

REF
150
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > HL Loop Item > REF

Reference Identification Destination of Shipment Harmonized-Based Code

OptionalMax use 1

To specify identifying information

Usage notes

Mandatory segment for Import Shipments.

Example: REFLY885522774411

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

Code qualifying the Reference Identification

LY
Destination of Shipment Harmonized-Based Code
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

REF
150
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > HL Loop Item > REF

Reference Identification Internal Vendor Number

RequiredMax use 1

To specify identifying information

Usage notes

Example: REFIABUYER VENDOR NUMBER

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

Code qualifying the Reference Identification

Usage notes

This must match the PO.

Please pull this from the PO in the REF*ZZ segment (Buyer Vendor Number.

IA
Internal Vendor Number
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

Usage notes

Buyer Vendor Number

REF
150
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > HL Loop Item > REF

Reference Identification Serial Number

OptionalMax use >1

To specify identifying information

Usage notes

Example: REFSE123456789

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

Code qualifying the Reference Identification

SE
Serial Number
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

REF
150
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > HL Loop Item > REF

Reference Identification Suffix

RequiredMax use 1

To specify identifying information

Usage notes

Example: REFW8BUYERSUFFIX

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

Code qualifying the Reference Identification

Usage notes

This must match the PO.

Please pull this from the PO in the REF*ZZ segment (BUYER VENDOR SUFFIX).

W8
Suffix
REF-02
127
Reference Identification
Required
String (AN)
Min 1Max 30

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

Usage notes

Buyer Vendor Suffix

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > HL Loop Item > DTM

Date/Time Reference Collection

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM90620151204

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

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

906
Collection
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

Usage notes

Harvest Date

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > HL Loop Item > DTM

Date/Time Reference Date Packed

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM51020151205

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

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

510
Date Packed
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > HL Loop Item > DTM

Date/Time Reference Expiration

OptionalMax use 10

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM03620161203

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

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

036
Expiration
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > HL Loop Item > DTM

Date/Time Reference Production

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM40520151204

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

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

405
Production
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

DTM
200
Detail > HL Loop Shipment > HL Loop Order > HL Loop Shipping Tare > HL Loop Pack > HL Loop Item > DTM

Date/Time Reference Shelf Life Expiration

OptionalMax use 1

To specify pertinent dates and times

Usage notes

Please Use UTC Time

Mandatory segment for qualifying product categories such as meat, frozen food, fresh food, and produce.

Example: DTM51120161202

Example
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
Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

HL Loop Item end
HL Loop Pack end
HL Loop Shipping Tare end
HL Loop Order end
HL Loop Shipment end
Detail end

Summary

CTT
010
Summary > CTT

Transaction Totals

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

Example: CTT1612224

Example
CTT-01
354
Number of Line Items
Required
Numeric (N0)
Min 1Max 6

Total number of line items in the transaction set

CTT-02
347
Hash Total
Required
Decimal number (R)
Min 1Max 10

Sum of values of the specified data element. All values in the data element will be summed without regard to decimal points (explicit or implicit) or signs. Truncation will occur on the left most digits if the sum is greater than the maximum size of the hash total of the data element.

## Example:
-.0018 First occurrence of value being hashed.
.18 Second occurrence of value being hashed.
1.8 Third occurrence of value being hashed.
18.01 Fourth occurrence of value being hashed.

1855 Hash total prior to truncation.
855 Hash total after truncation to three-digit field.

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.