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

X12 856 Ship Notice/Manifest

X12 Release 5010

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

The sender of this transaction is the organization responsible for detailing and communicating the contents of a shipment, or shipments, to one or more receivers of the transaction set. The receiver of this transaction set can be any organization having an interest in the contents of a shipment or information about the contents of a shipment.

Delimiters
  • ~ Segment
  • * Element
  • > Component
  • ^ Repetition
EDI sample
  • Sample
View the latest version of this implementation guide as an interactive webpage
https://www.stedi.com/app/guides/view/ups/ship-noticemanifest/01H28RKKXZ8PJS5G67F2GT0Y89
Powered by
Build EDI implementation guides at stedi.com
Overview
ISA
-
Interchange Control Header
Max use 1
Required
GS
-
Functional Group Header
Max use 1
Required
heading
detail
HL Loop
HL
0100
Hierarchical Level
Max use 1
Required
REF
1500
Reference Information
Max use 1
Optional
DTM
2000
Promised for Shipment (Week of)
Max use 1
Optional
DTM
2000
Scheduled for Shipment (Week of)
Max use 1
Optional
DTM
2000
Shipped
Max use 10
Optional
FOB
2100
F.O.B. Related Instructions
Max use 1
Optional
Buying Party (Purchaser)
GE
-
Functional Group Trailer
Max use 1
Required
IEA
-
Interchange Control Trailer
Max use 1
Required
ISA

Interchange Control Header

RequiredMax use 1

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

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

Code identifying the type of information in the Authorization Information

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

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

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

Code identifying the type of information in the Security Information

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

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

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

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

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

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

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

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

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

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

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

Date of the interchange

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

Time of the interchange

ISA-11
I65
Repetition Separator
Required
String (AN)
Min 1Max 1

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

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

Code specifying the version number of the interchange control segments

00501
Standards Approved for Publication by ASC X12 Procedures Review Board through October 2003
ISA-13
I12
Interchange Control Number
Required
Numeric (N0)
Min 9Max 9

A control number assigned by the interchange sender

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

Code indicating sender's request for an interchange acknowledgment

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

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

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

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

>
Component Element Separator

Functional Group Header

RequiredMax use 1

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

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

Code identifying a group of application related transaction sets

SH
Ship Notice/Manifest (856)
GS-02
142
Application Sender's Code
Required
String (AN)
Min 2Max 15

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

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

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

GS-04
373
Date
Required
Date (DT)
CCYYMMDD format

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

GS-05
337
Time
Required
Time (TM)
HHMM, HHMMSS, HHMMSSD, or HHMMSSDD format

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

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

Assigned number originated and maintained by the sender

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

Code identifying the issuer of the standard; this code is used in conjunction with Data Element 480

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

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

005010
Standards Approved for Publication by ASC X12 Procedures Review Board through October 2003

Heading

ST
0100
Heading > ST

Transaction Set Header

RequiredMax use 1

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

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

Code uniquely identifying a Transaction Set

  • The transaction set identifier (ST01) is used by the translation routines of the interchange partners to select the appropriate transaction set definition (e.g., 810 selects the Invoice Transaction Set).
856
Ship Notice/Manifest
ST-02
329
Transaction Set Control Number
Required
Numeric (N)
Min 4Max 9

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

BSN
0200
Heading > BSN

Beginning Segment for Ship Notice

RequiredMax use 1

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

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

Code identifying purpose of transaction set

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

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

BSN-03
373
Date
Required
Date (DT)
CCYYMMDD format

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

  • BSN03 is the date the shipment transaction set is created.
BSN-04
337
Time
Required
Time (TM)
HHMM, HHMMSS, HHMMSSD, or HHMMSSDD format

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

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

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

0004
Shipment, Order, Item
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.
AS
Shipment Advice

Notification by an inventory management organization providing current shipping advice relating to the outstanding requisition or order.

CL
Customer Allocation
Heading end

Detail

HL Loop
RequiredMax >1
HL
0100
Detail > HL Loop > HL

Hierarchical Level

RequiredMax use 1

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

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

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

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

Code defining the characteristic of a level in a hierarchical structure

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

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

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

Reference Information

OptionalMax use >1

To specify identifying information

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

Code qualifying the Reference Identification

