X12 870 Order Status Report

X12 Release 4010

This Draft Standard for Trial Use contains the format and establishes the data contents of the Order Status Report Transaction Set (870) for use within the context of an Electronic Data Interchange (EDI) environment. The transaction set can be used to report on the current status of a requirement forecast, an entire purchase order, selected line items on a purchase order, selected products/services on a purchase order, or purchase orders for a specific customer in their entirety or on a selection basis. The transaction set can also be used to report on the current status of single or multiple requisitions. The report format allows for the inclusion of "reasons" relative to the status. This transaction set may also be used to update the supplier's scheduled shipment or delivery dates. This transaction set can result from either an inquiry or a prearranged schedule agreed to by the trading partners.

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

• RS: Order Status Information (869, 870)

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

• 870: Order Status Report

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

BSR Beginning Segment for Order Status Report

Required · Max use 1

To indicate the beginning of an Order Status Report Transaction Set

BSR-01 · 850 · Status Report Code · Required · Identifier (ID)

Code indicating the reason for sending the report

• 3: Unsolicited Report

BSR-02 · 847 · Order/Item Code · Required · Identifier (ID)

Code identifying a group of orders and items

• PA: Selected Orders - All Items

BSR-03 · 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

• BSR03 indicates a status report document number assigned by the sender.

Usage notes

Each 870 sent needs to have a unique report # provided. 870’s sent with duplicate report #’s will be rejected.

BSR-04 · 373 · Date · Required · Date (DT) · CCYYMMDD format

Date expressed as CCYYMMDD

• BSR04 indicates the date of this report from the sender.

REF Loop Required Max >1

046 Heading > REF Loop > REF

REF Reference Identification

Required · Max use 1

To specify identifying information

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

Code qualifying the Reference Identification

• VR: Vendor ID Number

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

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

N1 Loop Ordered By Required Max >1

Variants (all may be used)

N1 Loop Ship To

050 Heading > N1 Loop Ordered By > N1

N1 Name

Required · Max use 1

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

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

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

• OB: Ordered By
  This should contain the value from the N102 - OB of the 850.

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

Free-form name

Usage notes

Menard 4-digit Location Number or Guest name on Guest direct shipments.

N1 Loop Ship To Required Max 1

Variants (all may be used)

N1 Loop Ordered By

050 Heading > N1 Loop Ship To > N1

N1 Name

Required · Max use 1

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

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

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

• ST: Ship To
  This should contain the value from the N102 – ST or BS of the 850.

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

Free-form name

Usage notes

Menard 4-digit Location Number or Guest name on Guest direct shipments.

Detail

HL Loop Order Required Max >1

010 Detail > HL Loop Order > HL

HL Hierarchical Level

Required · Max use 1

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

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.

• O: Order

HL-04 · 736 · Hierarchical Child Code · Optional · Identifier (ID)

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

• HL04 indicates whether or not there are subordinate (or child) HL segments related to the current HL segment.

• 1: Additional Subordinate HL Data Segment in This Hierarchical Structure.

020 Detail > HL Loop Order > PRF

PRF Purchase Order Reference

Required · Max use 1

To provide reference to a specific purchase order

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

PO # from the BEG03 of the 850.

ISR Loop Required Max >1

030 Detail > HL Loop Order > ISR Loop > ISR

ISR Item Status Report

Required · Max use 1

To specify detailed purchase order/item status

ISR-01 · 368 · Shipment/Order Status Code · Required · Identifier (ID)

Code indicating the status of an order or shipment or the disposition of any difference between the quantity ordered and the quantity shipped for a line item or transaction

• If ISR01 specifies a date, ISR02 is required.

• CC: Shipped in full to Menard
  Required

  Sent when the order has shipped complete or the remainder of a partially shipped order has shipped complete to a Menards location.

• DD: Shipped in full to Guest
  Required

  Sent when the order has shipped complete or the remainder of a partially shipped order has shipped complete to our guest or their jobsite location.

