870 Order Status Report (003040)

This is the standard X12 003040 spec, with 11 loops and 65 segment positions, as OpenEDI JSON, an ediFabric C# template and an ediFabric Native model. To change it for a trading partner, customize it in the EDI Spec Builder.

Loading the spec…

The spec as an OpenAPI 3 schema with x-openedi-* extensions, for ediFabric Native, ediFabric Cloud and the EDI Spec Builder. Download OpenEDI (93 KB) Generate classes

The ediFabric .NET template, class TS870. It needs the common segments, composites and codes of X12 003040, one download for every transaction in the version. Download C# (1 KB) Common files (185 KB)

The intermediary model ediFabric Native loads with set_map. Download Native (76 KB)

Use the 870 spec in your code

ediFabric .NET

Add the C# template and its common files to your project, or reference the template NuGet package, and read 870 files into TS870 objects. See ediFabric .NET.

ediFabric Native

Map version 003040 to the Native model with set_map, then parse 870 files to JSON from Python, Java, C or C#. See Convert between EDI and JSON.

OpenEDI

Select Customize in Spec Builder to copy the spec under your own name, change it for your partner, and parse files against it in EdiNation, ediFabric Native or ediFabric Cloud. Read about OpenEDI.

Generate 870 classes in Python, Java, Node.js, Go, Rust or C

ediFabric Native returns each 870 as JSON, with the property names of the OpenEDI schema. To work with that JSON as typed objects, generate classes from the OpenEDI file in your language and deserialize the JSON into TS870. Serialize the objects back to JSON to build EDI with ediFabric Native. The classes keep the loops, segments, lengths and code lists, but not the EDI data formats, so validate files with ediFabric Native. Read more in Generate a class from OpenEDI.

Python: datamodel-code-generator. Node.js: openapi-typescript. Java, Go, Rust and C: OpenAPI Generator.

870 structure

Loops and segments of the standard 870, with their usage and maximum repeats.

ID	Name	Usage	Max use
ST	Transaction Set Header	Optional	1
BSR	Beginning Segment for Order Status Report	Mandatory	1
NTE	Note/Special Instruction	Optional	100
REF	Reference Numbers	Optional	12
TD3	Carrier Details (Equipment)	Optional	1
TD4	Carrier Details (Special Handling or Hazardous Materials or Both)	Optional	1
TD5	Carrier Details (Routing Sequence/Transit Time)	Optional	1
Loop N1	Name	Optional	200
N1	Name	Mandatory	1
N2	Additional Name Information	Optional	2
N3	Address Information	Optional	2
N4	Geographic Location	Optional	1
REF	Reference Numbers	Optional	12
PER	Administrative Communications Contact	Optional	3
PWK	Paperwork	Optional	1
DTM	Date/Time Reference	Optional	10
Loop LM	Code Source Information	Optional	10
LM	Code Source Information	Mandatory	1
LQ	Industry Code	Mandatory	100
Loop HL	Hierarchical Level	Mandatory	1000
HL	Hierarchical Level	Mandatory	1
PRF	Purchase Order Reference	Optional	1
Loop ISR	Item Status Report	Optional	104
ISR	Item Status Report	Mandatory	1
PID	Product/Item Description	Optional	6
QTY	Quantity	Optional	4
REF	Reference Numbers	Optional	12
PER	Administrative Communications Contact	Optional	3
DTM	Date/Time Reference	Optional	10
CS	Contract Summary	Optional	3
Loop N1	Name	Optional	200
N1	Name	Mandatory	1
N2	Additional Name Information	Optional	2
N3	Address Information	Optional	2
N4	Geographic Location	Optional	1
REF	Reference Numbers	Optional	12
PER	Administrative Communications Contact	Optional	3
Loop LM	Code Source Information	Optional	10
LM	Code Source Information	Mandatory	1
LQ	Industry Code	Mandatory	100
Loop PO1	Baseline Item Data	Optional	1000
PO1	Baseline Item Data	Mandatory	1
CUR	Currency	Optional	1
SLN	Subline Item Detail	Optional	100
PO3	Additional Item Detail	Optional	1
PID	Product/Item Description	Optional	1000
MEA	Measurements	Optional	40
PKG	Marking, Packaging, Loading	Optional	25
Loop ISR	Item Status Report	Optional	104
ISR	Item Status Report	Mandatory	1
PID	Product/Item Description	Optional	6
QTY	Quantity	Optional	4
DTM	Date/Time Reference	Optional	10
N1	Name	Optional	1
N2	Additional Name Information	Optional	2
N3	Address Information	Optional	2
N4	Geographic Location	Optional	1
TD1	Carrier Details (Quantity and Weight)	Optional	1
TD5	Carrier Details (Routing Sequence/Transit Time)	Optional	1
TD3	Carrier Details (Equipment)	Optional	1
TD4	Carrier Details (Special Handling or Hazardous Materials or Both)	Optional	1
REF	Reference Numbers	Optional	12
SAC	Service, Promotion, Allowance, or Charge Information	Optional	25
Loop LM	Code Source Information	Optional	10
LM	Code Source Information	Mandatory	1
LQ	Industry Code	Mandatory	100
Loop LX	Assigned Number	Optional	>1
LX	Assigned Number	Mandatory	1
REF	Reference Numbers	Optional	>1
N1	Name	Optional	1
DTM	Date/Time Reference	Optional	10
Loop LM	Code Source Information	Optional	10
LM	Code Source Information	Mandatory	1
LQ	Industry Code	Mandatory	100
CTT	Transaction Totals	Optional	1
SE	Transaction Set Trailer	Optional	1