2I
Tracking Number
BL
Government Bill of Lading
BM
Bill of Lading Number
CN
Carrier's Reference Number (PRO/Invoice)
SI
Shipper's Identifying Number for Shipment (SID)

A unique number (to the shipper) assigned by the shipper to identify the shipment.

SN
Seal Number
REF-02
127
Reference Identification
Optional
String (AN)
Min 1Max 50

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

DTM
2000
Detail > HL Loop > DTM

Promised for Shipment (Week of)

OptionalMax use 1

To specify pertinent dates and times

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

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

088
Promised for Shipment (Week of)
DTM-02
373
Date
Optional
Date (DT)
CCYYMMDD format

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

DTM
2000
Detail > HL Loop > DTM

Scheduled for Shipment (Week of)

OptionalMax use 1

To specify pertinent dates and times

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

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

086
Scheduled for Shipment (Week of)
DTM-02
373
Date
Optional
Date (DT)
CCYYMMDD format

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

DTM
2000
Detail > HL Loop > DTM

Shipped

OptionalMax use 10

To specify pertinent dates and times

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

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

011
Shipped
DTM-02
373
Date
Optional
Date (DT)
CCYYMMDD format

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

FOB
2100
Detail > HL Loop > FOB

F.O.B. Related Instructions

OptionalMax use 1

To specify transportation instructions relating to shipment

Example
If Description (FOB-03) is present, then Location Qualifier (FOB-02) 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)
Min 1Max 2

Code identifying type of location

  • FOB02 is the code specifying transportation responsibility location.
FOB-03
352
Description
Optional
String (AN)
Min 1Max 80

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

N1 Buying Party (Purchaser)
OptionalMax 1
Variants (all may be used)
Ship FromShip To
N1
2200
Detail > HL Loop > Buying Party (Purchaser) > N1

Party Identification

RequiredMax use 1

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

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

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

BY
Buying Party (Purchaser)

The Buyer entity info is mandatory for DSCSA Rx clients. It will be returned on the 944 transaction.

N1-02
93
Name
Optional
String (AN)
Min 1Max 60

Free-form name

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

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

91
Assigned by Seller or Seller'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.
N2
2300
Detail > HL Loop > Buying Party (Purchaser) > N2

Additional Name Information

OptionalMax use 2

To specify additional names

Example
N2-01
93
Name
Required
String (AN)
Min 1Max 60

Free-form name

N2-02
93
Name
Optional
String (AN)
Min 1Max 60

Free-form name

N3
2400
Detail > HL Loop > Buying Party (Purchaser) > N3

Party Location

OptionalMax use 2

To specify the location of the named party

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

Address information

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

Address information

N4
2500
Detail > HL Loop > Buying Party (Purchaser) > N4

Geographic Location

OptionalMax use 1

To specify the geographic place of the named party

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

Free-form text for city name

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

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

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

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

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

Code identifying the country

N1 Buying Party (Purchaser) end
N1 Ship From
OptionalMax 1
Variants (all may be used)
Buying Party (Purchaser)Ship To
N1
2200
Detail > HL Loop > Ship From > N1

Party Identification

RequiredMax use 1

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

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

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

SF
Ship From
N1-02
93
Name
Optional
String (AN)
Min 1Max 60

Free-form name

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

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

91
Assigned by Seller or Seller'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.
N2
2300
Detail > HL Loop > Ship From > N2

Additional Name Information

OptionalMax use 2

To specify additional names

Example
N2-01
93
Name
Required
String (AN)
Min 1Max 60

Free-form name

N2-02
93
Name
Optional
String (AN)
Min 1Max 60

Free-form name

N3
2400
Detail > HL Loop > Ship From > N3

Party Location

OptionalMax use 2

To specify the location of the named party

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

Address information

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

Address information

N4
2500
Detail > HL Loop > Ship From > N4

Geographic Location

OptionalMax use 1

To specify the geographic place of the named party

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

Free-form text for city name

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

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

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

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

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

Code identifying the country

N1 Ship From end
N1 Ship To
OptionalMax 1
Variants (all may be used)
Buying Party (Purchaser)Ship From
N1
2200
Detail > HL Loop > Ship To > N1

Party Identification

