311 Canada Customs Information (005050)

This is the standard X12 005050 spec, with 4 loops and 29 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 (74 KB) Generate classes

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

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

Use the 311 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 311 files into TS311 objects. See ediFabric .NET.

ediFabric Native

Map version 005050 to the Native model with set_map, then parse 311 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 311 classes in Python, Java, Node.js, Go, Rust or C

ediFabric Native returns each 311 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 TS311. 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.

311 structure

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

ID	Name	Usage	Max use
ST	Transaction Set Header	Optional	1
B2A	Set Purpose	Mandatory	1
Y6	Authentication	Optional	2
N9	Extended Reference Information	Mandatory	10
V1	Vessel Identification	Optional	1
V2	Vessel Information	Optional	1
V3	Vessel Schedule	Optional	1
DTM	Date/Time Reference	Optional	2
Loop N1	Party Identification	Mandatory	10
N1	Party Identification	Mandatory	1
N2	Additional Name Information	Optional	1
N3	Party Location	Optional	2
N4	Geographic Location	Optional	1
R4	Port or Terminal	Mandatory	10
K1	Remarks	Optional	5
Loop LX	Transaction Set Line Number	Mandatory	999
LX	Transaction Set Line Number	Mandatory	1
Y2	Container Details	Optional	10
Loop ED	Equipment Description	Optional	999
ED	Equipment Description	Mandatory	1
M7	Seal Numbers	Optional	5
NA	Cross-Reference Equipment	Optional	1
L4	Measurement	Optional	1
G2	Beyond Routing	Optional	1
Loop L0	Line Item - Quantity and Weight	Optional	120
L0	Line Item - Quantity and Weight	Mandatory	1
L5	Description, Marks and Numbers	Mandatory	999
L4	Measurement	Optional	1
X1	Export License	Optional	5
X2	Import License	Optional	5
L3	Total Weight and Charges	Optional	1
K1	K12	Optional	2
SE	Transaction Set Trailer	Optional	1