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

X12 856 Ship Notice/Manifest

X12 Release 4010

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

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

Delimiters
  • ~ Segment
  • * Element
  • > Component
EDI samples
  • None included
View the latest version of this implementation guide as an interactive webpage
https://www.stedi.com/app/guides/view/one-kings-lane/ship-noticemanifest/01H2SXC8WVDSB8D5K4QS8PMFBR
Powered by
Build EDI implementation guides at stedi.com
Overview
ISA
-
Interchange Control Header
Max use 1
Required
GS
-
Functional Group Header
Max use 1
Required
heading
detail
HL Loop
HL
010
Hierarchical Level
Max use 1
Required
TD5
120
Carrier Details (Routing Sequence/Transit Time)
Max use 12
Optional
DTM
200
Date/Time Reference
Max use 10
Optional
HL Loop
HL
010
Hierarchical Level
Max use 1
Required
PRF
050
Purchase Order Reference
Max use 1
Required
HL Loop Item
GE
-
Functional Group Trailer
Max use 1
Required
IEA
-
Interchange Control Trailer
Max use 1
Required
ISA

Interchange Control Header

RequiredMax use 1

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

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

Code to identify the type of information in the Authorization Information

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

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

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

Code to identify the type of information in the Security Information

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

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

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

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

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

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

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

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

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

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

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

Date of the interchange

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

Time of the interchange

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

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

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

This version number covers the interchange control segments

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

A control number assigned by the interchange sender

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

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

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

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

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

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

>
Component Element Separator

Functional Group Header

RequiredMax use 1

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

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

Code identifying a group of application related transaction sets

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

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

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

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

Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

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

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

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

Assigned number originated and maintained by the sender

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

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

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

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

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

Heading

ST
010
Heading > ST

Transaction Set Header

RequiredMax use 1

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

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

Code uniquely identifying a Transaction Set

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

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

BSN
020
Heading > BSN

Beginning Segment for Ship Notice

RequiredMax use 1

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

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

Code identifying purpose of transaction set

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

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

Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD

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

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

  • BSN04 is the time the shipment transaction set is created.
BSN-05
1005
Hierarchical Structure Code
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
0002
Shipment, Order, Item, Packaging
Heading end

Detail

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

Hierarchical Level

RequiredMax use 1

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

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

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

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

Code defining the characteristic of a level in a hierarchical structure

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

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

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

Carrier Details (Routing Sequence/Transit Time)

OptionalMax use 12

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

Example
TD5-01
133
Routing Sequence Code
Required
Identifier (ID)

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

B
Origin/Delivery Carrier (Any Mode)
TD5-05
387
Routing
Optional
String (AN)
Min 1Max 35

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

Usage notes

Code for actual shipping / routing. Use the Integrated Message Codes feature in OrderStream to view a list of your valid Ship Codes.

DTM
200
Detail > HL Loop > DTM

Date/Time Reference

OptionalMax use 10

To specify pertinent dates and times

Example
If Time Code (DTM-04) is present, then Time (DTM-03) is required
DTM-01
374
Date/Time Qualifier
Required
Identifier (ID)

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

011
Shipped

The date of the shipment

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-04
623
Time Code
Optional
Identifier (ID)
Min 2Max 2

Code identifying the time. In accordance with International Standards Organization standard 8601, time can be specified by a + or - and an indication in hours in relation to Universal Time Coordinate (UTC) time; since + is a restricted character, + and - are substituted by P and M in the codes that follow

Usage notes

Time Code (DTM-04) is always recommended to be populated (even there is no time to be reported) in order to be specific about the UTC offset for the time zone from which a date is being reported.

When there is no time to be reported, set DTM-03 = 0000 to indicate that the DTM-02 date covers the 24 hour period that begins at midnight on the specified date with a UTC offset specified by the DTM-04.

For example CCYY0515 reported from Hawaii with time 0000 represents the twenty four hours from May 15 09:00 UTC through May 16 08:59:59.99 UTC (Note: Hawaii time is UTC -09:00 on May 15th because of Daylight Savings). The time code that should be sent with a date of CCYY0515 reported from Hawaii would be 16 which is Equivalent to ISO M09.

