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.

---

MESSAGE PURPOSE AND BUSINESS RULES:
The Shipment Confirmation message should convey the quantities of an order that were either shipped or canceled by the supplier. When shipped, the shipper and method of shipment must be communicated using a shipping method code, also a tracking number must be reported for each package shipped.

When canceled, a reason for cancellation is required.

Users should note that this guide supports both Standard Carton (Shipment, Order, Item, Pack) and PickPack (Shipment, Order, Pack, Item,) HL structures.

Standard Carton allows the flexibility to report shipments in the common one package per item structure as well as situation where an item is shipped in more than a single box. In this case, your BSN-05 would be equal to '0002' and you would then report the Shipment, Order, Item, Pack HL loops in that order.

If you only support the Pick-Pack structure, your BSN-05 must be equal to '0001' and you would then report the Shipment, Order, Pack and Item HL loops in that order.

Based on your individual requirements, you have the option to use either structure.

An integrated Fulfillment Confirmation message from the suppliers will be rejected for the following reasons:

• When the quantity stated as being shipped or canceled is greater than the quantity on the order.
• When the purchase order or line number does not match what is in CommerceHub.
• When the order has already been reported shipped or cancelled.
• When the merchant ID does not equal ‘signetjewelers’.
• When the tracking number is invalid.
• When the shipping method is missing or is not within the merchant specific
  table.
• When the shipping date is missing or less than order date or current date.

Delimiters

• ~ Segment
• * Element
• > Component

ISA Interchange Control Header

Required · Max use 1

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

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 10 Max 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 10 Max 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 2 Max 2

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

Codes

• 01: Duns (Dun & Bradstreet)
• 02: SCAC (Standard Carrier Alpha Code)
• 03: FMC (Federal Maritime Commission)
• 04: IATA (International Air Transport Association)
• 08: UCC EDI Communications ID (Comm ID)
• 09: X.121 (CCITT)
• 10: Department of Defense (DoD) Activity Address Code
• 11: DEA (Drug Enforcement Administration)
• 12: Phone (Telephone Companies)
• 13: UCS Code (The UCS Code is a Code Used for UCS Transmissions; it includes the Area Code and Telephone Number of a Modem; it Does Not Include Punctuation, Blanks or Access Code)
• 14: Duns Plus Suffix
• 15: Petroleum Accountants Society of Canada Company Code
• 16: Duns Number With 4-Character Suffix
• 17: American Bankers Association (ABA) Transit Routing Number (Including Check Digit, 9 Digit)
• 18: Association of American Railroads (AAR) Standard Distribution Code
• 19: EDI Council of Australia (EDICA) Communications ID Number (COMM ID)
• 20: Health Industry Number (HIN)
• 21: Integrated Postsecondary Education Data System, or (IPEDS)
• 22: Federal Interagency Commission on Education, or FICE
• 23: National Center for Education Statistics Common Core of Data 12-Digit Number for Pre-K-Grade 12 Institutes, or NCES
• 24: The College Board's Admission Testing Program 4-Digit Code of Postsecondary Institutes, or ATP
• 25: American College Testing Program 4-Digit Code of Postsecondary Institutions, or ACT
• 26: Statistics of Canada List of Postsecondary Institutions
• 27: Carrier Identification Number as assigned by Health Care Financing Administration (HCFA)
• 28: Fiscal Intermediary Identification Number as assigned by Health Care Financing Administration (HCFA)
• 29: Medicare Provider and Supplier Identification Number as assigned by Health Care Financing Administration (HCFA)
• 30: U.S. Federal Tax Identification Number
• 31: Jurisdiction Identification Number Plus 4 as assigned by the International Association of Industrial Accident Boards and Commissions (IAIABC)
• 32: U.S. Federal Employer Identification Number (FEIN)
• 33: National Association of Insurance Commissioners Company Code (NAIC)
• 34: Medicaid Provider and Supplier Identification Number as assigned by individual State Medicaid Agencies in conjunction with Health Care Financing Administration (HCFA)
• 35: Statistics Canada Canadian College Student Information System Institution Codes
• 36: Statistics Canada University Student Information System Institution Codes
• 37: Society of Property Information Compilers and Analysts
• AM: Association Mexicana del Codigo de Producto (AMECOP) Communication ID
• NR: National Retail Merchants Association (NRMA) - Assigned
• SN: Standard Address Number
• ZZ: Mutually Defined

ISA-06 · I06 · Interchange Sender ID · Required · String (AN) · Min 15 Max 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 2 Max 2

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

Codes