• DE: Deleted Order
  Conditional

  Confirmation that the order has been canceled in your system. Should be sent after communication of your intentions with the ordering location.

• ED: Expect to Ship By (Date)
  Required

  Sent when an expected ship date is known or previously provided expected ship date has changed for the order. Should be sent within 1 business day of the order being transmitted.

• IN: In Process
  Conditional

  Sent if ED status date not known within 1 business day of Menards transmitting the order. ED should be sent ASAP afterwards.

• PR: Partial Shipment
  Conditional

  Sent when part of the order is being shipped with the remainder to follow on a future shipment.

  • If an order/item is being short shipped and there will be no future shipments, the corresponding CC or DD status should be provided on the order/item.
  • PR status should only be sent if future shipment will be made against order/items.

ISR-02 · 373 · Date · Required · Date (DT) · CCYYMMDD format

Date expressed as CCYYMMDD

Usage notes

All status dates should be the date the status was reached with the exception of the ED status, the ED status date should be the actual expected ship date for the order.

HL Loop Item Required Max >1

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

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.

PO1 Loop Required Max >1

150 Detail > HL Loop Order > HL Loop Item > PO1 Loop > PO1

PO1 Baseline Item Data

Required · Max use 1

To specify basic and most frequently used line item data

PO1-01 · 350 · Assigned Identification · Required · String (AN) · Min 1 Max 20

Alphanumeric characters assigned for differentiation within a transaction set

• PO101 is the line item identification.

Usage notes

Sequence # received in the PO101 of the 850 should be returned in the PO101 of the 870 for each line item.

PO1-02 · 330 · Quantity Ordered · Required · Decimal number (R) · Min 1 Max 15

Quantity ordered

Usage notes

Order QTY from the PO102 of the 850 needs to be returned in the PO102 of the 870 for each line item.

PO1-03 · 355 · Unit or Basis for Measurement Code · Required · Identifier (ID) · Min 2 Max 2

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

Usage notes

Ordering UOM from the PO103 of the 850 needs to be returned in the PO103 of the 870 for each line item.

PO1-06 · 235 · Product/Service ID Qualifier · Required · Identifier (ID)

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

• PO106 through PO125 provide for ten different product/service IDs per each item. For example: Case, Color, Drawing No., U.P.C. No., ISBN No., Model No., or SKU.

• SK: Stock Keeping Unit (SKU)

PO1-07 · 234 · Product/Service ID · Required · String (AN) · Min 1 Max 48

Identifying number for a product or service

Usage notes

SKU # from the PO107 of the 850 needs to be returned in the PO107 of the 870 for each line item.

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

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

• VP: Vendor's (Seller's) Part Number

PO1-09 · 234 · Product/Service ID · Required · String (AN) · Min 1 Max 48

Identifying number for a product or service

180 Detail > HL Loop Order > HL Loop Item > PO1 Loop > PID

PID Product/Item Description

Required · Max use 1000

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

PID-01 · 349 · Item Description Type · Required · Identifier (ID)

Code indicating the format of a description

• If PID01 equals "F", then PID05 is used. If PID01 equals "S", then PID04 is used. If PID01 equals "X", then both PID04 and PID05 are used.

• F: Free-form

PID-05 · 352 · Description · Required · String (AN) · Min 1 Max 80

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

ISR Loop Required Max >1

210 Detail > HL Loop Order > HL Loop Item > PO1 Loop > ISR Loop > ISR

ISR Item Status Report

Required · Max use 1

To specify detailed purchase order/item status

ISR-01 · 368 · Shipment/Order Status Code · Required · Identifier (ID) · Min 2 Max 2

Code indicating the status of an order or shipment or the disposition of any difference between the quantity ordered and the quantity shipped for a line item or transaction

• If ISR01 specifies a date, ISR02 is required.

ISR-02 · 373 · Date · Optional · Date (DT) · CCYYMMDD format

Date expressed as CCYYMMDD

230 Detail > HL Loop Order > HL Loop Item > PO1 Loop > ISR Loop > QTY

