Onboarding Guidelines for EDIFACT Messages for Shipping Agents
Introduction
This document describes guidelines for onboarding to CPu for partners that choose to send EDIFACT messages. EDIFACT message types in scope are:
For most of these message types, conventions in BEANR are already in place (see links above). For CPu, a few additional information segments may be required on top of these conventions.
General Guidelines
Provide us with a representative sample set
Provide us with a representative sample set, preferably with multiple partner recipients, of the message types you intend to use.
a collection of all messages of a specific type you send out during a period of one month is advised.
ensure the sample set includes all Message Functions you intend to use
The preferred method of delivery to us is a ZIP file. If you require another method of delivery, please contact us.
Always send us COPIES
Always send us COPIES of the original messages you send to partners. Please do NOT generate dedicated messages with NXTPORT as receiver.
This way, we can see the communication flow from partner to partner. If you would use dedicated messages to NXTPORT, we cannot deduce to whom the message was sent.
Provide a complete list of Sender/Receiver and Location IDs
Besides the sample set, please provide us with a complete list of:
Sender IDs you use in the UNB section of the messages (APCS and non-APCS)
Receiver IDs you use in the UNB section of the messages (APCS and non-APCS)
Primary Locations you use in the LOC section of the messages that indicate ports in Belgium, for example:
BEANR
BEZEE
Secondary Locations you use in the LOC section of the messages that indicate terminals in Belgian ports, for example:
1700
K1700
01700
Kaai1700
etc.
COREOR Guidelines
Besides the existing conventions defined for COREOR in the Port of Antwerp, CPu would benefit from a few additional information segments.
The following code values are supported:
3 Deletion
9 Original
For support of other code values, please contact NxtPort. Support for other codes could be considered.
Multiple COREOR In One Message
The BEANR conventions require a single COREOR per equipment. Some providers have given us composed messages, consisting of multiple COREOR messages nested into one UNB+UNOA.
UNA DEFINITION
----------------------------------------------------------------------------
Delimiter M a...6........: ':+.? ''
UNB INTERCHANGE HEADER
----------------------------------------------------------------------------
010 0001 Syntax identifier M a...4........: 'UNOC' {UN/ECE level C}
0002 Syntax version number M n...1........: '2'
020 0004 Sender identification M an..35.......: '******'
0007 Partner identification code qualifier C an..4........: ''
0008 Address for reverse routing C an..14.......: ''
030 0010 Recipient identification M an..35.......: '******'
0007 Partner identification code qualifier C an..4........: ''
0014 Routing address C an..14.......: ''
040 0017 Date of preparation M n...6........: '200924'
0019 Time of preparation M n...4........: '0407'
050 0020 INTERCHANGE CONTROL REFERENCE M an..14.......: '11251'
060 0022 Recipient's reference/password M an..14.......: ''
0025 Recipient's reference/password qualifier C an..2........: ''
070 0026 APPLICATION REFERENCE C an..14.......: ''
080 0029 PROCESSING PRIORITY CODE C a...1........: ''
090 0031 ACKNOWLEDGEMENT REQUEST C n...1........: ''
100 0032 COMMUNICATIONS AGREEMENT ID C an..35.......: ''
110 0035 TEST INDICATOR C n...1........: ''
>>> This is the beginning of the first message
UNH MESSAGE HEADER
----------------------------------------------------------------------------
010 0062 MESSAGE REFERENCE NUMBER M an..14.......: '194550'
020 0065 Message type M an..6........: 'COREOR' {Container release order message}
0052 Message version number M an..3........: 'D'
0054 Message release number M an..3........: '95B'
0051 Controlling agency M an..2........: 'UN' {UN/ECE/TRADE/WP.4, United Nations Standard Messages (UNSM)}
0057 Association assigned code C an..6........: 'HNN' {unknown value!}
030 0068 COMMON ACCESS REFERENCE C an..35.......: ''
040 0070 Sequence of transfers M n...2........: ''
0073 First and last transfer C a...1........: ''
BGM BEGINNING OF MESSAGE
----------------------------------------------------------------------------
010 1001 Document/message name, coded C an..3........: '12' {Mill certificate}
1131 Code list qualifier C an..3........: ''
3055 Code list responsible agency, coded C an..3........: ''
1000 Document/message name C an..35.......: ''
020 1004 DOCUMENT/MESSAGE NUMBER C an..35.......: 'SA00547363'
030 1225 MESSAGE FUNCTION, CODED C an..3........: '9' {Original}
040 4343 RESPONSE TYPE, CODED C an..3........: ''
.... More Segments here, omitted for example
CNT CONTROL TOTAL
----------------------------------------------------------------------------
010 6069 Control qualifier M an..3........: '16' {Total number of equipment}
6066 Control value M n..18........: '1'
6411 Measure unit qualifier C an..3........: ''
UNT MESSAGE TRAILER
----------------------------------------------------------------------------
010 0074 NUMBER OF SEGMENTS IN THE MESSAGE M n...6........: '14'
020 0062 MESSAGE REFERENCE NUMBER M an..14.......: '194550'
>>> This is the end of the first message and the beginning of the second
UNH MESSAGE HEADER
----------------------------------------------------------------------------
010 0062 MESSAGE REFERENCE NUMBER M an..14.......: '194551'
020 0065 Message type M an..6........: 'COREOR' {Container release order message}
0052 Message version number M an..3........: 'D'
0054 Message release number M an..3........: '95B'
0051 Controlling agency M an..2........: 'UN' {UN/ECE/TRADE/WP.4, United Nations Standard Messages (UNSM)}
0057 Association assigned code C an..6........: 'HNN' {unknown value!}
030 0068 COMMON ACCESS REFERENCE C an..35.......: ''
040 0070 Sequence of transfers M n...2........: ''
0073 First and last transfer C a...1........: ''
BGM BEGINNING OF MESSAGE
----------------------------------------------------------------------------
010 1001 Document/message name, coded C an..3........: '12' {Mill certificate}
1131 Code list qualifier C an..3........: ''
3055 Code list responsible agency, coded C an..3........: ''
1000 Document/message name C an..35.......: ''
020 1004 DOCUMENT/MESSAGE NUMBER C an..35.......: 'SA00547363'
030 1225 MESSAGE FUNCTION, CODED C an..3........: '9' {Original}
040 4343 RESPONSE TYPE, CODED C an..3........: ''
....More Segments here, omitted for example
CNT CONTROL TOTAL
----------------------------------------------------------------------------
010 6069 Control qualifier M an..3........: '16' {Total number of equipment}
6066 Control value M n..18........: '1'
6411 Measure unit qualifier C an..3........: ''
UNT MESSAGE TRAILER
----------------------------------------------------------------------------
010 0074 NUMBER OF SEGMENTS IN THE MESSAGE M n...6........: '14'
020 0062 MESSAGE REFERENCE NUMBER M an..14.......: '194560'
UNZ INTERCHANGE TRAILER
----------------------------------------------------------------------------
010 0036 INTERCHANGE CONTROL COUNT M n...6........: '11'
020 0020 INTERCHANGE CONTROL REFERENCE M an..14.......: '11251'
This is in itself not an issue, but please limit the size of such composed messages.
Bill Of Lading
CPu requires the B/L during the entire flow from declaration to pick-up. It is therefore essential that as many message types as possible contain the B/L.
According to UNECE standards, the B/L is passed in an RFF segment with qualifier BM:
RFF REFERENCE
----------------------------------------------------------------------------
010 1153 Reference qualifier M an..3........: 'BM' {Bill Of Lading}
1154 Reference number C an..35.......: '*************'
1156 Line number C an..6........: ''
4000 Reference version number C an..35.......: ''You can also use the qualifier BN (Booking Number) or TF (Transfer Number) alternatively.
PIN Code & Validity Date Range
For phase 1, PIN codes will be obfuscated and replaced by ‘XXXXX’ in all incoming COREOR messages. No PIN code will be processed or saved anywhere in our systems.
According to BEANR Conventions, the B/L is passed in an RFF segment with qualifier ACD or ACW:
RFF REFERENCE
----------------------------------------------------------------------------
010 1153 Reference qualifier M an..3........: 'ACD' {Additional reference number}
1154 Reference number C an..35.......: 'PIN CODE'
1156 Line number C an..6........: ''
4000 Reference version number C an..35.......: ''You can also use the qualifier RE alternatively.
You CANNOT use qualifiers TF or BN for PIN codes because some providers use these for passing the B/L.
The PIN Code and B/L Values MUST be different.
In addition to the PIN Code, CPu benefits from a Validity Date Range for the PIN Code. The recommended way to pass a Valid From and Valid To Date is:
DTM DATE/TIME/PERIOD
----------------------------------------------------------------------------
010 2005 Date/time/period qualifier M an..3........: '7' {Effective date/time}
2380 Date/time/period C an..35.......: '201911260000'
2379 Date/time/period format qualifier C an..3........: '203' {CCYYMMDDHHMM}
DTM DATE/TIME/PERIOD
----------------------------------------------------------------------------
010 2005 Date/time/period qualifier M an..3........: '400' {Valid Until}
2380 Date/time/period C an..35.......: '201912180000'
2379 Date/time/period format qualifier C an..3........: '203' {CCYYMMDDHHMM}If this date range is not provided, a default range will be used with no expiration and starting from the composition time of the message as defined in the BGM.
Initial Release Party Assignment
The assignment of the first release party (FRP) can be done through the CPu API. If you want to pass it in the COREOR, use a NAD segment as follows:
NAD NAME AND ADDRESS
----------------------------------------------------------------------------
010 3035 PARTY QUALIFIER M an..3........: 'FW' {Freight Forwarder}
020 3039 Party id. identification M an..35.......: 'APCS-ID_OF_FORWARDER'
1131 Code list qualifier C an..3........: ''
3055 Code list responsible agency, coded C an..3........: ''
030 3124 Name and address line M an..35.......: ''
3124 Name and address line C an..35.......: ''
3124 Name and address line C an..35.......: ''
3124 Name and address line C an..35.......: ''
3124 Name and address line C an..35.......: ''
040 3036 Party name M an..35.......: ''
3036 Party name C an..35.......: ''
3036 Party name C an..35.......: ''
3036 Party name C an..35.......: ''
3036 Party name C an..35.......: ''
3045 Party name format, coded C an..3........: ''
050 3042 Street and number/p.o. box M an..35.......: ''
3042 Street and number/p.o. box C an..35.......: ''
3042 Street and number/p.o. box C an..35.......: ''
060 3164 CITY NAME C an..35.......: ''
070 3229 COUNTRY SUB-ENTITY IDENTIFICATION C an..9........: ''
080 3251 POSTCODE IDENTIFICATION C an..9........: ''
090 3207 COUNTRY, CODED C an..3........: ''Where 020 - Party ID consists of ID_TYPE + “-” + ID, for example:
APCS-APCS_CODE
DUNS-DUNS_CODE
EORI-EORI_CODE
NXTPORT-NXTPORT_ENTITY_ID
TIN-TAX_ID_NUMBER
Transhipment Containers
Please do NOT send us COREOR for Transhipment containers. (discharged from vessel / feeder and loaded onto another vessel / feeder on de same quay / terminal). In BEANR, by convention, this is covered by the COPRAR (discharge and loading order).
Equipment Details
In the EQD segment, please provide:
Equipment Type (010)
Equipment Number (020)
Equipment size and type identification (030) ISO code
Equipment Status (050)
Full/Empty indicator (060):
EQD EQUIPMENT DETAILS
----------------------------------------------------------------------------
010 8053 EQUIPMENT QUALIFIER M an..3........: 'CN' {Container}
020 8260 Equipment identification number C an..17.......: '************'
1131 Code list qualifier C an..3........: ''
3055 Code list responsible agency, coded C an..3........: ''
3207 Country, coded C an..3........: ''
030 8155 Equipment size and type identification C an..10.......: '2210'
1131 Code list qualifier C an..3........: '102' {Size and type}
3055 Code list responsible agency, coded C an..3........: '5' {ISO (International Organization for Standardization)}
8154 Equipment size and type C an..35.......: ''
040 8077 EQUIPMENT SUPPLIER, CODED C an..3........: ''
050 8249 EQUIPMENT STATUS, CODED C an..3........: '3' {Import}
060 8169 FULL/EMPTY INDICATOR, CODED C an..3........: '5' {Full}Discharge Port & Terminal
Please provide Port and Terminal Discharge Information in a LOC segment:
LOC PLACE/LOCATION IDENTIFICATION
----------------------------------------------------------------------------
010 3227 PLACE/LOCATION QUALIFIER M an..3........: '88' {Place of receipt}
020 3225 Place/location identification C an..25.......: 'BEANR'
1131 Code list qualifier C an..3........: '139' {Port}
3055 Code list responsible agency, coded C an..3........: '6' {UN/ECE (United Nations - Economic Commission for Europe)}
3224 Place/location C an..17.......: ''
030 3223 Related place/location one identification C an..25.......: '1742'
1131 Code list qualifier C an..3........: 'TER'
3055 Code list responsible agency, coded C an..3........: 'ZZZ' {Mutually defined}
3222 Related place/location one C an..70.......: ''
040 3233 Related place/location two identification C an..25.......: ''
1131 Code list qualifier C an..3........: ''
3055 Code list responsible agency, coded C an..3........: ''
3232 Related place/location two C an..70.......: ''
050 5479 RELATION, CODED C an..3........: ''For the Location Qualifier (010), you can use either 88 (Place of Receipt) or 11 (Port of Discharge).
For the Related place/location one identification (030), please provide us with a complete list of IDs you will use, as mention in section 2.3.
Important: even if you only work with a single Terminal (Operator) in BEANR, please provide the secondary location.
BGM DocumentNameCode in BEANR vs UNECE Standards
As mandated by BEANR/C-Point conventions, the following BGM qualifier codes are different from UNECE Standards:
12 (MillingCertificate) is used as Transport Equipment Movement Instruction
We are aware of this, no change is required on your side.
CUSCAR
We are still determining the details on how to incorporate CUSCAR in CPu. For most onboarding agents, we already receive CUSCAR.
Need any further assistance?