• 01: Duns (Dun & Bradstreet)
• 02: SCAC (Standard Carrier Alpha Code)
• 03: FMC (Federal Maritime Commission)
• 04: IATA (International Air Transport Association)
• 08: UCC EDI Communications ID (Comm ID)
• 09: X.121 (CCITT)
• 10: Department of Defense (DoD) Activity Address Code
• 11: DEA (Drug Enforcement Administration)
• 12: Phone (Telephone Companies)
• 13: UCS Code (The UCS Code is a Code Used for UCS Transmissions; it includes the Area Code and Telephone Number of a Modem; it Does Not Include Punctuation, Blanks or Access Code)
• 14: Duns Plus Suffix
• 15: Petroleum Accountants Society of Canada Company Code
• 16: Duns Number With 4-Character Suffix
• 17: American Bankers Association (ABA) Transit Routing Number (Including Check Digit, 9 Digit)
• 18: Association of American Railroads (AAR) Standard Distribution Code
• 19: EDI Council of Australia (EDICA) Communications ID Number (COMM ID)
• 20: Health Industry Number (HIN)
• 21: Integrated Postsecondary Education Data System, or (IPEDS)
• 22: Federal Interagency Commission on Education, or FICE
• 23: National Center for Education Statistics Common Core of Data 12-Digit Number for Pre-K-Grade 12 Institutes, or NCES
• 24: The College Board's Admission Testing Program 4-Digit Code of Postsecondary Institutes, or ATP
• 25: American College Testing Program 4-Digit Code of Postsecondary Institutions, or ACT
• 26: Statistics of Canada List of Postsecondary Institutions
• 27: Carrier Identification Number as assigned by Health Care Financing Administration (HCFA)
• 28: Fiscal Intermediary Identification Number as assigned by Health Care Financing Administration (HCFA)
• 29: Medicare Provider and Supplier Identification Number as assigned by Health Care Financing Administration (HCFA)
• 30: U.S. Federal Tax Identification Number
• 31: Jurisdiction Identification Number Plus 4 as assigned by the International Association of Industrial Accident Boards and Commissions (IAIABC)
• 32: U.S. Federal Employer Identification Number (FEIN)
• 33: National Association of Insurance Commissioners Company Code (NAIC)
• 34: Medicaid Provider and Supplier Identification Number as assigned by individual State Medicaid Agencies in conjunction with Health Care Financing Administration (HCFA)
• 35: Statistics Canada Canadian College Student Information System Institution Codes
• 36: Statistics Canada University Student Information System Institution Codes
• 37: Society of Property Information Compilers and Analysts
• AM: Association Mexicana del Codigo de Producto (AMECOP) Communication ID
• NR: National Retail Merchants Association (NRMA) - Assigned
• SN: Standard Address Number
• ZZ: Mutually Defined

ISA-08 · I07 · Interchange Receiver ID · Required · String (AN) · Min 15 Max 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 9 Max 9

A control number assigned by the interchange sender

ISA-14 · I13 · Acknowledgment Requested · Required · Identifier (ID) · Min 1 Max 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 1 Max 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 1 Max 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

Required · Max use 1

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

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 2 Max 15

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

GS-03 · 124 · Application Receiver's Code · Required · String (AN) · Min 2 Max 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 1 Max 9

Assigned number originated and maintained by the sender

GS-07 · 455 · Responsible Agency Code · Required · Identifier (ID) · Min 1 Max 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

010 Heading > ST

ST Transaction Set Header

Required · Max use 1

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

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 4 Max 9

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

020 Heading > BSN

BSN Beginning Segment for Ship Notice

Required · Max use 1

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

Usage notes

EXAMPLE: BSN00000000001200310161211*0002

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 2 Max 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 Required Max >1

010 Detail > HL Loop > HL

HL Hierarchical Level

Required · Max 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.

HL-01 · 628 · Hierarchical ID Number · Required · String (AN) · Min 1 Max 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.

120 Detail > HL Loop > TD5

TD5 Carrier Details (Routing Sequence/Transit Time)

Optional · Max 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 this segment is not required to be provided.

EXAMPLE: TD5B***UPSN_CG

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 1 Max 35

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

Usage notes

This element contains a Signet Jewelers 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.

200 Detail > HL Loop > DTM

DTM Date/Time Reference

Optional · Max use 10

To specify pertinent dates and times

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

Date expressed as CCYYMMDD

HL Loop Required Max >1

010 Detail > HL Loop > HL Loop > HL

HL Hierarchical Level

Required · Max 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.

HL-01 · 628 · Hierarchical ID Number · Required · String (AN) · Min 1 Max 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 1 Max 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.

050 Detail > HL Loop > HL Loop > PRF

PRF Purchase Order Reference

Required · Max use 1

To provide reference to a specific purchase order

Usage notes

EXAMPLE: PRF*1999999999

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

Identifying number for Purchase Order assigned by the orderer/purchaser

Usage notes

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

HL Loop Item Optional Max >1

Variants (all may be used)

HL Loop Pack

010 Detail > HL Loop > HL Loop > HL Loop Item > HL

HL Hierarchical Level

Required · Max 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.