If the intent is to represent midnight as a specific point in time rather than the 24 hour period that beings at midnight, then the DTM-03 value should be 00000001 (one one-hundreth of a second after midnight).

HL Loop
RequiredMax >1
HL
010
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.
0
No Subordinate HL Segment in This Hierarchical Structure.
1
Additional Subordinate HL Data Segment in This Hierarchical Structure.
PRF
050
Detail > HL Loop > HL Loop > PRF

Purchase Order Reference

RequiredMax use 1

To provide reference to a specific purchase order

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

Identifying number for Purchase Order assigned by the orderer/purchaser

HL Loop Item
OptionalMax >1
Variants (all may be used)
HL Loop Pack
HL
010
Detail > HL Loop > HL Loop > 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 > HL Loop > HL Loop Item > LIN

Item Identification

RequiredMax use 1

To specify basic item identification data

Example
If either Product/Service ID Qualifier (LIN-08) or Product/Service ID (LIN-09) is present, then the other is required
LIN-01
350
Assigned Identification
Required
String (AN)
Min 1Max 20

Alphanumeric characters assigned for differentiation within a transaction set

  • LIN01 is the line item identification
Usage notes

Merchant's 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.
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

Usage notes

Vendor's 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)

SK
Stock Keeping Unit (SKU)
LIN-05
234
Product/Service ID
Required
String (AN)
Min 1Max 48

Identifying number for a product or service

Usage notes

Merchant SKU

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)

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

Usage notes

UPC or GS1 code

SN1
030
Detail > HL Loop > HL Loop > HL Loop Item > SN1

Item Detail (Shipment)

RequiredMax use 1

To specify line-item detail relative to shipment

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

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

Usage notes

If SN1_08 = "AC" then SN1_02 should be populated

SN1-03
355
Unit or Basis for Measurement Code
Required
Identifier (ID)

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

  • SN103 defines the unit of measurement for both SN102 and SN104.
EA
Each
SN1-05
330
Quantity Ordered
Optional
Decimal number (R)
Min 1Max 15

Quantity ordered

Usage notes

If SN1_08 not = "AC" then SN1_05 should be populated

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

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

EA
Each
SN1-08
668
Line Item Status Code
Required
Identifier (ID)

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

Usage notes

Any code other than "AC" or those listed indicates shipment of the quantity specified in SN1_05, regardless of value in SN1-02

AC
Item Accepted and Shipped
ID
Item Deleted

Cancel reason must be reported in "TD" qualified REF segment

SLN
040
Detail > HL Loop > HL Loop > HL Loop Item > SLN

Subline Item Detail

OptionalMax use 1000

To specify product subline detail item data

Usage notes

EXAMPLE: SLN1*I 25.75TE

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

Alphanumeric characters assigned for differentiation within a transaction set

  • SLN01 is the identifying number for the subline item.
  • SLN01 is related to (but not necessarily equivalent to) the baseline item number. Example: 1.1 or 1A might be used as a subline number to relate to baseline number 1.
SLN-03
662
Relationship Code
Required
Identifier (ID)

Code indicating the relationship between entities

  • SLN03 is the configuration code indicating the relationship of the subline item to the baseline item.
I
Included
SLN-06
212
Unit Price
Required
Decimal number (R)
Min 1Max 15

Price per unit of product, service, commodity, etc.

Usage notes

Unit cost to be invoiced to merchant

SLN-07
639
Basis of Unit Price Code
Required
Identifier (ID)
Min 2Max 2

Code identifying the type of unit price for an item

REF
150
Detail > HL Loop > HL Loop > HL Loop Item > REF

Reference Identification

OptionalMax use >1

To specify identifying information

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

Code qualifying the Reference Identification

TD
Reason for Change
REF-02
127
Reference Identification
Optional
String (AN)
Min 1Max 30

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

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

Name

RequiredMax use 1

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

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

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

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

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

54
Warehouse
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 end
HL Loop
RequiredMax >1
HL
010
Detail > HL Loop > HL Loop > HL Loop Item > HL Loop > HL

Hierarchical Level