QTY Quantity

Optional · Max use 4

To specify quantity information

Usage notes

(Shipment or Cancellation Status Only)

QTY-01 · 673 · Quantity Qualifier · Required · Identifier (ID)

Code specifying the type of quantity

• 39: Shipped Quantity
• QV: Quantity Cancelled

QTY-02 · 380 · Quantity · Required · Decimal number (R) · Min 1 Max 15

Numeric value of quantity

250 Detail > HL Loop Order > HL Loop Item > PO1 Loop > ISR Loop > N1

N1 Name

Optional · Max use 1

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

Usage notes

(Shipment Status Only)

If either Identification Code Qualifier (N1-03) or Identification Code (N1-04) is present, then the other is required

At least one of Name (N1-02) or Identification Code Qualifier (N1-03) is required

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

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

• CN: General Contact

N1-02 · 93 · Name · Optional · String (AN) · Min 1 Max 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)

• 12: Telephone Number (Phone)

N1-04 · 67 · Identification Code · Optional · String (AN) · Min 2 Max 80

Code identifying a party or other code

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

Usage notes

10 Digit Contact Phone #. No parentheses or dashes.

270 Detail > HL Loop Order > HL Loop Item > PO1 Loop > ISR Loop > TD5

TD5 Carrier Details (Routing Sequence/Transit Time)

Optional · Max use 1

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

Usage notes

(Shipment Status Only)

TD5-05 · 387 · Routing · Required · 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

Hauler Name

300 Detail > HL Loop Order > HL Loop Item > PO1 Loop > ISR Loop > REF

REF Reference Identification Bill of Lading Number

Optional · Max use 1

To specify identifying information

Usage notes

Use/provide only 1 qualifier / tracking number per line item. (Shipment Status Only)

Variants (all may be used)

REFReference Identification Carrier Assigned CodeREFReference Identification Tracking Number

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

Code qualifying the Reference Identification

• BM: Bill of Lading Number
  When shipping via common carrier.

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

300 Detail > HL Loop Order > HL Loop Item > PO1 Loop > ISR Loop > REF

REF Reference Identification Carrier Assigned Code

Optional · Max use 1

To specify identifying information

Usage notes

Use/provide only 1 qualifier / tracking number per line item. (Shipment Status Only)

Variants (all may be used)

REFReference Identification Bill of Lading NumberREFReference Identification Tracking Number

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

Code qualifying the Reference Identification

• AAO: Carrier Assigned Code
  Only when shipping via common carrier and; BOL# is not available.

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

300 Detail > HL Loop Order > HL Loop Item > PO1 Loop > ISR Loop > REF

REF Reference Identification Tracking Number

Optional · Max use 12

To specify identifying information

Usage notes

Use/provide only 1 qualifier / tracking number per line item. (Shipment Status Only)

Variants (all may be used)

REFReference Identification Bill of Lading NumberREFReference Identification Carrier Assigned Code

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

Code qualifying the Reference Identification

• 2I: Tracking Number
  Small parcel shipments (Fed Ex, etc).

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

Summary

010 Summary > CTT

CTT Transaction Totals

Required · Max use 1

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

• The 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 quantities ordered (PO102) for each PO1 segment.

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

Total number of line items in the transaction set

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

EDI Samples

(CC Status) Order Shipping to Menards Location

ISA*00*          *00*          *ZZ*SENDER         *ZZ*RECEIVER       *240531*0058*U*00401*000000001*0*T*>~
GS*RS*SENDERGS*RECEIVERGS*20240531*005815*000000001*X*004010~
ST*870*0001~
BSR*3*PA*UNIQUE VENDOR DEFINED #*20120311~
REF*VR*WIDGE001~
N1*OB*3011~
N1*ST*3011~
HL*1**O~
PRF*ECWE29999999~
ISR*CC*20120311~
HL*2*1*I~
PO1*1*28*EA***SK*1004567*VP*1234ABCD~
PID*F****HIGH QUALITY WIDGET~
ISR*CC*20120311~
QTY*39*8~
N1*CN*CUSTOMER SERVICE*12*1234567890~
TD5*****JB HUNT~
REF*BM*1234567890~
CTT*1~
SE*18*0001~
GE*1*000000001~
IEA*1*000000001~

