Home Depot 856 - Ship Notice Manifest Specifications

Modified on Tue, May 26 at 9:49 AM

**These specifications are a base model. All customers are responsible for ensuring their map or EDI is compliant with their trading partner's most current specifications.


X12 856 Ship Notice/Manifest

X12 Release 4010

Revised November 20, 2023

Print

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

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*00*          *00*          *XX*XXXXXXXXXXXXXXX*XX*XXXXXXXXXXXXXXX*240622*1032*U*00401*000000000*X*X*>~

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

GS

Functional Group Header

RequiredMax use 1

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

Example

GS*SH*XXXX*XXXXX*20240622*0800*0000000*XX*004010~

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

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

Transaction Set Header

RequiredMax use 1

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

Example

ST*856*0001~

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

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: BSN00000000001200310161211*0002

Example

BSN*00*XXXX*20230719*1057*0001~

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

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

Usage notes

This element contains the transaction date as assigned by the party sending the message.

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

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

Detail

HL Loop

RequiredMax >1

Usage notes

Example: HL*1**S

HL

010

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*1**S*1~

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

Carrier Details (Routing Sequence/Transit Time)

OptionalMax use 12

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

Usage notes

This segment is required to be provided when any part of an order is being shipped. If you are only reporting cancellations/backorders this segment is not required to be provided.

Example: TD5B***UPSN_CG

Example

TD5*B****XX~

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)

Always required.

TD5-05

387

Routing

Optional

String (AN)

Min 1Max 35

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

Usage notes

This element contains a Home Depot specific code that indicates both the shipper and the level of service. Contact CommerceHub for a complete list of codes. Failure to include one of the approved codes (even during the testing phase of your implementation) will result in a failure to process the message.

There will be cases where an 'unspecified' code will be issued to you on the purchase order. Home Depot will not accept this same 'unspecified' code back in the shipment confirmation. It is expected that you will provide a code that actually represents the shipper and service level.

REF

150

Reference Identification

OptionalMax use >1

To specify identifying information

Usage notes

Example: REFIAZ001

Example

REF*IA*XX~

REF-01

128

Reference Identification Qualifier

Required

Identifier (ID)

Code qualifying the Reference Identification

IA

Internal Vendor Number

This qualifier indicates that the REF02 contains the Home Depot assigned vendor number.

REF-02

127

Reference Identification

Optional

String (AN)

Min 1Max 30

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

DTM

200

Date/Time Reference

OptionalMax use 10

To specify pertinent dates and times

Usage notes

This segment is required to be included when any part of an order is shipping. If only cancellations are included, this segment may be omitted.

Example: DTM01120031015

Example

DTM*011*20230719~

DTM-01

374

Date/Time Qualifier

Required

Identifier (ID)

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

011

Shipped

This qualifier indicates that the DTM02 contains the date that the items were shipped.

DTM-02

373

Date

Required

Date (DT)

CCYYMMDD format

Date expressed as CCYYMMDD

Usage notes

This element contains the Home Depot assigned vendor number.

N1 Loop

OptionalMax >1

N1

220

Name

RequiredMax use 1

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

Usage notes

The Home Depot requires the point-of-origin for all shipments to be reported as part of the fulfillment confirmation. The name and address of the facility from which shipment originates should be reported in this SF qualified N1 loop.

If only cancellations are being reported, this N1 loop is not required to be
 
reported.

Example: N1SFTHE ABC CO938119

Example

N1*SF*X*93*XXXX~

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

Name and address of fulfillment centre.

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)

93

Code assigned by the organization originating the transaction set

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

Address Information

OptionalMax use 2

To specify the location of the named party

Usage notes

Example: N321 CORPORATE DRSUITE 205

Example

N3*XXXXX*XXX~

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

Geographic Location

OptionalMax use 1

To specify the geographic place of the named party

Usage notes

Example: N4CLIFTON PARKNY120658763USA

Example

N4*XX*XX*XXXX*XXX~

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

HL Loop

RequiredMax >1

Usage notes

Example: HL21*O

HL

010

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*2*1*O*1~

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

Purchase Order Reference

RequiredMax use 1

To provide reference to a specific purchase order

Usage notes

Example: PRF*1999999999

Example

PRF*XXX~

PRF-01

324

Purchase Order Number

Required

String (AN)

Min 1Max 22

Identifying number for Purchase Order assigned by the orderer/purchaser

Usage notes

This element contains the purchase order number as issued by The Home Depot. Failure to report a valid purchase order number will result in a failure to process the message.

HL Item

OptionalMax >1

Usage notes

Example: HL43*I

Variants (all may be used)

Pack

HL

010

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*3*2*I*1~

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

Item Identification

RequiredMax use 1

To specify basic item identification data

Usage notes

Example: LIN02VN477631SK*11254

Example

LIN*XXX*VN*X*SK*XXXXXX~

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

