D&H
/
Customer Order Status Report
  • Specification
  • EDI Inspector
Import
Stedi maintains this guide based on public documentation from D&H . Contact D&H for official EDI specifications. To report any errors in this guide, please contact us.
Go to EDI Guide Catalog
D&H  logo

X12 870 Customer 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
EDI sample
    View the latest version of this implementation guide as an interactive webpage
    Powered by
    Build free EDI implementation guides at stedi.com
    Overview
    ISA
    -
    Interchange Control Header
    Max use 1
    Required
    GS
    -
    Functional Group Header
    Max use 1
    Required
    heading
    detail
    Order
    HL
    010
    Hierarchical Level
    Max use 1
    Required
    PRF
    020
    Purchase Order Reference
    Max use 1
    Required
    PO1 Loop
    GE
    -
    Functional Group Trailer
    Max use 1
    Required
    IEA
    -
    Interchange Control Trailer
    Max use 1
    Required
    ISA

    Interchange Control Header

    RequiredMax use 1

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

    Example
    ISA-01
    I01
    Authorization Information Qualifier
    Required

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

    Information used for additional identification or authorization of the interchange sender or the data in the interchange; the type of information is set by the Authorization Information Qualifier (I01)

    ISA-03
    I03
    Security Information Qualifier
    Required

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

    This is used for identifying the security information about the interchange sender or the data in the interchange; the type of information is set by the Security Information Qualifier (I03)

    ISA-05
    I05
    Interchange ID Qualifier
    Required
    Min 2Max 2

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

    Codes
    ISA-06
    I06
    Interchange Sender ID
    Required
    Min 15Max 15

    Identification code published by the sender for other parties to use as the receiver ID to route data to them; the sender always codes this value in the sender ID element

    ISA-07
    I05
    Interchange ID Qualifier
    Required
    Min 2Max 2

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

    Codes
    ISA-08
    I07
    Interchange Receiver ID
    Required
    Min 15Max 15

    Identification code published by the receiver of the data; When sending, it is used by the sender as their sending ID, thus other parties sending to them will use this as a receiving ID to route data to them

    ISA-09
    I08
    Interchange Date
    Required
    YYMMDD format

    Date of the interchange

    ISA-10
    I09
    Interchange Time
    Required
    HHMM format

    Time of the interchange

    ISA-11
    I10
    Interchange Control Standards Identifier
    Required

    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

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

    A control number assigned by the interchange sender

    ISA-14
    I13
    Acknowledgment Requested
    Required
    Min 1Max 1

    Code sent by the sender to request an interchange acknowledgment (TA1)

    0
    No Acknowledgment Requested
    1
    Interchange Acknowledgment Requested
    ISA-15
    I14
    Usage Indicator
    Required
    Min 1Max 1

    Code to indicate whether data enclosed by this interchange envelope is test, production or information

    I
    Information
    P
    Production Data
    T
    Test Data
    ISA-16
    I15
    Component Element Separator
    Required
    Min 1Max 1

    Type is not applicable; the component element separator is a delimiter and not a data element; this field provides the delimiter used to separate component data elements within a composite data structure; this value must be different than the data element separator and the segment terminator

    >
    Component Element Separator

    Functional Group Header

    RequiredMax use 1

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

    Example
    GS-01
    479
    Functional Identifier Code
    Required

    Code identifying a group of application related transaction sets

    RS
    Order Status Information (869, 870)
    GS-02
    142
    Application Sender's Code
    Required
    Min 2Max 15

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

    GS-03
    124
    Application Receiver's Code
    Required
    Min 2Max 15

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

    GS-04
    373
    Date
    Required
    CCYYMMDD format

    Date expressed as CCYYMMDD

    GS-05
    337
    Time
    Required
    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
    Min 1Max 9

    Assigned number originated and maintained by the sender

    GS-07
    455
    Responsible Agency Code
    Required
    Min 1Max 2

    Code used in conjunction with Data Element 480 to identify the issuer of the standard

    T
    Transportation Data Coordinating Committee (TDCC)
    X
    Accredited Standards Committee X12
    GS-08
    480
    Version / Release / Industry Identifier Code
    Required

    Code indicating the version, release, subrelease, and industry identifier of the EDI standard being used, including the GS and GE segments; if code in DE455 in GS segment is X, then in DE 480 positions 1-3 are the version number; positions 4-6 are the release and subrelease, level of the version; and positions 7-12 are the industry or trade association identifiers (optionally assigned by user); if code in DE455 in GS segment is T, then other formats are allowed

    004010
    Draft Standards Approved for Publication by ASC X12 Procedures Review Board through October 1997

    Heading

    ST
    010

    Transaction Set Header

    RequiredMax use 1

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

    Example
    ST-01
    143
    Transaction Set Identifier Code
    Required

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

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

    BSR
    020

    Beginning Segment for Order Status Report

    RequiredMax use 1

    To indicate the beginning of an Order Status Report Transaction Set

    Usage notes

    Example: BSR2CO*870Report-2021-08-01T10:39:32.*20210801~

    Example
    BSR-01
    850
    Status Report Code
    Required

    Code indicating the reason for sending the report

    2
    Prearranged Schedule or Agreement
    BSR-02
    847
    Order/Item Code
    Required

    Code identifying a group of orders and items

    CO
    All Orders - Unshipped Items
    BSR-03
    127
    Reference Identification
    Required
    Min 1Max 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.
    BSR-04
    373
    Date
    Required
    CCYYMMDD format

    Date expressed as CCYYMMDD

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

    Detail

    HL Order
    RequiredMax >1
    Usage notes

    Example: HL*172**O~

    HL
    010

    Hierarchical Level

    RequiredMax use 1

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

    Example
    HL-01
    628
    Hierarchical ID Number
    Required
    Min 1Max 12

    A unique number assigned by the sender to identify a particular data segment in a hierarchical structure

    • HL01 shall contain a unique alphanumeric number for each occurrence of the HL segment in the transaction set. For example, HL01 could be used to indicate the number of occurrences of the HL segment, in which case the value of HL01 would be "1" for the initial HL segment and would be incremented by one in each subsequent HL segment within the transaction.
    HL-03
    735
    Hierarchical Level Code
    Required

    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

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

    Purchase Order Reference

    RequiredMax use 1

    To provide reference to a specific purchase order

    Usage notes

    Example: PRFXDR7862**20210801~

    Example
    PRF-01
    324
    Purchase Order Number
    Required
    Min 1Max 22

    Identifying number for Purchase Order assigned by the orderer/purchaser

    PRF-04
    373
    Date
    Optional
    CCYYMMDD format

    Date expressed as CCYYMMDD

    • PRF04 is the date assigned by the purchaser to purchase order.
    PO1 Loop
    OptionalMax >1
    PO1
    150

    Baseline Item Data

    RequiredMax use 1

    To specify basic and most frequently used line item data

    Usage notes

    Example: PO172EA12.55*VP2316272MGTZE345UP876857682342~

    Example
    If Unit or Basis for Measurement Code (PO1-03) is present, then Quantity Ordered (PO1-02) is required
    If either Product/Service ID Qualifier (PO1-06) or Product/Service ID (PO1-07) is present, then the other 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
    If Basis of Unit Price Code (PO1-05) is present, then Unit Price (PO1-04) is required
    PO1-01
    350
    Assigned Identification
    Required
    Min 1Max 20

    Alphanumeric characters assigned for differentiation within a transaction set

    • PO101 is the line item identification.
    Usage notes

    This is the line number provided on the Inbound EDI 850 document in the PO101.

    PO1-02
    330
    Quantity Ordered
    Optional
    Min 1Max 15

    Quantity ordered

    PO1-03
    355
    Unit or Basis for Measurement Code
    Optional

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

    EA
    Each
    PO1-04
    212
    Unit Price
    Optional
    Min 1Max 15

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

    PO1-05
    639
    Basis of Unit Price Code
    Optional
    Min 2Max 2

    Code identifying the type of unit price for an item

    PO1-06
    235
    Product/Service ID Qualifier
    Optional

    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.
    VP
    Vendor's (Seller's) Part Number
    PO1-07
    234
    Product/Service ID
    Optional
    Min 1Max 48

    Identifying number for a product or service

    PO1-08
    235
    Product/Service ID Qualifier
    Optional

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

    MG
    Manufacturer's Part Number
    PO1-09
    234
    Product/Service ID
    Optional
    Min 1Max 48

    Identifying number for a product or service

    PO1-10
    235
    Product/Service ID Qualifier
    Optional

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

    UP
    U.P.C. Consumer Package Code (1-5-5-1)
    PO1-11
    234
    Product/Service ID
    Optional
    Min 1Max 48

    Identifying number for a product or service

    PID
    180

    Product/Item Description

    OptionalMax use 1000

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

    Usage notes

    Example: PIDF02***White on Black 3 4"~

    Example
    PID-01
    349
    Item Description Type
    Required

    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-02
    750
    Product/Process Characteristic Code
    Optional
    Min 2Max 3

    Code identifying the general class of a product or process characteristic

    PID-05
    352
    Description
    Optional
    Min 1Max 80

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

    ISR Loop
    OptionalMax >1
    ISR
    210

    Item Status Report

    RequiredMax use 1

    To specify detailed purchase order/item status

    Usage notes

    ISR02 is the date of the status change.

    ISR01 status is applicable to the quantities in QTY02.

    Example: ISRBO20210804~

    Example
    ISR-01
    368
    Shipment/Order Status Code
    Required

    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.
    BO
    Back Ordered
    BP
    Shipment Partial, Back Order to Ship on (Date)
    DI
    Discontinued
    IC
    Item Canceled
    IN
    In Process
    ISR-02
    373
    Date
    Optional
    CCYYMMDD format

    Date expressed as CCYYMMDD

    QTY
    230

    Quantity

    OptionalMax use 4

    To specify quantity information

    Usage notes

    Example: QTY012*EA~

    Example
    QTY-01
    673
    Quantity Qualifier
    Required

    Code specifying the type of quantity

    01
    Discrete Quantity
    QTY-02
    380
    Quantity
    Optional
    Min 1Max 15

    Numeric value of quantity

    QTY-03
    C001
    Composite Unit of Measure
    To identify a composite unit of measure (See Figures Appendix for examples of use)
    C001-01
    355
    Unit or Basis for Measurement Code
    Required

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

    EA
    Each
    DTM
    240

    Date/Time Reference

    RequiredMax use 10

    To specify pertinent dates and times

    Example
    DTM-01
    374
    Date/Time Qualifier
    Required

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

    017
    Estimated Delivery
    068
    Current Schedule Ship
    DTM-02
    373
    Date
    Optional
    CCYYMMDD format

    Date expressed as CCYYMMDD

    Summary

    CTT
    010

    Transaction Totals

    OptionalMax 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.
    Example
    CTT-01
    354
    Number of Line Items
    Required
    Min 1Max 6

    Total number of line items in the transaction set

    SE
    020

    Transaction Set Trailer

    RequiredMax use 1

    To indicate the end of the transaction set and provide the count of the transmitted segments (including the beginning (ST) and ending (SE) segments)

    Example
    SE-01
    96
    Number of Included Segments
    Required
    Min 1Max 10

    Total number of segments included in a transaction set including ST and SE segments

    SE-02
    329
    Transaction Set Control Number
    Required
    Min 4Max 9

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

    Functional Group Trailer

    RequiredMax use 1

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

    Example
    GE-01
    97
    Number of Transaction Sets Included
    Required
    Min 1Max 6

    Total number of transaction sets included in the functional group or interchange (transmission) group terminated by the trailer containing this data element

    GE-02
    28
    Group Control Number
    Required
    Min 1Max 9

    Assigned number originated and maintained by the sender

    Interchange Control Trailer

    RequiredMax use 1

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

    Example
    IEA-01
    I16
    Number of Included Functional Groups
    Required
    Min 1Max 5

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

    IEA-02
    I12
    Interchange Control Number
    Required
    Min 9Max 9

    A control number assigned by the interchange sender

    EDI Samples

    Sample

    ST*870*1086923~
    BSR*2*CO*870Report-2021-08-01T10:39:32.*20210801~
    HL*172**O~
    PRF*XDR7862***20210801~
    PO1*7*2*EA*12.55*CA*VP*2316272*MG*TZE345*UP*757683451232~
    PID*F*02***White on Black 3 4"~
    ISR*BO*20210804~
    QTY*01*2*EA~
    DTM*068*20210804~
    HL*173**O~
    PRF*XDR8358***20210801~
    PO1*2*10*EA*20.04*CA*VP*2954213*MG*PURA0001*UP*123432123454~
    PID*F*02***Pick Up Roller~
    ISR*BP*20210809~
    QTY*01*3*EA~
    DTM*068*20210809~
    PO1*3*10*EA*13.34*CA*VP*2954212*MG*SPA0001*UP*998877654321~
    PID*F*02***Separation Pad~
    ISR*BP*20210810~
    QTY*01*1*EA~
    DTM*068*20210810~
    CTT*3~
    SE*23*1086923~

    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.