(CC/DD Status) Order Shipping Direct to Guest

ISA*00*          *00*          *ZZ*SENDER         *ZZ*RECEIVER       *240531*0110*U*00401*000000001*0*T*>~
GS*RS*SENDERGS*RECEIVERGS*20240531*011028*000000001*X*004010~
ST*870*0001~
BSR*3*PA*UNIQUE VENDOR DEFINED #*20120310~
REF*VR*WIDGE001~
N1*OB*3200~
N1*ST*SMITH, BOB~
HL*1**O~
PRF*KRNY39999999~
ISR*DD*20120310~
HL*2*1*I~
PO1*2*1*EA***SK*1001234*VP*ABC123~
PID*F****ABC123~
ISR*DD*20120310~
QTY*39*4~
N1*CN*CUSTOMER SERVICE*12*1234567890~
TD5*****FED EX~
REF*2I*9876543210~
PO1*5*2*EA***SK*2001234*VP*DEF456~
PID*F****DEF456~
ISR*DE*20120310~
QTY*QV*39~
CTT*1~
SE*22*0001~
GE*1*000000001~
IEA*1*000000001~

(CC/DD Status) Order Shipping to Menards Location

ISA*00*          *00*          *ZZ*SENDER         *ZZ*RECEIVER       *240531*0108*U*00401*000000001*0*T*>~
GS*RS*SENDERGS*RECEIVERGS*20240531*010834*000000001*X*004010~
ST*870*0001~
BSR*3*PA*UNIQUE VENDOR DEFINED #*20120310~
REF*VR*WIDGE001~
N1*OB*3011~
N1*ST*3011~
HL*1**O~
PRF*ECWE29999999~
ISR*CC*20120310~
HL*2*1*I~
PO1*1*28*EA***SK*1004567*VP*1234ABCD~
PID*F****HIGH QUALITY WIDGET~
ISR*CC*20120310~
QTY*39*28~
N1*CN*CUSTOMER SERVICE*12*1234567890~
TD5*****JB HUNT~
REF*BM*1234567890~
HL*3*1*I~
PO1*2*15*EA***SK*1006789*VP*1235ABCD~
PID*F****SUPER GADGET~
ISR*DE*20120310~
QTY*QV*15~
CTT*2~
SE*23*0001~
GE*1*000000001~
IEA*1*000000001~

(DD Status) Order Shipping Direct to Guest

ISA*00*          *00*          *ZZ*SENDER         *ZZ*RECEIVER       *240531*0100*U*00401*000000001*0*T*>~
GS*RS*SENDERGS*RECEIVERGS*20240531*010038*000000001*X*004010~
ST*870*0001~
BSR*3*PA*UNIQUE VENDOR DEFINED #*20120311~
REF*VR*VENDR001~
N1*OB*3156~
N1*ST*SMITH, BOB~
HL*1**O~
PRF*LAFS39999999~
ISR*DD*20120311~
HL*2*1*I~
PO1*5*2*EA***SK*2001234*VP*DEF456~
PID*F****DEF456~
ISR*DD*20120311~
QTY*39*12~
N1*CN*CUSTOMER SERVICE*12*1234567890~
TD5*****FED EX~
REF*2I*5432112345~
CTT*1~
SE*18*0001~
GE*1*000000001~
IEA*1*000000001~

(ED Status Backorders Canceled) Order Shipping Direct to Guest

