838 Trading Partner Profile (003040)
This is the standard X12 003040 spec, with 12 loops and 60 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.
Use the 838 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 838 files into TS838 objects. See ediFabric .NET.
ediFabric Native
Map version 003040 to the Native model with set_map, then parse 838 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 838 classes in Python, Java, Node.js, Go, Rust or C
ediFabric Native returns each 838 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 TS838. 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.
838 structure
Loops and segments of the standard 838, with their usage and maximum repeats.
| ID | Name | Usage | Max use |
|---|---|---|---|
| ST | Transaction Set Header | Optional | 1 |
| BTP | Beginning Segment For Trading Partner Profile | Mandatory | 1 |
| REQ | Request Information | Optional | 1 |
| PER | Administrative Communications Contact | Optional | 1 |
| Loop LX | Assigned Number | Optional | >1 |
| LX | Assigned Number | Mandatory | 1 |
| Loop PLA | Place or Location | Optional | >1 |
| PLA | Place or Location | Mandatory | 1 |
| LCD | Place/Location Description | Optional | >1 |
| LIN | Item Identification | Optional | >1 |
| Loop N1 | Name | Optional | >1 |
| N1 | Name | Mandatory | 1 |
| N2 | Additional Name Information | Optional | 2 |
| N3 | Address Information | Optional | 2 |
| N4 | Geographic Location | Optional | 1 |
| N9 | Reference Number | Optional | >1 |
| PER | Administrative Communications Contact | Optional | >1 |
| CUR | Currency | Optional | >1 |
| TAX | Tax Reference | Optional | >1 |
| FOB | F.O.B. Related Instructions | Optional | >1 |
| ITD | Terms of Sale/Deferred Terms of Sale | Optional | >1 |
| TD5 | Carrier Details (Routing Sequence/Transit Time) | Optional | >1 |
| FBB | Foreign and Industry Business | Optional | >1 |
| DTM | Date/Time Reference | Optional | 2 |
| LCD | Place/Location Description | Optional | >1 |
| Loop TPD | Trading Partner Detail | Optional | >1 |
| TPD | Trading Partner Detail | Mandatory | 1 |
| N9 | Reference Number | Optional | >1 |
| PID | Product/Item Description | Optional | >1 |
| DTM | Date/Time Reference | Optional | >1 |
| Loop LS | Loop Header | Optional | 1 |
| LS | Loop Header | Mandatory | 1 |
| Loop TUD | Trade Union Data | Optional | >1 |
| TUD | Trade Union Data | Mandatory | 1 |
| DTM | Date/Time Reference | Optional | >1 |
| N1 | Name | Optional | 1 |
| N2 | Additional Name Information | Optional | 2 |
| N3 | Address Information | Optional | 2 |
| N4 | Geographic Location | Optional | 1 |
| PER | Administrative Communications Contact | Optional | >1 |
| LE | Loop Trailer | Mandatory | 1 |
| Loop SPR | Supplier Rating | Optional | >1 |
| SPR | Supplier Rating | Mandatory | 1 |
| N9 | Reference Number | Optional | >1 |
| DTM | Date/Time Reference | Optional | >1 |
| Loop PAM | Period Amount | Optional | >1 |
| PAM | Period Amount | Mandatory | 1 |
| DTM | Date/Time Reference | Optional | >1 |
| TAX | Tax Reference | Optional | >1 |
| CUR | Currency | Optional | >1 |
| Loop TXN | Transaction Capabilities | Optional | >1 |
| TXN | Transaction Capabilities | Mandatory | 1 |
| N9 | Reference Number | Optional | >1 |
| DTM | Date/Time Reference | Optional | >1 |
| Loop ENE | Electronic Systems Environment | Optional | >1 |
| ENE | Electronic Systems Environment | Mandatory | 1 |
| Loop N1 | Name | Optional | >1 |
| N1 | Name | Mandatory | 1 |
| N2 | Additional Name Information | Optional | 2 |
| N3 | Address Information | Optional | 2 |
| N4 | Geographic Location | Optional | 1 |
| TPD | Trading Partner Detail | Optional | >1 |
| PID | Product/Item Description | Optional | >1 |
| N9 | Reference Number | Optional | >1 |
| PER | Administrative Communications Contact | Optional | >1 |
| Loop TXN | Transaction Capabilities | Optional | >1 |
| TXN | Transaction Capabilities | Mandatory | 1 |
| N9 | Reference Number | Optional | >1 |
| DTM | Date/Time Reference | Optional | >1 |
| ERI | Entity Relationship | Optional | >1 |
| AMT | Monetary Amount | Optional | >1 |
| SE | Transaction Set Trailer | Optional | 1 |