HL-01 · 628 · Hierarchical ID Number · Required · String (AN) · Min 1 Max 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 1 Max 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.
• 1: Additional Subordinate HL Data Segment in This Hierarchical Structure.

020 Detail > HL Loop > HL Loop > HL Loop Item > LIN

LIN Item Identification

Required · Max use 1

To specify basic item identification data

Usage notes

EXAMPLE: LIN1VN*123456

LIN-01 · 350 · Assigned Identification · Required · String (AN) · Min 1 Max 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 1 Max 48

Identifying number for a product or service

Usage notes

Vendor's Item Number

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

SN1 Item Detail (Shipment)

Required · Max use 1

To specify line-item detail relative to shipment

Usage notes

SHIPMENT: SN13EAAC
CANCEL: SN10EA**3EA**ID
A 'ship' action is assumed if the SN1-08 code is omitted or not 'AC or 'ID'

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

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

REF Reference Identification

Optional · Max use >1

To specify identifying information

Usage notes

EXAMPLE: REFTDbad_sku*this sku does not exist

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

Code qualifying the Reference Identification

• TD: Reason for Change

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

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

Usage notes

Contact your CommerceHub Onboarding Specialist for the complete list of cancel codes.

REF-03 · 352 · Description · Optional · String (AN) · Min 1 Max 80

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

Usage notes

Additional freeform description of cancellation

HL Loop Optional Max >1

Usage notes

• Pack level HL is required for reporting tracking number(s) when item level SN1_08 = "AC"
• Pack level HL is required only when reporting tracking number(s) when item level SN1_08 = "AC"

010 Detail > HL Loop > HL Loop > HL Loop Item > HL Loop > HL

HL Hierarchical Level

Required · Max 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.

HL-01 · 628 · Hierarchical ID Number · Required · String (AN) · Min 1 Max 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 1 Max 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.

190 Detail > HL Loop > HL Loop > HL Loop Item > HL Loop > MAN

MAN Marks and Numbers

Optional · Max use >1

To indicate identifying marks and numbers for shipping containers

Usage notes

EXAMPLE: MANCPIZ9999999999999999

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

IMPORTANT NOTE: 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 Pack Optional Max >1

Variants (all may be used)

HL Loop Item

010 Detail > HL Loop > HL Loop > HL Loop Pack > HL

HL Hierarchical Level

Required · Max 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.

HL-01 · 628 · Hierarchical ID Number · Required · String (AN) · Min 1 Max 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 1 Max 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.

190 Detail > HL Loop > HL Loop > HL Loop Pack > MAN

MAN Marks and Numbers

Optional · Max use >1

To indicate identifying marks and numbers for shipping containers

Usage notes

EXAMPLE: MANCPIZ9999999999999999

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

IMPORTANT NOTE: 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 Required Max >1

Usage notes

• Pack level HL is required for reporting tracking number(s) when item level SN1_08 = "AC"
• Pack level HL is required only when reporting tracking number(s) when item level SN1_08 = "AC"

010 Detail > HL Loop > HL Loop > HL Loop Pack > HL Loop > HL

HL Hierarchical Level

Required · Max 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.

HL-01 · 628 · Hierarchical ID Number · Required · String (AN) · Min 1 Max 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 1 Max 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.

020 Detail > HL Loop > HL Loop > HL Loop Pack > HL Loop > LIN

LIN Item Identification

Required · Max use 1

To specify basic item identification data

Usage notes

EXAMPLE: LIN1VN*123456

LIN-01 · 350 · Assigned Identification · Required · String (AN) · Min 1 Max 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 1 Max 48

Identifying number for a product or service

Usage notes

Vendor's Item Number

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

SN1 Item Detail (Shipment)

Required · Max use 1

To specify line-item detail relative to shipment

Usage notes

SHIPMENT: SN13EAAC
CANCEL: SN10EA**3EA**ID
A 'ship' action is assumed if the SN1-08 code is omitted or not 'AC or 'ID'

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

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

REF Reference Identification

Optional · Max use >1

To specify identifying information

Usage notes

EXAMPLE: REFTDbad_sku*this sku does not exist

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

Code qualifying the Reference Identification

• TD: Reason for Change

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

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

Usage notes

Contact your CommerceHub Onboarding Specialist for the complete list of cancel codes.

REF-03 · 352 · Description · Optional · String (AN) · Min 1 Max 80

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

Usage notes

Additional freeform description of cancellation

Summary

020 Summary > SE

SE Transaction Set Trailer

Required · Max 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)

SE-01 · 96 · Number of Included Segments · Required · Numeric (N0) · Min 1 Max 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 4 Max 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

Required · Max use 1

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

GE-01 · 97 · Number of Transaction Sets Included · Required · Numeric (N0) · Min 1 Max 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 1 Max 9

Assigned number originated and maintained by the sender

IEA Interchange Control Trailer

Required · Max use 1

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

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

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

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

A control number assigned by the interchange sender