RequiredMax use 1

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

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

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

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

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

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

Code defining the characteristic of a level in a hierarchical structure

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

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

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

Item Physical Details

OptionalMax use 1

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

Usage notes

EXAMPLE: PO4*********55*1

Example
If Length (PO4-10) is present, then Unit or Basis for Measurement Code (PO4-13) is required
If Width (PO4-11) is present, then Unit or Basis for Measurement Code (PO4-13) is required
If Height (PO4-12) is present, then Unit or Basis for Measurement Code (PO4-13) is required
If Unit or Basis for Measurement Code (PO4-13) is present, then at least one of Length (PO4-10), Width (PO4-11) or Height (PO4-12) is required
Optional
Numeric (N0)
Min 1Max 6

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

Usage notes

Indicate quantity of sku included in package. In cases where quantity 1 of a sku involves multiple packages, set to 1 for the 'master' package and zero for the package(s) that contain the other components of the sku.

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

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

Optional
Decimal number (R)
Min 1Max 8

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

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

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

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

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

  • PO413 defines the unit of measure for PO410, PO411, and PO412.
TD1
110
Detail > HL Loop > HL Loop > HL Loop Item > HL Loop > TD1

Carrier Details (Quantity and Weight)

OptionalMax use 20

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

Example
If Weight Qualifier (TD1-06) is present, then Weight (TD1-07) is required
If either Weight (TD1-07) or Unit or Basis for Measurement Code (TD1-08) is present, then the other is required
TD1-06
187
Weight Qualifier
Optional
Identifier (ID)

Code defining the type of weight

A3
Shippers Weight
TD1-07
81
Weight
Optional
Decimal number (R)
Min 1Max 10

Numeric value of weight

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

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

01
Actual Pounds
MAN
190
Detail > HL Loop > HL Loop > HL Loop Item > HL Loop > MAN

Marks and Numbers

OptionalMax use >1

To indicate identifying marks and numbers for shipping containers

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

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

  • MAN01/MAN02 and MAN04/MAN05 may be used to identify two different marks and numbers assigned to the same physical container.
  • When MAN01 contains code "UC" (U.P.C. Shipping Container Code) and MAN05/MAN06 contain a range of ID numbers, MAN03 is not used. The reason for this is that the U.P.C. Shipping Container code is the same on every carton that is represented in the range in MAN05/MAN06.
CP
Carrier-Assigned Package ID Number
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

Tracking number

HL Loop end
HL Loop Item end
HL Loop Pack
OptionalMax >1
Variants (all may be used)
HL Loop Item
HL
010
Detail > HL Loop > HL Loop > 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.
PO4
060
Detail > HL Loop > HL Loop > 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: PO4*********55*1

Example
If Length (PO4-10) is present, then Unit or Basis for Measurement Code (PO4-13) is required
If Width (PO4-11) is present, then Unit or Basis for Measurement Code (PO4-13) is required
If Height (PO4-12) is present, then Unit or Basis for Measurement Code (PO4-13) is required
If Unit or Basis for Measurement Code (PO4-13) is present, then at least one of Length (PO4-10), Width (PO4-11) or Height (PO4-12) is required
Optional
Numeric (N0)
Min 1Max 6

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

Usage notes

Indicate quantity of sku included in package. In cases where quantity 1 of a sku involves multiple packages, set to 1 for the 'master' package and zero for the package(s) that contain the other components of the sku.

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

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

Optional
Decimal number (R)
Min 1Max 8

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

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

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

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

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

  • PO413 defines the unit of measure for PO410, PO411, and PO412.
TD1
110
Detail > HL Loop > HL Loop > HL Loop Pack > TD1

Carrier Details (Quantity and Weight)

OptionalMax use 20

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

Example
If Weight Qualifier (TD1-06) is present, then Weight (TD1-07) is required
If either Weight (TD1-07) or Unit or Basis for Measurement Code (TD1-08) is present, then the other is required
TD1-06
187
Weight Qualifier
Optional
Identifier (ID)

Code defining the type of weight

A3
Shippers Weight
TD1-07
81
Weight
Optional
Decimal number (R)
Min 1Max 10

Numeric value of weight

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

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

