X12 870 Order Status Report
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.
- ~ Segment
- * Element
- > Component
Interchange Control Header
To start and identify an interchange of zero or more functional groups and interchange-related control segments
Code to identify the type of information in the Authorization Information
- 00
- No Authorization Information Present (No Meaningful Information in I02)
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)
Code to identify the type of information in the Security Information
- 00
- No Security Information Present (No Meaningful Information in I04)
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)
Qualifier to designate the system/method of code structure used to designate the sender or receiver ID element being qualified
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
Qualifier to designate the system/method of code structure used to designate the sender or receiver ID element being qualified
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
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
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
A control number assigned by the interchange sender
Code sent by the sender to request an interchange acknowledgment (TA1)
- 0
- No Acknowledgment Requested
- 1
- Interchange Acknowledgment Requested
Code to indicate whether data enclosed by this interchange envelope is test, production or information
- I
- Information
- P
- Production Data
- T
- Test Data
Type is not applicable; the component element separator is a delimiter and not a data element; this field provides the delimiter used to separate component data elements within a composite data structure; this value must be different than the data element separator and the segment terminator
- >
- Component Element Separator
Functional Group Header
To indicate the beginning of a functional group and to provide control information
Code identifying a group of application related transaction sets
- RS
- Order Status Information (869, 870)
Code identifying party sending transmission; codes agreed to by trading partners
Code identifying party receiving transmission. Codes agreed to by trading partners
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)
Assigned number originated and maintained by the sender
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
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
Transaction Set Header
To indicate the start of a transaction set and to assign a control number
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
Beginning Segment for Order Status Report
To indicate the beginning of an Order Status Report Transaction Set
Code indicating the reason for sending the report
- 2
- Prearranged Schedule
Code identifying a group of orders and items
- AO
- Items with Changed Status
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.
Date/Time Reference
To specify pertinent dates and times
Name
To identify a party by type of organization, name, and code
Code identifying an organizational entity, a physical location, property or an individual
- BY
- Buyers Name
- VN
- Vendors Name
Code designating the system/method of code structure used for Identification Code (67)
- 92
- Assigned by Buyer
- 93
- Assigned by Seller
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.
92 Assigned by Buyer
93 Assigned by Seller
Additional Name Information
To specify additional names or those longer than 35 characters in length
Address Information
To specify the location of the named party
Geographic Location
To specify the geographic place of the named party
Free-form text for city name
- A combination of either N401 through N404, or N405 and N406 may be adequate to specify a location.
Code (Standard State/Province) as defined by appropriate government agency
- N402 is required only if city name (N401) is in the U.S. or Canada.
Code defining international postal zone code excluding punctuation and blanks (zip code for United States)
Administrative Communications Contact
To identify a person or office to whom administrative communications should be directed
Code identifying the major duty or responsibility of the person or group named
- BD
- Buyer Name or Department
- IC
- Information Contact
Free-form name
If N101 = “BY”, send CDW purchasing agent.
If N101 = “VN”, send customer contact.
Code identifying the type of communication number
- TE
- Telephone
Complete communications number including country or area code when applicable
Code identifying the type of communication number
- EM
- Electronic Mail
Detail
Hierarchical Level
To identify dependencies among and the content of hierarchically related groups of data segments
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.
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
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.
Purchase Order Reference
To provide reference to a specific purchase order
Item Status Report
To specify detailed purchase order/item status
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.
Please notify your EDI contact if you are going to use codes not on the above list. Use
HQ only in cases where all line items for the Purchase Order are in HQ status (Line
Level ISR). Use NN only in cases where all line items for the Purchase Order are in
either DI or IC status (Line Level ISR). For all other combinations of Line Item statuses
use IN. Use CC only in cases where all line items for the Purchase Order have shipped
complete
- CC
- Shipment Complete on (Date)
- HQ
- Held Awaiting Qualification
- IN
- In Process
- NN
- Not in Process - No Shipping Schedule
Date/Time Reference
To specify pertinent dates and times
Reference Identification
To specify identifying information
Code qualifying the Reference Identification
- VN
- Vendor Order Number
Name
To identify a party by type of organization, name, and code
Code identifying an organizational entity, a physical location, property or an individual
- ST
- Ship To
Code designating the system/method of code structure used for Identification Code (67)
- 1
- D-U-N-S Number, Dun & Bradstreet
- 92
- Assigned by Buyer
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.
Additional Name Information
To specify additional names or those longer than 35 characters in length
Address Information
To specify the location of the named party
Geographic Location
To specify the geographic place of the named party
Free-form text for city name
- A combination of either N401 through N404, or N405 and N406 may be adequate to specify a location.
Code (Standard State/Province) as defined by appropriate government agency
- N402 is required only if city name (N401) is in the U.S. or Canada.
Code defining international postal zone code excluding punctuation and blanks (zip code for United States)
Code identifying type of location
- DE
- Destination (Shipping) (non drop-ship orders only)
Reference Identification
To specify identifying information
Code qualifying the Reference Identification
- EU
- End User Purchase Order Number (Only for Drop-ship orders)
Administrative Communications Contact
To identify a person or office to whom administrative communications should be directed
Code identifying the major duty or responsibility of the person or group named
- IC
- Information Contact
Code identifying the type of communication number
- TE
- Telephone
Complete communications number including country or area code when applicable
Code identifying the type of communication number
- EM
- Electronic Mail
Baseline Item Data
To specify basic and most frequently used line item data
Alphanumeric characters assigned for differentiation within a transaction set
- PO101 is the line item identification.
This element is used to identify the purchase order line item number.
Code specifying the units in which a value is being expressed, or manner in which a measurement has been taken
- EA
- Each
Price per unit of product, service, commodity, etc.
Code identifying the type of unit price for an item
- CA
- Catalog
- PE
- Price per Each
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.
- BP
- Buyer's Part Number
Identifying number for a product or service
Code identifying the type/source of the descriptive number used in Product/Service ID (234)
- MG
- Manufacturer's Part Number
Identifying number for a product or service
Code identifying the type/source of the descriptive number used in Product/Service ID (234)
- VP
- Vendor’s Part Number
Identifying number for a product or service
Code identifying the type/source of the descriptive number used in Product/Service ID (234)
- OE
- OEM Part Number
Identifying number for a product or service
Code identifying the type/source of the descriptive number used in Product/Service ID (234)
- UP
- U.P.C. Consumer Package Code
Identifying number for a product or service
Code identifying the type/source of the descriptive number used in Product/Service ID (234)
- UR
- UCC/EAN-128 Code
Identifying number for a product or service
Code identifying the type/source of the descriptive number used in Product/Service ID (234)
- AC
- Aggregation Code (Used to Consolidate Part Families)
Product/Item Description
To describe a product or process in coded or free-form format
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
Item Status Report
To specify detailed purchase order/item status
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.
Please notify your EDI contact if you are going to use any codes not on the above list.
- BO
- Back Ordered
- BP
- Shipment Partial, Back Order to Ship on (Date)
- CC
- Shipment Complete on (Date)
- CK
- Cancelled from Previous Order
- DI
- Item Manufacturer-Discontinued
- HQ
- Held Awaiting Qualification, Credit Hold, Processing Delay
Held Awaiting Qualification, Credit Hold, Processing Delay
- IC
- Item Canceled
- IN
- In Process
- PR
- Partial Shipment
Date expressed as CCYYMMDD
Required for backordered items
Code indicating the status reason
Required for all HQ or IC status. Please notify your EDI contact if you are going to use
codes not on the above list.
- B40
- Suspended, Manufacturer Product Hold
- C02
- Credit Hold
- REJ
- Buyer not authorized to purchase item.
- W04
- On Hold pending (Required) Qualification Information
Quantity
To specify quantity information
Code specifying the type of quantity
- 01
- Discrete Quantity
- 27
- Committed Quantity
- 39
- Shipped Quantity
- 40
- Remaining Quantity
Date/Time Reference
To specify pertinent dates and times
Code specifying type of date or time, or both date and time
Required for backordered items (or can be sent in ISR – see above)
- 010
- Requested Ship
- 017
- Estimated Delivery
- 035
- Delivered On
- 068
- Scheduled Ship
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)
Reference Identification
To specify identifying information
Code qualifying the Reference Identification
- BM
- Bill of Lading
- SI
- Shippers ID # for Shipment
Summary
Transaction Totals
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.
Transaction Set Trailer
To indicate the end of the transaction set and provide the count of the transmitted segments (including the beginning (ST) and ending (SE) segments)
Total number of segments included in a transaction set including ST and SE segments
Functional Group Trailer
To indicate the end of a functional group and to provide control information
Total number of transaction sets included in the functional group or interchange (transmission) group terminated by the trailer containing this data element
Interchange Control Trailer
To define the end of an interchange of zero or more functional groups and interchange-related control segments
CDW Order Status Report
GS~RS~SENDERGS~RECEIVERGS~20231101~014040~000000001~X~004010
ST~870~1001
BSR~2~AO~REPORT_001~20010301
DTM~007~20010301
N1~VN~VENDOR_NAME~92~1234567890
N1~BY~CDW~93~VENDOR_ID
HL~1~~O
PRF~CDW_PO_1~~~20010201
ISR~IN
REF~VN~SELLER_ORDER_NUMBER_1
N1~ST~SHIP_TO_NAME_1~92~SHIPTO_ID
N2~ATTN:SHIP_TO_CONTACT
N3~SHIP_TO_ADDRESS_1
N4~SHIP_TO_CITY~IL~60018
REF~EU~END_USER_PO
PER~IC~SHIP_TO_CONTACT~TE~1(800)555-5555
PO1~000001~100~EA~50.50~CA~BP~CDW_ITEM_1~MG~VENDOR_ITEM_1~VP~MANUF_ITEM_1
PID~F~~~~DESCRIPTION OF ITEM_1
ISR~HQ~~W04
QTY~01~50~UN
ISR~PR~20010228
QTY~01~50~UN
REF~BM~BILL_A
PO1~000002~50~EA~100~CA~BP~CDW_ITEM_2~MG~VENDOR_ITEM_2~VP~MANUF_ITEM_2
PID~F~~~~DESCRIPTION OF ITEM_2
ISR~IC
QTY~01~50~UN
REF~BM~CANC_REV_NUM_2
HL~2~~O
PRF~CDW_PO_2~~~20010202
ISR~CC
REF~VN~SELLER_ORDER_NUMBER_2
N1~ST~SHIP_TO_NAME_2~92~SHIPTO_ID
N2~ATTN:SHIP_TO_CONTACT
N3~SHIP_TO_ADDRESS_2
N4~SHIP_TO_CITY~IL~60018
REF~EU~END_USER_PO
PER~IC~SHIP_TO_CONTACT~TE~1(800)555-5555
PO1~000004~10~EA~75.80~CA~BP~CDW_ITEM_3~MG~VENDOR_ITEM_3~VP~MANUF_ITEM_3
PID~F~~~~DESCRIPTION OF ITEM_3
ISR~CC~20010227
QTY~01~10~UN
REF~BM~BILL_B
HL~3~~O
PRF~CDW_PO_3~~~20010203
ISR~IN
REF~VN~SELLER_ORDER_NUMBER_3
N1~ST~SHIP_TO_NAME_3~92~SHIPTO_ID
N2~ATTN:SHIP_TO_CONTACT
N3~SHIP_TO_ADDRESS_3
N4~SHIP_TO_CITY~IL~60018
REF~EU~END_USER_PO
PER~IC~SHIP_TO_CONTACT~TE~1(800)555-5555
PO1~000001~5~EA~1008.65~CA~BP~CDW_ITEM_4~MG~VENDOR_ITEM_4~VP~MANUF_ITEM_4
PID~F~~~~DESCRIPTION OF ITEM_4
ISR~IN
QTY~01~3~UN
DTM~068~20010320
ISR~CC~20010226
QTY~01~2~UN
REF~BM~BILL_C
CTT~3
SE~62~1001
GE~1~000000001
IEA~1~000000001
Stedi is a registered trademark of Stedi, Inc. All names, logos, and brands of third parties listed on this page are trademarks of their respective owners (including “X12”, which is a trademark of X12 Incorporated). Stedi, Inc. and its products and services are not endorsed by, sponsored by, or affiliated with these third parties. Use of these names, logos, and brands is for identification purposes only, and does not imply any such endorsement, sponsorship, or affiliation.