RequiredMax use 1

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

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

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

ST
Ship To
N1-02
93
Name
Optional
String (AN)
Min 1Max 60

Free-form name

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

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

91
Assigned by Seller or Seller's Agent
N1-04
67
Identification Code
Optional
String (AN)
Min 2Max 80

Code identifying a party or other code

  • This segment, used alone, provides the most efficient method of providing organizational identification. To obtain this efficiency the "ID Code" (N104) must provide a key to the table maintained by the transaction processing party.
Usage notes

Warehouse Code

N2
2300
Detail > HL Loop > Ship To > N2

Additional Name Information

OptionalMax use 2

To specify additional names

Example
N2-01
93
Name
Required
String (AN)
Min 1Max 60

Free-form name

N2-02
93
Name
Optional
String (AN)
Min 1Max 60

Free-form name

N3
2400
Detail > HL Loop > Ship To > N3

Party Location

OptionalMax use 2

To specify the location of the named party

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

Address information

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

Address information

N4
2500
Detail > HL Loop > Ship To > N4

Geographic Location

OptionalMax use 1

To specify the geographic place of the named party

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

Free-form text for city name

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

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

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

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

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

Code identifying the country

N1 Ship To end
HL Loop
RequiredMax >1
HL
0100
Detail > HL Loop > HL Loop > HL

Hierarchical Level

RequiredMax use 1

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

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

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

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

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

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

Code defining the characteristic of a level in a hierarchical structure

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

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

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

Purchase Order Reference

OptionalMax use 1

To provide reference to a specific purchase order

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

Identifying number for Purchase Order assigned by the orderer/purchaser

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

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

PRF-05
350
Assigned Identification
Optional
String (AN)
Min 1Max 20

Alphanumeric characters assigned for differentiation within a transaction set

HL Loop
RequiredMax >1
HL
0100
Detail > HL Loop > HL Loop > HL Loop > HL

Hierarchical Level

RequiredMax use 1

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

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

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

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

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

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

Code defining the characteristic of a level in a hierarchical structure

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

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

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

Item Identification

OptionalMax use 1

To specify basic item identification data

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
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.
VC
Vendor's (Seller's) Catalog Number
VN
Vendor's (Seller'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)

VC
Vendor's (Seller's) Catalog Number
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)
Min 2Max 2

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

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)
Min 2Max 2

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

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)
Min 2Max 2

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

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

Identifying number for a product or service

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

Item Detail (Shipment)

OptionalMax use 1

To specify line-item detail relative to shipment

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)
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.
PID
0700
Detail > HL Loop > HL Loop > HL Loop > PID

Product/Item Description

OptionalMax use 200

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

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

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.
PID-05
352
Description
Optional
String (AN)
Min 1Max 80

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

REF
1500
Detail > HL Loop > HL Loop > HL Loop > REF

Reference Information

OptionalMax use >1

To specify identifying information

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

Code qualifying the Reference Identification

ACC
Status

Lock Code

