RETANN Announcement for returns message (D98B)

This is the standard EDIFACT D98B spec, with 24 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.

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 (96 KB) Generate classes
The ediFabric .NET template, class TSRETANN. It needs the common segments, composites and codes of EDIFACT D98B, one download for every transaction in the version. Download C# (1 KB) Common files (51 KB)
The intermediary model ediFabric Native loads with set_map. Native supports X12 today, and EDIFACT is coming. Download Native (1 KB)

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

ediFabric Native

Native supports X12 today, and EDIFACT is coming. When it's available, map version D98B to this Native model with set_map to parse RETANN 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 RETANN classes in Python, Java, Node.js, Go, Rust or C

The OpenEDI file describes each RETANN as JSON. To work with RETANN data as typed objects, generate classes from the OpenEDI file in your language; the root class is TSRETANN. 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.

RETANN structure

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

IDNameUsageMax use
UNHMessage HeaderOptional1
BGMBEGINNING OF MESSAGEMandatory1
DTMDATE/TIME/PERIODOptional9
FTXFREE TEXTOptional9
Loop DOCDOCUMENT/MESSAGE DETAILSOptional9
DOCDOCUMENT/MESSAGE DETAILSMandatory1
DTMDATE/TIME/PERIODOptional9
Loop RFFREFERENCEOptional9
RFFREFERENCEMandatory1
DTMDATE/TIME/PERIODOptional9
Loop NADNAME AND ADDRESSOptional9
NADNAME AND ADDRESSMandatory1
LOCPLACE/LOCATION IDENTIFICATIONOptional9
Loop RFFREFERENCEOptional9
RFFREFERENCEMandatory1
DTMDATE/TIME/PERIODOptional9
Loop CTACONTACT INFORMATIONOptional9
CTACONTACT INFORMATIONMandatory1
COMCOMMUNICATION CONTACTOptional9
Loop TODTERMS OF DELIVERY OR TRANSPORTOptional9
TODTERMS OF DELIVERY OR TRANSPORTMandatory1
LOCPLACE/LOCATION IDENTIFICATIONOptional9
Loop TDTDETAILS OF TRANSPORTOptional9
TDTDETAILS OF TRANSPORTMandatory1
LOCPLACE/LOCATION IDENTIFICATIONOptional9
DTMDATE/TIME/PERIODOptional9
Loop EQDEQUIPMENT DETAILSOptional9
EQDEQUIPMENT DETAILSMandatory1
MEAMEASUREMENTSOptional9
FTXFREE TEXTOptional9
Loop ALCALLOWANCE OR CHARGEOptional9
ALCALLOWANCE OR CHARGEMandatory1
ALIADDITIONAL INFORMATIONOptional9
DTMDATE/TIME/PERIODOptional9
MOAMONETARY AMOUNTOptional9
Loop TAXDUTY/TAX/FEE DETAILSOptional9
TAXDUTY/TAX/FEE DETAILSMandatory1
MOAMONETARY AMOUNTOptional9
Loop LINLINE ITEMMandatory9999
LINLINE ITEMMandatory1
PIAADDITIONAL PRODUCT IDOptional9
IMDITEM DESCRIPTIONOptional9
MEAMEASUREMENTSOptional9
DTMDATE/TIME/PERIODOptional9
PRIPRICE DETAILSOptional9
FTXFREE TEXTOptional9
LOCPLACE/LOCATION IDENTIFICATIONOptional9
MOAMONETARY AMOUNTOptional9
Loop TAXDUTY/TAX/FEE DETAILSOptional9
TAXDUTY/TAX/FEE DETAILSMandatory1
MOAMONETARY AMOUNTOptional9
Loop QTYQUANTITYOptional9
QTYQUANTITYMandatory1
CDIPHYSICAL OR LOGICAL STATEOptional9
Loop DOCDOCUMENT/MESSAGE DETAILSOptional9
DOCDOCUMENT/MESSAGE DETAILSMandatory1
DTMDATE/TIME/PERIODOptional9
Loop RFFREFERENCEOptional9
RFFREFERENCEMandatory1
DTMDATE/TIME/PERIODOptional9
Loop DGSDANGEROUS GOODSOptional9
DGSDANGEROUS GOODSMandatory1
QTYQUANTITYOptional9
FTXFREE TEXTOptional9
Loop HANHANDLING INSTRUCTIONSOptional9
HANHANDLING INSTRUCTIONSMandatory1
FTXFREE TEXTOptional9
Loop PACPACKAGEOptional9
PACPACKAGEMandatory1
Loop PCIPACKAGE IDENTIFICATIONOptional9
PCIPACKAGE IDENTIFICATIONMandatory1
DTMDATE/TIME/PERIODOptional9
GINGOODS IDENTITY NUMBEROptional9
Loop TDTDETAILS OF TRANSPORTOptional9
TDTDETAILS OF TRANSPORTMandatory1
LOCPLACE/LOCATION IDENTIFICATIONOptional9
DTMDATE/TIME/PERIODOptional9
Loop EQDEQUIPMENT DETAILSOptional9
EQDEQUIPMENT DETAILSMandatory1
MEAMEASUREMENTSOptional9
FTXFREE TEXTOptional9
Loop ALCALLOWANCE OR CHARGEOptional9
ALCALLOWANCE OR CHARGEMandatory1
ALIADDITIONAL INFORMATIONOptional9
DTMDATE/TIME/PERIODOptional9
MOAMONETARY AMOUNTOptional9
Loop TAXDUTY/TAX/FEE DETAILSOptional9
TAXDUTY/TAX/FEE DETAILSMandatory1
MOAMONETARY AMOUNTOptional1
UNSSECTION CONTROLMandatory1
CNTCONTROL TOTALOptional9
MOAMONETARY AMOUNTOptional9
Loop TAXDUTY/TAX/FEE DETAILSOptional9
TAXDUTY/TAX/FEE DETAILSMandatory1
MOAMONETARY AMOUNTOptional9
UNTMessage TrailerOptional1