ISA*00*          *00*          *ZZ*SENDER         *ZZ*RECEIVER       *240531*0105*U*00401*000000001*0*T*>~
GS*RS*SENDERGS*RECEIVERGS*20240531*010557*000000001*X*004010~
ST*870*0001~
BSR*3*PA*UNIQUE VENDOR DEFINED #*20120302~
REF*VR*WIDGE001~
N1*OB*3200~
N1*ST*SMITH, BOB~
HL*1**O~
PRF*KRNY39999999~
ISR*ED*20120310~
HL*2*1*I~
PO1*2*1*EA***SK*1001234*VP*ABC123~
PID*F****ABC123~
ISR*ED*20120310~
HL*3*1*I~
PO1*5*2*EA***SK*2001234*VP*DEF456~
PID*F****DEF456~
ISR*DE*20120302~
QTY*QV*2~
CTT*2~
SE*19*0001~
GE*1*000000001~
IEA*1*000000001~

(ED Status Backorders Canceled) Order Shipping to Menards Location

ISA*00*          *00*          *ZZ*SENDER         *ZZ*RECEIVER       *240531*0102*U*00401*000000001*0*T*>~
GS*RS*SENDERGS*RECEIVERGS*20240531*010256*000000001*X*004010~
ST*870*0001~
BSR*3*PA*UNIQUE VENDOR DEFINED #*20120302~
REF*VR*WIDGE001~
N1*OB*3011~
N1*ST*3011~
HL*1**O~
PRF*ECWE29999999~
ISR*ED*20120310~
HL*2*1*I~
PO1*1*28*EA***SK*1004567*VP*1234ABCD~
PID*F****HIGH QUALITY WIDGET~
ISR*ED*20120310~
HL*3*1*I~
PO1*2*15*EA***SK*1006789*VP*1235ABCD~
PID*F****SUPER GADGET~
ISR*DE*20120302~
QTY*QV*15~
CTT*2~
SE*19*0001~
GE*1*000000001~
IEA*1*000000001~

(ED Status Expected Ship Date) Order Shipping Direct to Guest

ISA*00*          *00*          *ZZ*SENDER         *ZZ*RECEIVER       *240531*0052*U*00401*000000001*0*T*>~
GS*RS*SENDERGS*RECEIVERGS*20240531*005211*000000001*X*004010~
ST*870*0001~
BSR*3*PA*UNIQUE VENDOR DEFINED #*20120302~
REF*VR*WIDGE001~
N1*OB*3200~
N1*ST*SMITH, BOB~
HL*1**O~
PRF*KRNY39999999~
ISR*ED*20120310~
HL*2*1*I~
PO1*2*1*EA***SK*1001234*VP*ABC123~
PID*F****ABC123~
ISR*ED*20120310~
HL*3*1*I~
PO1*5*2*EA***SK*2001234*VP*DEF456~
PID*F****DEF456~
ISR*ED*20120310~
CTT*2~
SE*18*0001~
GE*1*000000001~
IEA*1*000000001~

(ED Status Expected Ship Date) Order Shipping to Menards Location

ISA*00*          *00*          *ZZ*SENDER         *ZZ*RECEIVER       *240531*0045*U*00401*000000001*0*T*>~
GS*RS*SENDERGS*RECEIVERGS*20240531*004557*000000001*X*004010~
ST*870*0001~
BSR*3*PA*UNIQUE VENDOR DEFINED #*20120302~
REF*VR*WIDGE001~
N1*OB*3011~
N1*ST*3011~
HL*1**O~
PRF*ECWE29999999~
ISR*ED*20120310~
HL*2*1*I~
PO1*1*28*EA***SK*1004567*VP*1234ABCD~
PID*F****HIGH QUALITY WIDGET~
ISR*ED*20120310~
HL*3*1*I~
PO1*2*15*EA***SK*1006789*VP*1235ABCD~
PID*F****SUPER GADGET~
ISR*ED*20120310~
CTT*2~
SE*18*0001~
GE*1*000000001~
IEA*1*000000001~

(IN Status) Order Shipping Direct to Guest

