417 Rail Carrier Waybill Interchange (004020)
This is the standard X12 004020 spec, with 15 loops and 92 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 417 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 417 files into TS417 objects. See ediFabric .NET.
ediFabric Native
Map version 004020 to the Native model with set_map, then parse 417 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 417 classes in Python, Java, Node.js, Go, Rust or C
ediFabric Native returns each 417 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 TS417. 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.
417 structure
Loops and segments of the standard 417, with their usage and maximum repeats.
| ID | Name | Usage | Max use |
|---|---|---|---|
| ST | Transaction Set Header | Optional | 1 |
| ZC1 | Beginning Segment For Data Correction Or Change | Optional | 1 |
| BX | General Shipment Information | Optional | 1 |
| BNX | Rail Shipment Information | Optional | 1 |
| N9 | Reference Identification | Optional | 30 |
| CM | Cargo Manifest | Optional | 2 |
| DTM | Date/Time Reference | Optional | 5 |
| Loop N7 | Equipment Details | Mandatory | 500 |
| N7 | Equipment Details | Mandatory | 1 |
| EM | Equipment Characteristics | Optional | 1 |
| Loop VC | Motor Vehicle Control | Optional | 21 |
| VC | Motor Vehicle Control | Mandatory | 1 |
| Loop N1 | Name | Optional | 2 |
| N1 | Name | Mandatory | 1 |
| N3 | Address Information | Optional | 2 |
| N4 | Geographic Location | Optional | 1 |
| H3 | Special Handling Instructions | Optional | 1 |
| IC | Intermodal Chassis Equipment | Optional | 1 |
| IM | Intermodal Movement Information | Optional | 1 |
| M12 | In-bond Identifying Information | Optional | 2 |
| G4 | Scale Identification | Optional | 1 |
| M7 | Seal Numbers | Optional | 5 |
| N5 | Equipment Ordered | Optional | 1 |
| H5 | Car Service Order | Optional | 1 |
| Loop E1 | Empty Car Disposition - Pended Destination Consignee | Optional | 2 |
| E1 | Empty Car Disposition - Pended Destination Consignee | Mandatory | 1 |
| E4 | Empty Car Disposition - Pended Destination City | Optional | 1 |
| E5 | Empty Car Disposition - Pended Destination Route | Optional | 13 |
| PI | Price Authority Identification | Optional | 1 |
| GA | Canadian Grain Information | Optional | 15 |
| Loop REF | Reference Identification | Optional | 99 |
| REF | Reference Identification | Mandatory | 1 |
| N10 | Quantity and Description | Optional | 15 |
| Loop N1 | Name | Optional | 5 |
| N1 | Name | Mandatory | 1 |
| N3 | Address Information | Optional | 1 |
| N4 | Geographic Location | Optional | 1 |
| IMA | Interchange Move Authority | Optional | 3 |
| N8 | Waybill Reference | Optional | 499 |
| N8A | Additional Reference Information | Optional | 499 |
| V9 | Event Detail | Optional | 1 |
| F9 | Origin Station | Mandatory | 1 |
| D9 | Destination Station | Mandatory | 1 |
| Loop N1 | Name | Mandatory | 15 |
| N1 | Name | Mandatory | 1 |
| N2 | Additional Name Information | Optional | 2 |
| N3 | Address Information | Optional | 2 |
| N4 | Geographic Location | Optional | 1 |
| REF | Reference Identification | Optional | 2 |
| PER | Administrative Communications Contact | Optional | 2 |
| BL | Billing Information | Optional | 12 |
| Loop S1 | Stop-off Name | Optional | 12 |
| S1 | Stop-off Name | Mandatory | 1 |
| S2 | Stop-off Address | Optional | 2 |
| S9 | Stop-off Station | Optional | 1 |
| N1 | Name | Optional | 1 |
| N2 | Additional Name Information | Optional | 1 |
| N3 | Address Information | Optional | 1 |
| N4 | Geographic Location | Optional | 1 |
| PER | Administrative Communications Contact | Optional | 1 |
| R2 | Route Information | Mandatory | 13 |
| R9 | Route Code | Optional | 1 |
| Loop E1 | Empty Car Disposition - Pended Destination Consignee | Optional | 2 |
| E1 | Empty Car Disposition - Pended Destination Consignee | Mandatory | 1 |
| E4 | Empty Car Disposition - Pended Destination City | Optional | 1 |
| E5 | Empty Car Disposition - Pended Destination Route | Optional | 13 |
| PI | Price Authority Identification | Optional | 1 |
| H3 | Special Handling Instructions | Optional | 20 |
| PS | Protective Service Instructions | Optional | 5 |
| Loop LX | Assigned Number | Mandatory | 25 |
| LX | Assigned Number | Mandatory | 1 |
| L5 | Description, Marks and Numbers | Mandatory | 15 |
| Loop L0 | Line Item - Quantity and Weight | Optional | 25 |
| L0 | Line Item - Quantity and Weight | Mandatory | 1 |
| MEA | Measurements | Optional | 3 |
| PI | Price Authority Identification | Optional | 30 |
| X1 | Export License | Optional | 6 |
| Loop T1 | Transit Inbound Origin | Optional | 64 |
| T1 | Transit Inbound Origin | Mandatory | 1 |
| T2 | Transit Inbound Lading | Optional | 30 |
| T3 | Transit Inbound Route | Optional | 12 |
| T6 | Transit Inbound Rates | Optional | 1 |
| T8 | Free-form Transit Data | Optional | 99 |
| Loop LS | Loop Header | Optional | 1 |
| LS | Loop Header | Mandatory | 1 |
| Loop LH1 | Hazardous Identification Information | Optional | 100 |
| LH1 | Hazardous Identification Information | Mandatory | 1 |
| LH2 | Hazardous Classification Information | Optional | 4 |
| LH3 | Hazardous Material Shipping Name | Optional | 10 |
| LFH | Freeform Hazardous Material Information | Optional | 20 |
| LEP | EPA Required Data | Optional | 3 |
| LH4 | Canadian Dangerous Requirements | Optional | 1 |
| LHT | Transborder Hazardous Requirements | Optional | 3 |
| LHR | Hazardous Material Identifying Reference Numbers | Optional | 5 |
| PER | Administrative Communications Contact | Optional | 5 |
| Loop N1 | Name | Optional | 10 |
| N1 | Name | Mandatory | 1 |
| N3 | Address Information | Optional | 2 |
| N4 | Geographic Location | Optional | 1 |
| PER | Administrative Communications Contact | Optional | 2 |
| LE | Loop Trailer | Mandatory | 1 |
| PER | Administrative Communications Contact | Optional | 5 |
| LH2 | Hazardous Classification Information | Optional | 6 |
| LHR | Hazardous Material Identifying Reference Numbers | Optional | 1 |
| XH | Pro Forma - B13 Information | Optional | 1 |
| X7 | Customs Information | Optional | 10 |
| SE | Transaction Set Trailer | Optional | 1 |