01
Actual Pounds
MAN
190
Detail > HL Loop > HL Loop > HL Loop Pack > MAN

Marks and Numbers

OptionalMax use >1

To indicate identifying marks and numbers for shipping containers

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

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

  • MAN01/MAN02 and MAN04/MAN05 may be used to identify two different marks and numbers assigned to the same physical container.
  • When MAN01 contains code "UC" (U.P.C. Shipping Container Code) and MAN05/MAN06 contain a range of ID numbers, MAN03 is not used. The reason for this is that the U.P.C. Shipping Container code is the same on every carton that is represented in the range in MAN05/MAN06.
CP
Carrier-Assigned Package ID Number
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

Tracking number

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

Hierarchical Level

RequiredMax use 1

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

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

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

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

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

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

Code defining the characteristic of a level in a hierarchical structure

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

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

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

Item Identification

RequiredMax use 1

To specify basic item identification data

Example
If either Product/Service ID Qualifier (LIN-08) or Product/Service ID (LIN-09) is present, then the other is required
LIN-01
350
Assigned Identification
Required
String (AN)
Min 1Max 20

Alphanumeric characters assigned for differentiation within a transaction set

  • LIN01 is the line item identification
Usage notes

Merchant's 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.
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

Usage notes

Vendor's 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)

SK
Stock Keeping Unit (SKU)
LIN-05
234
Product/Service ID
Required
String (AN)
Min 1Max 48

Identifying number for a product or service

Usage notes

Merchant SKU

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)

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

Usage notes

UPC or GS1 code

SN1
030
Detail > HL Loop > HL Loop > HL Loop Pack > HL Loop > SN1

Item Detail (Shipment)

RequiredMax use 1

To specify line-item detail relative to shipment

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

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

Usage notes

If SN1_08 = "AC" then SN1_02 should be populated

SN1-03
355
Unit or Basis for Measurement Code
Required
Identifier (ID)

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

  • SN103 defines the unit of measurement for both SN102 and SN104.
EA
Each
SN1-05
330
Quantity Ordered
Optional
Decimal number (R)
Min 1Max 15

Quantity ordered

Usage notes

If SN1_08 not = "AC" then SN1_05 should be populated

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

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

EA
Each
SN1-08
668
Line Item Status Code
Required
Identifier (ID)

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

Usage notes

Any code other than "AC" or those listed indicates shipment of the quantity specified in SN1_05, regardless of value in SN1-02

AC
Item Accepted and Shipped
ID
Item Deleted

Cancel reason must be reported in "TD" qualified REF segment

SLN
040
Detail > HL Loop > HL Loop > HL Loop Pack > HL Loop > SLN

Subline Item Detail

OptionalMax use 1000

To specify product subline detail item data

Usage notes

EXAMPLE: SLN1*I 25.75TE

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

Alphanumeric characters assigned for differentiation within a transaction set

  • SLN01 is the identifying number for the subline item.
  • SLN01 is related to (but not necessarily equivalent to) the baseline item number. Example: 1.1 or 1A might be used as a subline number to relate to baseline number 1.
SLN-03
662
Relationship Code
Required
Identifier (ID)

Code indicating the relationship between entities

  • SLN03 is the configuration code indicating the relationship of the subline item to the baseline item.
I
Included
SLN-06
212
Unit Price
Required
Decimal number (R)
Min 1Max 15

Price per unit of product, service, commodity, etc.

Usage notes

Unit cost to be invoiced to merchant

SLN-07
639
Basis of Unit Price Code
Required
Identifier (ID)
Min 2Max 2

Code identifying the type of unit price for an item

REF
150
Detail > HL Loop > HL Loop > HL Loop Pack > HL Loop > REF

Reference Identification

OptionalMax use >1

To specify identifying information

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

Code qualifying the Reference Identification

TD
Reason for Change
REF-02
127
Reference Identification
Optional
String (AN)
Min 1Max 30

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

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

Name

RequiredMax use 1

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

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

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

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

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

54
Warehouse
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 end
HL Loop end
HL Loop Pack end
HL Loop end
HL Loop end
Detail end

Summary

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.