X12 870 Order Status Report

X12 Release 3010

This standard provides the format and establishes the data contents of an order status report transaction set. The order status report transaction set provides the ability to report on the current status of 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 report format allows for the inclusion of ``reasons'' relative to the status of the purchase order(s). This transaction set may also be used to update the supplier's scheduled shipment or delivery date(s). This transaction set can result from either an inquiry (via the Order Status Inquiry Transaction Set [869]) or a prearranged schedule agreed to by the trading partners.

Delimiters

• ~ Segment
• * Element
• > Component

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 12

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

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

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

GS-04 · 29 · Group Date · Required · Date (DT) · YYMMDD format

Date sender generated a functional group of transaction sets.

GS-05 · 30 · Group Time · Required · Time (TM) · HHMM format

Time (HHMM) when the sender generated a functional group of transaction sets (local time at sender's location).

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 · Identifier (ID)

Code indicating the version, release, subrelease and industry identifier of the EDI standard being used. Positions 1-3, version number; positions 4-6, release and subrelease level of version; positions 7-12, industry or trade association identifier (optionally assigned by user).

• 003010: Draft Standards Approved By ASC X12 Through June 1990.

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) is intended for use by the translation routines of the interchange partners to select the appropriate transaction set definition (e.g., 810 selects the invoice transaction set).

• 870: X12.23 Order Status Report

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

Identifying control number 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.

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

Code indicating the reason for sending the report

• 1: Response to an Order Status Inquiry (869)
• 2: Prearranged Schedule or Agreement
• 3: Unsolicited Report

BSR-02 · 847 · Order/Item Code · Required · Identifier (ID) · Min 1 Max 2

Code identifying a group of orders and items.

BSR-03 · 127 · Reference Number · Required · String (AN) · Min 1 Max 30

Reference number or identification number as defined for a particular Transaction Set, or as specified by the Reference Number Qualifier.

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

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

Date (YYMMDD).

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

030 Heading > NTE

NTE Note/Special Instruction

Optional · Max use 100

To transmit information in a free-form format, if necessary, for comment or special instruction

NTE-01 · 363 · Note Reference Code · Optional · Identifier (ID) · Min 3 Max 3

Code identifying the functional area or purpose for which the note applies.

NTE-02 · 3 · Free Form Message · Required · String (AN) · Min 1 Max 60

Free-form text.

040 Heading > REF

REF Reference Numbers

Optional · Max use 12

To specify identifying numbers.

REF-01 · 128 · Reference Number Qualifier · Required · Identifier (ID) · Min 2 Max 2

Code qualifying the Reference Number.

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

Reference number or identification number as defined for a particular Transaction Set, or as specified by the Reference Number Qualifier.

• Either REF02 or REF03 is required.

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

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

N1 Loop Optional Max 200

050 Heading > N1 Loop > N1

N1 Name

Required · Max use 1

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

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

Code identifying an organizational entity or a physical location.

• At least one of N102 or N103 must be present.

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

Free-form name.

• If either N103 or N104 is present, then the other is required.

N1-03 · 66 · Identification Code Qualifier · Optional · Identifier (ID) · Min 1 Max 2

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

N1-04 · 67 · Identification Code · Optional · Identifier (ID) · Min 2 Max 17

Code identifying a party.

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

Detail

HL Loop Order Required Max 1000

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 whether 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 Order > PRF

PRF Purchase Order Reference

Optional · 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.

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

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

PRF-04 · 323 · Purchase Order Date · Optional · Date (DT) · YYMMDD format

Date assigned by the purchaser to Purchase Order.

060 Detail > HL Loop Order > REF

REF Reference Numbers

Optional · Max use 12

To specify identifying numbers.

REF-01 · 128 · Reference Number Qualifier · Required · Identifier (ID) · Min 2 Max 2

Code qualifying the Reference Number.

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

Reference number or identification number as defined for a particular Transaction Set, or as specified by the Reference Number Qualifier.

• Either REF02 or REF03 is required.

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

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

080 Detail > HL Loop Order > DTM

DTM Date/Time Reference

Optional · Max use 10

To specify pertinent dates and times

DTM-01 · 374 · Date/Time Qualifier · Optional · Identifier (ID)

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

• At least one of DTM02 or DTM03 must be present.

• 168: Release

DTM-02 · 373 · Date · Optional · Date (DT) · YYMMDD format

Date (YYMMDD).

PO1 Loop Required Max 1000

150 Detail > HL Loop Order > PO1 Loop > PO1

PO1 Purchase Order Baseline Item Data

Required · Max use 1

To specify basic and most frequently used purchase order line item data

If Unit Price (PO1-04) is present, then Basis of Unit Price Code (PO1-05) is required

If Product/Service ID Qualifier (PO1-06) is present, then Product/Service ID (PO1-07) is required

If Product/Service ID Qualifier (PO1-08) is present, then Product/Service ID (PO1-09) is required

If Product/Service ID (PO1-07) is present, then Product/Service ID Qualifier (PO1-06) is required

If either Product/Service ID Qualifier (PO1-08) or Product/Service ID (PO1-09) is present, then the other is required

If either Product/Service ID Qualifier (PO1-10) or Product/Service ID (PO1-11) is present, then the other is required

PO1-01 · 350 · Assigned Identification · Optional · String (AN) · Min 1 Max 6

Alphanumeric characters assigned for differentiation within a transaction set.

• PO101 is the line item identification
• If PO105 is present, then PO104 is required.

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

Quantity ordered.

• If PO106 is present, then PO107 is required.

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