LF
Assembly Line Feed Location
LI
Line Item Identifier (Seller's)
LT
Lot Number
PO
Purchase Order Number
SE
Serial Number
ZZ
Mutually Defined
REF-02
127
Reference Identification
Optional
String (AN)
Min 1Max 50

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

REF-04
C040
Reference Identifier
OptionalMax use 1
To identify one or more reference numbers or identification numbers as specified by the Reference Qualifier
If either Reference Identification Qualifier (C040-03) or Reference Identification (C040-04) is present, then the other is required
If either Reference Identification Qualifier (C040-05) or Reference Identification (C040-06) is present, then the other is required
C040-01
128
Reference Identification Qualifier
Required
Identifier (ID)
Min 2Max 3

Code qualifying the Reference Identification

C040-02
127
Reference Identification
Required
String (AN)
Min 1Max 50

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

C040-03
128
Reference Identification Qualifier
Optional
Identifier (ID)
Min 2Max 3

Code qualifying the Reference Identification

C040-04
127
Reference Identification
Optional
String (AN)
Min 1Max 50

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

C040-05
128
Reference Identification Qualifier
Optional
Identifier (ID)
Min 2Max 3

Code qualifying the Reference Identification

C040-06
127
Reference Identification
Optional
String (AN)
Min 1Max 50

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

DTM
2000
Detail > HL Loop > HL Loop > HL Loop > DTM

Date/Time Reference

OptionalMax use 10

To specify pertinent dates and times

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

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

208
Lot Number Expiration
DTM-02
373
Date
Optional
Date (DT)
CCYYMMDD format

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

N1 Distributor
OptionalMax 1
N1
2200
Detail > HL Loop > HL Loop > HL Loop > Distributor > N1

Party Identification

RequiredMax use 1

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

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

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

DS
Distributor
N1-02
93
Name
Optional
String (AN)
Min 1Max 60

Free-form name

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

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

9
D-U-N-S+4, D-U-N-S Number with Four Character Suffix
91
Assigned by Seller or Seller'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.
N1 Distributor end
N1 Manufacturer of Goods
OptionalMax 1
Variants (all may be used)
DistributorSupplier/Manufacturer
N1
2200
Detail > HL Loop > HL Loop > HL Loop > Manufacturer of Goods > N1

Party Identification

RequiredMax use 1

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

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

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

MF
Manufacturer of Goods
N1-02
93
Name
Optional
String (AN)
Min 1Max 60

Free-form name

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

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

9
D-U-N-S+4, D-U-N-S Number with Four Character Suffix
91
Assigned by Seller or Seller'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.
N1 Manufacturer of Goods end
N1 Supplier/Manufacturer
OptionalMax 1
Variants (all may be used)
DistributorManufacturer of Goods
N1
2200
Detail > HL Loop > HL Loop > HL Loop > Supplier/Manufacturer > N1

Party Identification

RequiredMax use 1

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

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

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

SU
Supplier/Manufacturer
N1-02
93
Name
Optional
String (AN)
Min 1Max 60

Free-form name

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

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

9
D-U-N-S+4, D-U-N-S Number with Four Character Suffix
91
Assigned by Seller or Seller'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.
N1 Supplier/Manufacturer end
HL Loop end
HL Loop end
HL Loop end
Detail end

Summary

CTT
0100
Summary > CTT

Transaction Totals

OptionalMax use 1

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

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

Total number of line items in the transaction set

CTT-02
347
Hash Total
Optional
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.
18E2 Fifth occurrence of value being hashed.

1873 Hash Total

SE
0200
Summary > SE

Transaction Set Trailer

RequiredMax use 1

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

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

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

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

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

Summary end

Functional Group Trailer

RequiredMax use 1

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

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

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

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

Assigned number originated and maintained by the sender

Interchange Control Trailer

RequiredMax use 1

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

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

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

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

A control number assigned by the interchange sender

EDI Samples

Sample

ISA*00* *00* *ZZ*SENDER *ZZ*RECEIVER *231101*0210*^*00501*000000001*0*T*>
GS*SH*SENDERGS*RECEIVERGS*20231101*021050*000000001*X*005010
BSN*00*1058899176*20170126*103611
HL*1**S
REF*SN*SEALNBR
REF*CN*PROBILL
REF*2I*TRACKID
DTM*088*20170127
FOB*PP
N1*SF*SHIP FROM NAME*91*SF_ID
N1*ST**91*2037
HL*2*1*O
PRF*DS742485*DSREF***XX742999
HL*3*2*I
LIN*1*VN*PROD_A
SN1**1450*EA
PID*F****DESCRIPTION A
REF*LT*LOT1
REF*ACC*DD
REF*LF*REFTEST1
REF*SE*SERIAL1
REF*SE*SERIAL2
REF*SE*SERIAL3
REF*SE*SERIAL4
REF*SE*SERIAL5
REF*LI*001001
DTM*208*20170101
N1*MF*MF NAME*91*123
HL*4*2*I
LIN*2*VN*PROD_B
SN1**300*CA
PID*F****DESCRIPTION B
REF*LT*LOT2
REF*LI*001002
REF*ZZ*REFZZ
DTM*208*20170102
HL*5*1*O
PRF*DS742475****XX742488
HL*6*5*I
LIN*1*VN*PROD_C
SN1**6650*EA
REF*LT*LOT3
REF*LI*001003
N1*MF*MF NAME*9*4567
CTT*3
GE*1*000000001
IEA*1*000000001

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.