ISA*00*          *00*          *ZZ*SENDER         *ZZ*RECEIVER       *240531*0034*U*00401*000000001*0*T*>~
GS*RS*SENDERGS*RECEIVERGS*20240531*003442*000000001*X*004010~
ST*870*0001~
BSR*3*PA*UNIQUE VENDOR DEFINED #*20120302~
REF*VR*WIDGE001~
N1*OB*3200~
N1*ST*SMITH, BOB~
HL*1**O~
PRF*KRNY39999999~
ISR*IN*20120302~
HL*2*1*I~
PO1*2*1*EA***SK*1001234*VP*ABC123~
PID*F****ABC123~
ISR*IN*20120302~
HL*3*1*I~
PO1*5*2*EA***SK*2001234*VP*DEF456~
PID*F****HIGH QUALITY WIDGET~
ISR*IN*20120302~
CTT*2~
SE*18*0001~
GE*1*000000001~
IEA*1*000000001~

(IN Status) Order Shipping to Menards Location

ISA*00*          *00*          *ZZ*SENDER         *ZZ*RECEIVER       *240531*0025*U*00401*000000001*0*T*>~
GS*RS*SENDERGS*RECEIVERGS*20240531*002503*000000001*X*004010~
ST*870*0001~
BSR*3*PA*UNIQUE VENDOR DEFINED #*20120302~
REF*VR*WIDGE001~
N1*OB*3011~
N1*ST*3011~
HL*1**O~
PRF*ECWE29999999~
ISR*IN*20120302~
HL*2*1*I~
PO1*1*28*EA***SK*1004567*VP*1234ABCD~
PID*F****HIGH QUALITY WIDGET~
ISR*IN*20120302~
HL*3*1*I~
PO1*2*15*EA***SK*1006789*VP*1235ABCD~
PID*F****SUPER GADGET~
ISR*IN*20120302~
CTT*2~
SE*18*0001~
GE*1*000000001~
IEA*1*000000001~

(PR Status) Order Shipping Direct to Guest

ISA*00*          *00*          *ZZ*SENDER         *ZZ*RECEIVER       *240531*0056*U*00401*000000001*0*T*>~
GS*RS*SENDERGS*RECEIVERGS*20240531*005634*000000001*X*004010~
ST*870*0001~
BSR*3*PA*UNIQUE VENDOR DEFINED #*20120310~
REF*VR*WIDGE001~
N1*OB*3200~
N1*ST*SMITH, BOB~
HL*1**O~
PRF*KRNY39999999~
ISR*PR*20120310~
HL*2*1*I~
PO1*2*1*EA***SK*1001234*VP*ABC123~
PID*F****ABC123~
ISR*DD*20120310~
QTY*39*4~
N1*CN*CUSTOMER SERVICE*12*1234567890~
TD5*****FED EX~
REF*2I*9876543210~
CTT*1~
SE*18*0001~
GE*1*000000001~
IEA*1*000000001~

(PR Status) Order Shipping to Menards Location

ISA*00*          *00*          *ZZ*SENDER         *ZZ*RECEIVER       *240531*0054*U*00401*000000001*0*T*>~
GS*RS*SENDERGS*RECEIVERGS*20240531*005457*000000001*X*004010~
ST*870*0001~
BSR*3*PA*UNIQUE VENDOR DEFINED #*20120310~
REF*VR*WIDGE001~
N1*OB*3011~
N1*ST*3011~
HL*1**O~
PRF*ECWE29999999~
ISR*PR*20120310~
HL*2*1*I~
PO1*1*28*EA***SK*1004567*VP*1234ABCD~
PID*F****HIGH QUALITY WIDGET~
ISR*PR*20120310~
QTY*39*20~
N1*CN*CUSTOMER SERVICE*12*1234567890~
TD5*****JB HUNT~
REF*BM*1234567890~
HL*3*1*I~
PO1*2*15*EA***SK*1006789*VP*1235ABCD~
PID*F****SUPER GADGET~
ISR*CC*20120310~
QTY*39*15~
N1*CN*CUSTOMER SERVICE*12*1234567890~
TD5*****JB HUNT~
REF*BM*1234509876~
CTT*2~
SE*26*0001~
GE*1*000000001~
IEA*1*000000001~