CUSCAR Customs cargo report message (D01B)
This is the standard EDIFACT D01B spec, with 17 loops and 72 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 CUSCAR 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 CUSCAR files into TSCUSCAR objects. See ediFabric .NET.
ediFabric Native
Native supports X12 today, and EDIFACT is coming. When it's available, map version D01B to this Native model with set_map to parse CUSCAR files to JSON from Python, Java, C or C#. See ediFabric Native.
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 CUSCAR classes in Python, Java, Node.js, Go, Rust or C
The OpenEDI file describes each CUSCAR as JSON. To work with CUSCAR data as typed objects, generate classes from the OpenEDI file in your language; the root class is TSCUSCAR. The classes keep the loops, segments, lengths and code lists, but not the EDI data formats. Read more in Generate a class from OpenEDI.
Python: datamodel-code-generator. Node.js: openapi-typescript. Java, Go, Rust and C: OpenAPI Generator.
For a sample file, the same data as JSON, and code to parse, validate and generate the CUSCAR, see the CUSCAR transaction guide.
CUSCAR structure
Loops and segments of the standard CUSCAR, with their usage and maximum repeats.
| ID | Name | Usage | Max use |
|---|---|---|---|
| UNH | Message Header | Optional | 1 |
| BGM | BEGINNING OF MESSAGE | Mandatory | 1 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| LOC | PLACE/LOCATION IDENTIFICATION | Optional | 9 |
| QTY | QUANTITY | Optional | 9 |
| Loop RFF | REFERENCE | Optional | 99 |
| RFF | REFERENCE | Mandatory | 1 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| Loop NAD | NAME AND ADDRESS | Optional | 99 |
| NAD | NAME AND ADDRESS | Mandatory | 1 |
| DTM | DATE/TIME/PERIOD | Optional | 1 |
| Loop CTA | CONTACT INFORMATION | Optional | 9 |
| CTA | CONTACT INFORMATION | Mandatory | 1 |
| COM | COMMUNICATION CONTACT | Optional | 9 |
| FTX | FREE TEXT | Optional | 9 |
| Loop TDT | DETAILS OF TRANSPORT | Optional | 9 |
| TDT | DETAILS OF TRANSPORT | Mandatory | 1 |
| LOC | PLACE/LOCATION IDENTIFICATION | Optional | 99 |
| DTM | DATE/TIME/PERIOD | Optional | 99 |
| GIS | GENERAL INDICATOR | Optional | 9 |
| Loop EQD | EQUIPMENT DETAILS | Optional | 9999 |
| EQD | EQUIPMENT DETAILS | Mandatory | 1 |
| TSR | TRANSPORT SERVICE REQUIREMENTS | Optional | 9 |
| MEA | MEASUREMENTS | Optional | 9 |
| DIM | DIMENSIONS | Optional | 9 |
| SEL | SEAL NUMBER | Optional | 9 |
| NAD | NAME AND ADDRESS | Optional | 9 |
| GIS | GENERAL INDICATOR | Optional | 9 |
| LOC | PLACE/LOCATION IDENTIFICATION | Optional | 1 |
| Loop TMP | TEMPERATURE | Optional | 9 |
| TMP | TEMPERATURE | Mandatory | 1 |
| RNG | RANGE DETAILS | Optional | 1 |
| CNT | CONTROL TOTAL | Optional | 9 |
| Loop CNI | CONSIGNMENT INFORMATION | Optional | 9999 |
| CNI | CONSIGNMENT INFORMATION | Mandatory | 1 |
| CNT | CONTROL TOTAL | Optional | 9 |
| Loop RFF | REFERENCE | Optional | 9999 |
| RFF | REFERENCE | Mandatory | 1 |
| CNT | CONTROL TOTAL | Optional | 9 |
| MOA | MONETARY AMOUNT | Optional | 9 |
| LOC | PLACE/LOCATION IDENTIFICATION | Optional | 99 |
| GIS | GENERAL INDICATOR | Optional | 9 |
| CUX | CURRENCIES | Optional | 9 |
| CPI | CHARGE PAYMENT INSTRUCTIONS | Optional | 9 |
| Loop TDT | DETAILS OF TRANSPORT | Optional | 9 |
| TDT | DETAILS OF TRANSPORT | Mandatory | 1 |
| LOC | PLACE/LOCATION IDENTIFICATION | Optional | 9 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| MEA | MEASUREMENTS | Optional | 9 |
| Loop RFF | REFERENCE | Optional | 9 |
| RFF | REFERENCE | Mandatory | 1 |
| TSR | TRANSPORT SERVICE REQUIREMENTS | Optional | 9 |
| Loop NAD | NAME AND ADDRESS | Optional | 99 |
| NAD | NAME AND ADDRESS | Mandatory | 1 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| RFF | REFERENCE | Optional | 9 |
| Loop CTA | CONTACT INFORMATION | Optional | 9 |
| CTA | CONTACT INFORMATION | Mandatory | 1 |
| COM | COMMUNICATION CONTACT | Optional | 9 |
| Loop QTY | QUANTITY | Optional | 9 |
| QTY | QUANTITY | Mandatory | 1 |
| FTX | FREE TEXT | Optional | 9 |
| Loop GID | GOODS ITEM DETAILS | Mandatory | 9999 |
| GID | GOODS ITEM DETAILS | Mandatory | 1 |
| PAC | PACKAGE | Optional | 9 |
| HAN | HANDLING INSTRUCTIONS | Optional | 9 |
| FTX | FREE TEXT | Optional | 99 |
| MEA | MEASUREMENTS | Optional | 99 |
| MOA | MONETARY AMOUNT | Optional | 9 |
| SGP | SPLIT GOODS PLACEMENT | Optional | 9999 |
| DGS | DANGEROUS GOODS | Optional | 9 |
| PCI | PACKAGE IDENTIFICATION | Optional | 9 |
| CST | CUSTOMS STATUS OF GOODS | Optional | 1 |
| LOC | PLACE/LOCATION IDENTIFICATION | Optional | 9 |
| TMD | TRANSPORT MOVEMENT DETAILS | Optional | 9 |
| Loop GIS | GENERAL INDICATOR | Optional | 9 |
| GIS | GENERAL INDICATOR | Mandatory | 1 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| DOC | DOCUMENT/MESSAGE DETAILS | Optional | 9 |
| PAC | PACKAGE | Optional | 9 |
| MEA | MEASUREMENTS | Optional | 9 |
| Loop QTY | QUANTITY | Optional | 9 |
| QTY | QUANTITY | Mandatory | 1 |
| FTX | FREE TEXT | Optional | 1 |
| Loop AUT | AUTHENTICATION RESULT | Optional | 1 |
| AUT | AUTHENTICATION RESULT | Mandatory | 1 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| RFF | REFERENCE | Optional | 9 |
| UNT | Message Trailer | Optional | 1 |