This element must contain The Home Depot 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

This element contains the Vendor SKU for the product.

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)

This qualifier indicates that the LIN05 contains The Home Depot SKU.

LIN-05

234

Product/Service ID

Required

String (AN)

Min 1Max 48

Identifying number for a product or service

Usage notes

This element contains The Home Depot SKU for the product.

SN1

030

Item Detail (Shipment)

RequiredMax use 1

To specify line-item detail relative to shipment

Usage notes

Examples:
 
SN13EAAC (Shipment)
 
SN10EA**3EA**IR (Cancel)

Example

SN1**000*EA**00000000000000***ID~

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

When shipping, this element must contain the number of units shipped. When cancelling, this element must contain a zero.

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

When shipping, this element is not required to be populated. When cancelling, this element must contain the number of units being cancelled.

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

When shipping, this element will always contain a value of AC. When cancelling, this element will contain one of the cancel codes listed.

AC

Item Accepted and Shipped

ID

Item Deleted

  1. merchant_request

IF

Item on Hold, Incomplete Description

  1. info_missing

IR

Item Rejected

  1. info_missing

R1

Item Rejected, Not a Contract Item

  1. discontinued

R2

Item Rejected, Invalid Item Product Number

  1. bad_sku

R4

Item Rejected, Contract Item not Available

  1. out_of_stock

HL Loop

RequiredMax >1

Usage notes

This pack loop is not required to be provided if only cancellations or backorders are being reported.

Example: HL32*P

HL

010

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*4*3*P*0~

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.

MAN

190

Marks and Numbers

OptionalMax use >1

To indicate identifying marks and numbers for shipping containers

Usage notes

Example: MANCP00000983767102803932

Example

MAN*CP*XX~

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

This qualifier indicates that the MAN02 contains the tracking number for the package.

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

This element contains the tracking number for the package.

CommerceHub enforces validation rules for UPS and FEDEX tracking numbers including check digit routines when applicable. Please insure that all tracking numbers you submit are correctly formatted. Any shipment confirmation message containing invalid tracking numbers will be rejected.

HL Pack

OptionalMax >1

Usage notes

This pack loop is not required to be provided if only cancellations or backorders are being reported.

Example: HL32*P

Variants (all may be used)

Item

HL

010

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*3*2*P*1~

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.

MAN

190

Marks and Numbers

OptionalMax use >1

To indicate identifying marks and numbers for shipping containers

Usage notes

Example: MANCP00000983767102803932

Example

MAN*CP*XXX~

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

This qualifier indicates that the MAN02 contains the tracking number for the package.

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

This element contains the tracking number for the package.

CommerceHub enforces validation rules for UPS and FEDEX tracking numbers including check digit routines when applicable. Please insure that all tracking numbers you submit are correctly formatted. Any shipment confirmation message containing invalid tracking numbers will be rejected.

HL Loop

RequiredMax >1

Usage notes

Example: HL43*I

HL

010

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*4*3*I*0~

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

Item Identification

RequiredMax use 1

To specify basic item identification data

Usage notes

Example: LIN02VN477631SK*11254

Example

LIN*XX*VN*XXXX*SK*XX~

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

This element must contain The Home Depot 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

This element contains the Vendor SKU for the product.

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)

This qualifier indicates that the LIN05 contains The Home Depot SKU.

LIN-05

234

Product/Service ID

Required

String (AN)

Min 1Max 48

Identifying number for a product or service

Usage notes

This element contains The Home Depot SKU for the product.

SN1

030

Item Detail (Shipment)

RequiredMax use 1

To specify line-item detail relative to shipment

Usage notes

Examples:
 
SN13EAAC (Shipment)
 
SN10EA**3EA**IR (Cancel)

Example

SN1**0000000000*EA**0***R1~

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

When shipping, this element must contain the number of units shipped. When cancelling, this element must contain a zero.

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

When shipping, this element is not required to be populated. When cancelling, this element must contain the number of units being cancelled.

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

When shipping, this element will always contain a value of AC. When cancelling, this element will contain one of the cancel codes listed.

AC

Item Accepted and Shipped

ID

Item Deleted

  1. merchant_request

IF

Item on Hold, Incomplete Description

  1. info_missing

IR

Item Rejected

  1. info_missing

R1

Item Rejected, Not a Contract Item

  1. discontinued

R2

Item Rejected, Invalid Item Product Number

  1. bad_sku

R4

Item Rejected, Contract Item not Available

  1. out_of_stock

Summary

CTT

010

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.

Usage notes

Example: CTT*1

Example

CTT*000~

CTT-01

354

Number of Line Items

Required

Numeric (N0)

Min 1Max 6

Total number of line items in the transaction set

SE

020

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*0000000000*0001~

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

GE

Functional Group Trailer

RequiredMax use 1

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

Example

GE*0000*0000~

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

IEA

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*000*000000000~

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

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article