417 Rail Carrier Waybill Interchange (003020)

This is the standard X12 003020 spec, with 11 loops and 84 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 (98 KB) Generate classes

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

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

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 003020 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 Number	Optional	30
CM	Cargo Manifest	Optional	2
DTM	Date/Time Reference	Optional	5
Loop N7	Equipment Details	Mandatory	255
N7	Equipment Details	Mandatory	1
VC	Motor Vehicle Control	Optional	21
IC	Intermodal Chassis Equipment	Optional	1
IM	Intermodal Movement Information	Optional	1
M12	In-bond Identifying Information	Optional	1
G4	Scale Identification Segment	Optional	1
M7	Seal Numbers	Optional	5
N5	Equipment Ordered	Optional	1
H5	Car Service Order	Optional	1
IMA	Interchange Move Authority	Optional	1
N8	Waybill Reference	Optional	255
V9	Event Detail	Optional	1
F9	Origin Station	Mandatory	1
D9	Destination Station	Mandatory	1
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
F1	Consignor Name	Optional	1
F2	Consignor Address	Optional	2
F4	Consignor City	Optional	1
D1	Consignee Name	Optional	1
D2	Consignee Adress	Optional	2
D4	Consignee City	Optional	1
U1	Ultimate Consignee Name	Optional	1
U2	Ultimate Consignee Address	Optional	2
U4	Ultimate Consignee City	Optional	1
U5	Prior Origin Name	Optional	1
U6	Prior Origin Address	Optional	2
U9	Prior Origin City	Optional	1
Loop F5	Consignor's Third Party	Optional	10
F5	Consignor's Third Party	Mandatory	1
F6	Consignor's Third Party Address	Optional	2
F7	Consignor's Third Party City	Optional	1
Loop D5	Consignee's Third Party	Optional	10
D5	Consignee's Third Party	Mandatory	1
D6	Consignee's Third Party Address	Optional	2
D7	Consignee's Third Party City	Optional	1
Loop S1	Stop-off Name	Optional	6
S1	Stop-off Name	Mandatory	1
S2	Stop-off Address	Optional	2
S9	Stop-off Station	Optional	1
R2	Route Information	Mandatory	13
RE	Rebill At Interchange	Optional	1
E1	Empty Car Disposition - Pended Destination Consignee	Optional	1
E4	Empty Car Disposition - Pended Destination City	Optional	1
E5	Empty Car Disposition - Pended Destination Route	Optional	12
H3	Special Handling Instructions	Optional	20
PS	Protective Service Instructions	Optional	1
Loop LX	Assigned Number	Mandatory	25
LX	Assigned Number	Mandatory	1
L5	Description, Marks and Numbers	Optional	15
Loop LS	Loop Header	Optional	1
LS	Loop Header	Mandatory	1
Loop LX	Assigned Number	Optional	25
LX	Assigned Number	Mandatory	1
L0	Line Item - Quantity and Weight	Optional	10
L1	Rate and Charges	Optional	10
LE	Loop Trailer	Mandatory	1
L7	Tariff Reference	Optional	30
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
L3	Total Weight and Charges	Optional	1
Loop LS	Loop Header	Optional	1
LS	Loop Header	Mandatory	1
Loop LH1	Hazardous Identification Information	Optional	50
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
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
X7	Customs Information	Optional	10
GA	Canadian Grain Information	Optional	1
SE	Transaction Set Trailer	Optional	1