Code identifying the basic unit of measurement.

• If PO108 is present, then PO109 is required.

PO1-04 · 212 · Unit Price · Optional · Decimal number (R) · Min 1 Max 14

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

• If PO110 is present, then PO111 is required.

PO1-05 · 639 · Basis of Unit Price Code · Optional · Identifier (ID) · Min 2 Max 2

Code identifying the type of unit price for an item.

• If PO112 is present, then PO113 is required.

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

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

• PO106 through PO125 provide for ten (10) different product/service ID's per each item. For example: Case, Color, Drawing No., UPC No., ISBN No., Model No., SKU.
• If PO114 is present, then PO115 is required.

• BP: Buyer's Part Number

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

Identifying number for a product or service.

• If PO116 is present, then PO117 is required.

PO1-08 · 235 · Product/Service ID Qualifier · Optional · Identifier (ID) · Min 2 Max 2

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

• If PO118 is present, then PO119 is required.

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

Identifying number for a product or service.

• If PO120 is present, then PO121 is required.

PO1-10 · 235 · Product/Service ID Qualifier · Optional · Identifier (ID)

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

• If PO122 is present, then PO123 is required.

• RN: Release Number

PO1-11 · 234 · Product/Service ID · Optional · String (AN) · Min 1 Max 30

Identifying number for a product or service.

• If PO124 is present, then PO125 is required.

ISR Loop Required Max 104

210 Detail > HL Loop Order > 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) · YYMMDD format

Date (YYMMDD).

ISR-03 · 641 · Status Reason Code · Optional · Identifier (ID) · Min 3 Max 3

Code indicating the status reason.

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

QTY Quantity

Optional · Max use 4

To specify quantity information.

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

Code specifying the type of quantity.

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

Numeric value of quantity.

QTY-03 · 355 · Unit of Measurement Code · Optional · Identifier (ID) · Min 2 Max 2

Code identifying the basic unit of measurement.

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

N1 Name

Optional · Max use 1

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

If Entity Identifier Code (N1-01) is present, then Identification Code (N1-04) is required

If Entity Identifier Code (N1-01) is present, then at least one of Name (N1-02) or Identification Code Qualifier (N1-03) is required

If Identification Code (N1-04) is present, then Entity Identifier Code (N1-01) is required

If Identification Code Qualifier (N1-03) is present, then Entity Identifier Code (N1-01) is required

If Name (N1-02) is present, then Entity Identifier Code (N1-01) is required

N1-01 · 98 · Entity Identifier Code · Optional · Identifier (ID) · Min 2 Max 2

Code identifying an organizational entity or a physical location.

• At least one of N102 or N103 must be present.

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

Free-form name.

• If either N103 or N104 is present, then the other is required.

N1-03 · 66 · Identification Code Qualifier · Optional · Identifier (ID) · Min 1 Max 2

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

N1-04 · 67 · Identification Code · Optional · Identifier (ID) · Min 2 Max 17

Code identifying a party.

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

260 Detail > HL Loop Order > PO1 Loop > ISR Loop > TD1

TD1 Carrier Details (Quantity and Weight)

Optional · Max use 1

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

If either Commodity Code (TD1-04) or Weight Qualifier (TD1-06) is present, then the other is required

TD1-02 · 80 · Lading Quantity · Optional · Numeric (N0) · Min 1 Max 7

Number of units (pieces) of the lading commodity.

• If TD103 is present, then TD104 is required.

TD1-04 · 22 · Commodity Code · Optional · Identifier (ID) · Min 1 Max 16

Code describing a commodity or group of commodities.

TD1-06 · 187 · Weight Qualifier · Optional · Identifier (ID) · Min 1 Max 2

Code defining the type of weight.

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

REF Reference Numbers

Optional · Max use 12

To specify identifying numbers.

REF-01 · 128 · Reference Number Qualifier · Required · Identifier (ID) · Min 2 Max 2

Code qualifying the Reference Number.

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

Reference number or identification number as defined for a particular Transaction Set, or as specified by the Reference Number Qualifier.

• Either REF02 or REF03 is required.

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

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

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.

• If CTT03 is present, then CTT04 is required.

CTT-02 · 347 · Hash Total · Required · Decimal number (R) · Min 1 Max 10

Sum of values of the specified data element. All values in the data element will be summed without regard to decimal points (explicit or implicit) or signs. Truncation will occur on the left most digits if the sum is greater than the maximum size of the hash total of the data element.

## Example:
-.0018 First occurrence of value being hashed.
.18 Second occurrence of value being hashed.
1.8 Third occurrence of value being hashed.
18.01 Fourth occurrence of value being hashed.

1855 Hash total prior to truncation.
855 Hash total after truncation to three-digit field.

• If CTT05 is present, then CTT06 is required.

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 6

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

EDI Samples

sample 1

ISA*00*          *00*          *ZZ*BTCXA          *ZZ*F159B          *240311*1623*U*00200*000254854*0*P*^~
GS*RS*BTCXA*AF1CC*240311*1623*254855*X*003010~
ST*870*0001~
BSR*2*PO*2403111623*240311~
N1*BY**92*AF1CC~
N1*SE**92*BTCXA~
HL*1**O~
PRF*YG0ZQ0***240312~
REF*IT*09049~
REF*CR*1468204~
PO1*1*1*EA***BP*VFL3Z 84501A42 EA~
ISR*EA*240314~
QTY*01*1*EA~
CTT*1*1~
SE*13*0001~
GE*1*254855~
IEA*1*000254854~