ballerinax/edifact.d03a.shipping Ballerina library

Overview

UN/EDIFACT is the United Nations standard for electronic data interchange, used to exchange business documents such as orders, invoices and despatch advices between trading partners.

This package provides Ballerina record types and parser functions for the 34 UN/EDIFACT D03A messages grouped under shipping: container announcement, release, gate-in/gate-out, discharge/loading and stuffing/stripping messages, bayplan and stowage plans, equipment stock and special handling orders, customs declarations, cargo reports and responses, and contract tendering and valuation messages.

Key Features

• Typed records for all 34 messages in the shipping group, each in its own submodule, so a program only pulls in the records for the messages it handles.
• Envelope-aware parsing and serialization: an interchange is read from UNB through UNZ, including the UNH/UNT message header and trailer.
• Round-trips in both directions — EDI text to records, and records back to conformant EDI text with the UNT segment count recomputed.
• Generated from the UN/EDIFACT D03A directory with the Ballerina EDI tool, so the records follow the published specification.

Quickstart

To use the edifact.d03a.shipping package in your Ballerina application, modify the .bal file as follows:

Step 1: Import the module

Import the package and the submodules for the messages you handle.

import ballerina/io;
import ballerinax/edifact.d03a.shipping;
import ballerinax/edifact.d03a.shipping.mBAPLIE;

Step 2: Read an EDI message

Convert an EDIFACT interchange into a Ballerina record.

public function main() returns error? {
    string ediText = check io:fileReadString("baplie.edi");
    mBAPLIE:EDI_BAPLIE_BAPLIE message =
        check shipping:fromEdiString(ediText, shipping:EDI_BAPLIE).ensureType();
    io:println(message);
}

shipping:getEDINames() returns every message name this package supports. interchangeFromEdiString gives access to the full UNB/UNZ interchange, and headersFromEdiString reads just the headers.

Step 3: Write an EDI message

Convert a Ballerina record back into an EDIFACT interchange.

string ediText = check shipping:toEdiString(message, shipping:EDI_BAPLIE);

Use interchangeToEdiString to write the full interchange rather than the message body alone.

Step 4: Run the Ballerina application

bal run

Supported messages