0% found this document useful (0 votes)
87 views

Sea Cargo Manifest & Transhipment Regulations, 2018: Message Implementation Guide

The document provides guidelines for submitting an E-Seal Container Departure Message declaration to customs through ICEGATE in JSON format. It outlines the steps to prepare and submit the file, including using a utility to generate the JSON format from existing data. Upon submission, an acknowledgment file will be returned with response codes. Annexures provide details on the JSON schema, sample formats, codes, and error codes.

Uploaded by

Pralay Dhote
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
87 views

Sea Cargo Manifest & Transhipment Regulations, 2018: Message Implementation Guide

The document provides guidelines for submitting an E-Seal Container Departure Message declaration to customs through ICEGATE in JSON format. It outlines the steps to prepare and submit the file, including using a utility to generate the JSON format from existing data. Upon submission, an acknowledgment file will be returned with response codes. Annexures provide details on the JSON schema, sample formats, codes, and error codes.

Uploaded by

Pralay Dhote
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 40

Message Implementation Guide

ementation Guide

Sea Cargo Manifest &


Transhipment Regulations, 2018

Sea Cargo Manifest &


Directorate General of Systems
and Data Management Ver. 1.0 , 27.02.2019
Transhipment Regulations, 2018
Leveraging Technology For Serving Taxpayers
Leveraging Technology For Serving Taxpayers
2
Table of Contents
REVISION HISTORY ........................................................................................................................................ 2
1. Introduction .............................................................................................................................................. 3
1.1 Background: ........................................................................................................................................ 3
1.2 Scope: .................................................................................................................................................. 3
1.3 Stakeholders Involved ......................................................................................................................... 3
2. Message Guidelines .................................................................................................................................. 4
2.1 Introduction ........................................................................................................................................ 4
2.2 Exchange of Information - Steps: ........................................................................................................ 4
2.2.1 Preparation of File: ...................................................................................................................... 4
2.2.2 Submission of the File – ICEGATE: ............................................................................................... 4
2.2.3 Acknowledgement of the Declaration: ........................................................................................ 4
3. Customs Inland Manifest Format: ............................................................................................................ 5
3.1Declaration - JSON Objects: ............................................................................................................. 5
3.2 Document Structure/Hierarchy: ..................................................................................................... 5
Annexure A - Attribute Tables: ..................................................................................................................... 6
A.1 IECHE01- ES (Eseal Departure Notification) -Declaration: .................................................................. 6
A.2 CHIEE01A - Eseal Departure Notification – Acknowledgement ....................................................... 11
Annexure B – Json Schema & Sample Formats:.......................................................................................... 13
B.1. IECHE01-ES (Eseal Departure Notification ) – Json Schema: ........................................................... 13
B.2. IECHE01-ES - (ESeal Departure Notification) – Sample Json............................................................ 25
B.3 CHIEE01A-ES ( Eseal Departure Notification Ack. )– Json Schema ................................................... 28
B.4 CHIEE01A – ES ( Eseal Departure Notification Ack.)- Sample Json ................................................... 36
Annexure C – List of Values :....................................................................................................................... 37
Annexure D – Error Codes:.......................................................................................................................... 38
D.1 Error Codes – Structural Validations :.............................................................................................. 38
D.2 Error Code – Data Validations: ......................................................................................................... 38

1
REVISION HISTORY
Version Date Author Approved By Comments

Container 03/12/2018 Esha Added JSON with Sample values,


Status Message Sharma Objects and attributes added for
Implementation json.
Guide V 0.2

Container 17/01/2019 Esha Added JSON with Sample values,


Status Message Sharma Objects and attributes added for
Implementation json.Added modified fields.
Guide V 0.2.1

Container 23/01/2019 Esha Added Error Codes and made all


Status Message Sharma necessary changes.
Implementation
Guide V 0.2.2

2
1. Introduction
1.1 Background:
Central Board of Indirect Taxes and Custom (CBIC) vide notification No. 38/2018-Cus (NT)dated
11.05.2018 read with notification No. 65/2018-Cus (NT) dated 30.07.2018 and 88/2018-Cus(NT) dated
30.10.2018 notified Sea Cargo Manifest and Transhipment Regulations 2018.

This regulation supersedes the earlier regulations of Import Manifest (Vessels) Regulations, 1971,
Export Manifest (Vessels) Regulation, 1976 and Transportation of Goods (Through Foreign Territory)
Regulations of 1965. The new regulation stipulates changes in timelines and requirements for advance
notice by shipping lines (vessels) arriving in India and Exports through shipping lines (vessels) out of India.

Further, CBIC has notified implementation of E-Seal for Export Containers vide Board Circular No.
36/2017 dated 28.08.2017as amended from time to time. The Government intends to encourage safe and
secure Transport of Export bound Containers through implementation of E-Seal. Though the Facilitation
for exporters using E-Seal is in place, automation of entire procedure would add efficiency to the existing
procedure.

In the proposed procedure, The Exporters intending to avail E-Seal needs to complete one-time
registration at the ICEGATE. The Application submitted would be approved by officers online. E-Seal
affixed should be from a vendor authorized by Indian Customs. The Vendor registered on ICEGATE would
submit Seal details to ICEGATE. The Exporters availing E-Seal is required to report departure of containers
from their premises to ICEGATE using E-Seal Container Departure Message.

1.2 Scope:
The Scope of this document is to provide list of messages involved in this process and provide
format, sample for generation of declaration. The list of messages are as follows:

1. E-Seal Container Departure Message by Exporter

1.3 Stakeholders Involved


Following Stakeholders are involved in the implementation

1. Exporter authorized for E-seal and registered with ICEGATE

2. Custodian notified by Customs under HCCAR

3
2. Message Guidelines
2.1 Introduction
The Declaration is to be submitted as Json format. The following sections would explain
the details of the declarations, Format and Sample Json file.

2.2 Exchange of Information - Steps:


2.2.1 Preparation of File:
This message guideline would help the users to prepare the declaration in the required format.
The users can either utilise the data already available in the internal systems to generate this declaration
in the required format by modifying their internal software systems or use an Excel utility provided by
CBIC/NIC in this regard. (The details of Excel Utility is given in the para 2.2.2). The following sections may
be referred for the preparation of the file.

a) The structure and Hierarchy of the json object is available in Section 3 of this document.
b) The attributes of the json objects for different messages is provided in Annexure A.
c) The Schema and Sample Json formats are available in Annexure B.
d) Certain data elements are coded for bringing uniformity in the processing. The List of values for
those data elements are given in Annexure C.
e) The file submitted to the ICEGATE should be in following name format.

F_IECHE01_ES_DBCSW2256R_3456556_17012019_DEC.json

(<messageType><msgID><reportingEvent><SenderID><jobID><date>_declaration)

The Declaration should be digitally signed as per the required format. (For more details, refer the following
link …………………………………….).

2.2.2 Submission of the File – ICEGATE:


The Declaration is to be submitted to Customs by User to ICEGATE either through Simple Mail
Transfer Protocol (SMTP) or through Web upload. (For more details refer Annexure A of
https://icegate.gov.in/com_guideline.html). The referred link also contains details on Excel Utility.

2.2.3 Acknowledgement of the Declaration:


Every File submitted to Customs through ICEGATE would be acknowledged along with the
response codes regarding acceptance or rejection of the declaration. The Format of Ack File and Json
schema is available in Annexure B. The List of Error Codes are available in Annexure D.

4
3. Customs Inland Manifest Format:
3.1Declaration - JSON Objects:
The Declaration is divided into six Sections. In Json, these are termed as Objects.

1. Message Header
2. Master – includes Vehicle details
3. Equipment Hold details – container or Bonded Truck used to store cargo and accompanying
eseal
4. Cargo – Cargo referenced by Customs Declaration (SB, BE, SMTP etc.)
5. Supporting Documents – Documents uploaded as pdf/image related to the declarations.
6. Signature – Properties of Digital Signature

3.2 Document Structure/Hierarchy:

Message Header

1..1
1..n 1..n
Master-Vehicle Equipment Hold Cargo
1..1
0..n
Supporting Documents

Signature

5
Annexure A - Attribute Tables:
A.1 IECHE01- ES (Eseal Departure Notification) -Declaration:

Object Attribute Name Description Data Type Required Sample


/Nillable
HeaderField senderID ICEGATE ID True/Fals DBCSW2256R
Required- Character(c)- e
True an..30
1..1 receiverID ICEGATE Number(N)- True/Fals INPPG1
code of Sea an..30 e
Manifest
versionNo ICEGATE Number(N)- True/Fals 100V
version a..4 e
being used
Indicator test (T) or Character(c)- True/Fals T
production a..1 e
(P) indicator
messageID message Character(c)- True/Fals IECHE01
name an..7 e
sequenceOrCo unique value Number(N)- True/Fals 9
ntrolNumber that can be n…3 e
used to
uniquely
identify the
document
Date Date of Date True/Fals 31122018
transmission e
of message
Time Time of Character(c) True/Fals 2245
transmission e
of message
reportingEvent Reporting Character(c)- True/Fals ES
Event a..4 e
IECHE01 Master Object Character(c) True/Fals
Required-True created for e
1..1 IECHE01
messageType Message Number(N) - True/Fals F
Type (F- a1 e
Fresh,A-
Amendment)

portOfReportin Port of Character(c) True/Fals INPPG1


g Reporting -an..6 e
jobNo Job Number Character(c)- True/Fals 3456589
n7 e

6
jobDate Job Date(DDMM True/Fals 31122018
Date(DDMM YYYY) e
YYYY)
Reporting Character(c)- True/Fals ES
reportingEvent Event a..4 e
CIMNumber Customs Character(c)- False/Tru 123
Inland n..15 e
Movement
Number
CIMDate Customs Date(DDMM False/Tru 22112018
Inland YYYY) e
Movement
Date(DDMM
YYYY)
Reporting Character(c)- True/Fals EXP
reportingPartyT Party Type a..7 e
ype
Reporting Character(c)- True/Fals ABCDE1234D
reportingParty Party Code an15 e
Code
Reference Character(c)- True/Fals EW
referenceMove Movement a2 e
mentType Type
referenceMove Reference Number(N)- True/Fals 180012123456
mentNumber Movement an…35 e
Number
referenceMove Reference Date True/Fals 22112018
mentDate Movement e
Date(DDMM
YYYY)
Bond Character(c)- False/Tru 12
bondNumber Number an10 e
Reporting Character(c)- True/Fals INCDE1234D
reportingLocati Location an..15 e
onCode Code
Reporting Character(c)- True/Fals Nagpur
reportingLocati Location a..35 e
onName Name
Next Character(c)- True/Fals INNSA1AGT1
nextDestinatio Destination an..10 e
nOfUnlading of Unloading
Transport Character(c)- True/Fals 2
transportMean Means Type a1 e
sType
Transport Character(c)- True/Fals MH01C1234
transportMean Means eID an..12 e
sNumber Number

7
Transport Character(c)- False/Tru FT
transportMean Means eID an..4 e
seIDType Type
Transport Character(c)- False/Tru 12345678
transportMean Means eID an..16 e
seID Number
Expected TIMESTAMP- False/Tru 20112018T22:45
expectedTimeO Time of ddmmyyyy e
fDeparture Departure(d hh24:mi
dmmyyyy
hh24:mi)
Actual Time TIMESTAMP- True/Fals 31112018T22:45
actualTimeOfD of ddmmyyyy e
eparture Departure(d hh24:mi
dmmyyyy
hh24:mi)
Expected TIMESTAMP- True/Fals 12112018T22:45
expectedTimeO Time of ddmmyyyy e
fArrival Arrival(ddm hh24:mi
myyyy
hh24:mi)
Actual Time TIMESTAMP- False/Tru 30112018T22:45
actualTimeOfAr of ddmmyyyy e
rival Arrival(ddm hh24:mi
myyyy
hh24:mi)
authorisedPers Authorised Character(c)- True/Fals DBCSW2256R
onPAN person PAN an..10 e
cargoContai EquipmentSequ EquipmentSe Number(N)- True/Fals 1
ner enceNo quenceNo n..5 e
Required- containerID ContainerID Character(c)- True/Fals ABN99088989
True an..11 e
1..n Equipment Character(c)- True/Fals C
equipmentType Type an..3 e
equipmentSize Equipment Character(c)- True/Fals 1234
Size a4 e
Equipment Character(c)- True/Fals FCL
equipmentLoad Load Status a3 e
Status
Additional Character(c)- True/Fals A
additionalEquip Equipment an..256 e
mentHold Number
Destination Character(c)- True/Fals INMAA42018
finalDestination Port Code an..10 e
Location

8
eventDate Event Timestamp(D True/Fals 21092017
Date(ddmmy DMMYYYY) e
yyy hh24:mi)
Equipment Character(c)- True/Fals ESEAL
equipmentSeal Seal Type a..5 e
Type
Equipment Character(c)- True/Fals AB453
equipmentSeal Seal Number a15 e
Number
Other Character(c)- False/Tru ATM2
otherEquipmen Equipment an..256 e
tID Number
Equipment Character(c)- True/Fals 127
equipmentStat Status a3 e
us
cargoDetails cargoSequence cargoSequen Number(N)- True/Fals 1234
Required- No ceNo n..4 e
True Document Character(c)- True/Fals SB
1..n documentType Type an..4 e
documentSite Document Character(c)- True/Fals INNSA1
Site an..6 e
Document Number(N)- True/Fals 23222223445
documentNum Number n..7 e
ber
Document DATE(DDMM True/Fals 21092016
documentDate Date(DDMM YYYY) e
YYYY)
ShipmentLoadS ShipmentLoa Character(c)- True/Fals
tatus dStatus a3 e
packageType Nature of Character(c)- True/Fals P
Packaging an..2 e
Quantity Quantity Character(c)- False/Tru
n..16,6 e
packetsFrom Packets From Number(N)- False/Tru 20
n6 e
packetsTo Packets To Number(N)- False/Tru 70
n6 e
packUQC Units of Character(c)- True/Fals AE
Packets a3 e
documentSerial documentSer Number(N)- True/Fals 21
supportingD Number ialNumber n..4 e
ocuments: equipmentSeri equipmentSe Number(N)- True/Fals 23
Required- alNumber rialNumber n..5 e
False cargoSerialNum Cargo Serial Number(N)- True/Fals DBCS
0…n ber Number n..4 e
ICEGATEUserID Icegate User Character(c)- True/Fals MASOND
Id a..15 e

9
IRNNumber IRN Number Number(N)- True/Fals 12346567
n..14 e
Document Number(N)- True/Fals 22334444444
documentRefer Number a..17 e
enceNumber assigned for
Identification
Document Character(c)- True/Fals AP
documentType Type Code a..6 e
Code
beneficiaryCod Beneficiary Character(c)- True/Fals AFRVGH
e Code a..35 e
startSignatur Character(c)- True/Fals Chgfhbvjhbjhgkjkjhikhlk
digSign startSignature e an.. e nkjhknkjhkjhkjhjmnkj
1..1 startCertificate Character(c)- True/Fals efgh45743
startCertifica an.. e
te
signerVersion Character(c)- True/Fals 1.0
signerVersio an.. e
n

10
A.2 CHIEE01A - Eseal Departure Notification – Acknowledgement

Object AttributeName Description DataType Required/ Sample


Nillable
CHIEE01 Master Object created for Character(c) True/False
A Required-True CHIEE01A
1..1
messageType Message Type (F- Number(N) -a1 True/False F
Fresh,A-
Amendment)

portOfReporting Port of Reporting Character(c) -an..6 True/False INPPG1


jobNo Job Number Character(c) -n7 True/False 3456589
jobDate Job Date(DDMMYYYY) True/False 31122018
Date(DDMMYYYY)
reportingEvent Reporting Event Character(c)- a..4 True/False CSM
CIMNumber Customs Inland Character(c)- n..12 False/True 123
Movement Number
CIMDate Customs Inland Date(DDMMYYYY) False/True 22112018
Movement
Date(DDMMYYYY)
masterErrorCode
pathName
errorCode
errorMessage
cargoCon EquipmentSequen EquipmentSequenc Number(N)- n..5 True/False 1
tainer ceNo eNo
Required containerID ContainerID Character(c)- an..11 True/False ABN99088
-True 989
1..n Equipment Type Character(c)- an..3 True/False C
equipmentType
cargoContainerErr
orCode
pathName
errorCode
errorMessage
cargoDet cargoSequenceNo cargoSequenceNo Number(N)- n..4 False/True 1234
ails
Document Type Character(c)- an..4 True/False SB
Required
documentType
-True
Document Site Character(c)- an..6 True/False INNSA1
1..n
documentSite

11
Document Number Number(N)- n..12 True/False 23222223
documentNumber 445
Document DATE(DDMMYYYY) True/False 21092016
documentDate Date(DDMMYYYY)
cargoDetailsError
Code
pathName
errorCode
errorMessage

supportin documentSerialNu Number(N)- n..4 True/False 21


gDocume documentSerialNu mber
nts: mber
Required equipmentSerialN equipmentSerialNu Number(N)- n..5 True/False 23
- False umber mber
1…1 cargoSerialNumbe Cargo Serial Number(N)- n..5 True/False DBCS
r Number
supportingDocum
entsErrorCode
pathName
errorCode
errorMessage
digSign startSignature Character(c)-an.. True/False chgfhbvjh
1..1 startSignature bjhgkjkjhik
hlknkjhkn
kjhkjhkjhj
mnkj
startCertificate startCertificate Character(c)-an.. True/False efgh45743
signerVersion signerVersion Character(c)-an.. True/False 1.0

12
Annexure B – Json Schema & Sample Formats:
B.1. IECHE01-ES (Eseal Departure Notification ) – Json Schema:

{
"headerField": {
"type": "object",
"required": true,
"properties": {

"senderID": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 30,
"description": "ICEGATE ID"
},
"receiverID": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 30,
"description": "Port code where declared"
},
"versionNo": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 7,
"description": "ICEGATE version being used: Default value 1.0"
},
"indicator": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 1,
"description": "test (T) or production (P) indicator"
},
"messageID": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 7,
"description": "Default value: IECHE01"
},
"sequenceOrControlNumber": {
"type": "string",
"required": true,

13
"minOccurs": "1",
"maxLength": 9,
"description": "unique value that can be used to uniquely identify the document at
User End"
},
"date": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 8,
"pattern": "^[0-9]{4}(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])$",
"description": "Date of transmission of message: YYYYMMDD Format"
},

"time": {
"type": "string",
"required": true,
"maxLength": 4,
"minOccurs": "1",
"pattern": “^([01]?[0-9]|2[0-3]):[0-5][0-9]$”,

"description": "Time of transmission of message"


},
"reportingEvent": {
"type": "string",
"required": true,
"minOccurs": "1",
"description": "Default value: ES",
"maxLength": 4
}
}
},
"IECHE01": {
"type": "object",
"nillable": false,
"minOccurs": "1",
"required": true,
"properties": {
"master": {
"type": "object",
"properties": {
"messageType": {
"type": "string",
"minOccurs": "1",
"maxLength": 1,
"description": "Default value:F ",
"required": true
},

14
"portOfReporting": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 6,
"pattern": "([I][N])([A-Z]|[0-9]){4}$",
"description": "6 digit alphanumeric, starting with IN"
},
"jobNo": {
"type": "string",
"minOccurs": "1",
"maxLength": 7,
"required": true
},
"jobDate": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 8,
"pattern": "^[0-9]{4}(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])$",
"description": "YYYYMMDD"
},
"reportingEvent": {
"type": "string",
"required": true,
"minOccurs": "1",
"description": "Default value: ES",
"maxLength": 4
},
"CIMNumber": {
"type": "string",
"minOccurs": "0",
"maxLength": "15",
"required": false
},
"CIMDate": {
"type": "string",
"minOccurs": "0",
"maxLength": 8,
"required": false
},

"reportingPartyType": {
"type": "string",
"minOccurs": "1",
"maxLength": 7,
"description": "Default value: EXP ",
"required": true

15
},
"reportingPartyCode": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 15,
"pattern": "^[a-zA-Z0-9]{10}$",
"description": "IEC Code - 10 digit alphanumeric"
},
"referenceMovementType": {
"type": "string",
"minOccurs": "1",
"maxLength": 2,
"enum": ["EW"],
"pattern": "^[0-9]{12}$",
"description": "EWAY Bill Flag",

"required": true
},
"referenceMovementNumber": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 35,
"description": "EWAY Bill Number -12 digit numeric, if EW"
},
"referenceMovementDate": {
"type": "string",
"pattern": "^[0-9]{4}(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])$",
"required": true,
"minOccurs": "1",
"maxLength": 8,
"description": "YYYYMMDD"
},
"bondNumber": {
"type": "string",
"minOccurs": "0",
"maxLength": 10,
"nillable": "true",
"required": false
},
"reportingLocationCode": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 15,
"pattern": "^([a-zA-Z ]|[0-9]){10}([0-9]{3})$",

16
"description": "IEC Branch Code -10 digit alphanumeric followed by
3 digit numeric"
},
"reportingLocationName": {
"type": "string",
"minOccurs": "1",
"maxLength": 35,
"description": "Branch Location",
"required": true
},
"nextDestinationOfUnlading": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 10,
"pattern": "([I][N])([A-Z]|[0-9]){8}$",
"description": "Destination Custodian Code 10 digit alphanumeric,
starting with IN"
},
"transportMeansType": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 1,
"pattern": "^[a-zA-Z0-9]{1}$",
"description": "2 = Rail, 3=Truck"
},
"transportMeansNumber": {
"type": "string",
"minOccurs": "1",
"maxLength": 12,
"Description" :"Truck or Trailer number | Rail number",
"required": true
},
"transportMeanseIDType": {
"type": "string",
"minOccurs": "0",
"maxLength": 4,
"nillable": "true",
"description":"Default Value: FT",
"required": false
},
"transportMeanseID": {
"type": "string",
"minOccurs": "0",
"maxLength": 16,
"nillable": "true",
"description" :"RFID Tag number of vehicle",

17
"required": false
},
"expectedTimeOfDeparture": {
"type": "string",
"minOccurs": "0",
"required": false
},
"actualTimeOfDeparture": {
"type": "string",
"required":true,
"minOccurs": "1",
"nillable": "false",
"pattern": "^[0-9]{4}(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])[T]([0-
1][0-9]|[2][0-3]):([0-5][0-9])$",
"description": "Actual Time of Departure YYYYMMDDTHH:MM"
},
"expectedTimeOfArrival": {
"type": "string",
"required": true,
"minOccurs": "1",
"pattern": "^([0-9]{4})-([0-1][0-9])-([0-3][0-9])[T]([0-1][0-9]|[2][0-
3]):([0-5][0-9])$",
"description": "pattern"
},
"actualTimeOfArrival": {
"type": "string",
"minOccurs": "0",
"nillable": "true",
"required": false
},
"authorisedPersonPAN": {
"type": "string",
"minOccurs": "1",
"maxLength": 10,
"required": true
},
"cargoContainer": {
"type": "array",
"nillable": "false",
"maxOccurs": "unbounded",
"required": true,
"items": {
"properties": {
"equipmentSequenceNo": {
"type": "string",
"minOccurs": "1",
"maxLength": 5,
"required": true

18
},
"containerID": {
"type": "string",
"minOccurs": "1",
"maxLength": 11,
"required": true
},
"equipmentType": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 3,
"pattern": "^[C]$|^[B]$|^[W]$",
"description": "C Or B Or W"
},
"equipmentSize": {
"type": "string",
"required": true,
"minOccurs": "0",
"maxLength": 4,
"pattern": "^[a-zA-Z0-9]{4}$",
"nillable": "true",
"description": "4 digit alphanumeric"
},
"equipmentLoadStatus": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 3,
"pattern": "^[A-Z]{3}$",
"description": "FCL, LCL, EMP"
},
"additionalEquipmentHold": {
"type": "string",
"minOccurs": "1",
"maxLength": 256,
"nillable": "true",
"description" :"Wagon number incase of Rail",
"required": true
},
"finalDestinationLocation": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 10,
"pattern": "([I][N])([A-Z]|[0-9]){8}$",
"description": "10 digit alphanumeric,
starting with IN"

19
},
"eventDate": {
"type": "string",
"minOccurs": "1",
"nillable": "false",
"Description" :"Sealing Date",
"pattern": "^([0-9]{4})-([0-1][0-9])-([0-3][0-
9])[T]([0-1][0-9]|[2][0-3]):([0-5][0-9])$", "required":
false
},
"equipmentSealType": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 5,
"pattern": "^[A-Z]{5}$",
"description": "ESEAL, BTSL"
},
"equipmentSealNumber": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 15,
"pattern": "^[a-zA-Z0-9]{15}$",
"description": "alphanumeric"
},
"otherEquipmentID": {
"type": "string",
"minOccurs": "0",
"maxLength": 256,
"nillable": "true",
"required": false
},
"equipmentStatus": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 3,
"pattern": "[0-9]{3}",
"description": "value= 127 "
},
"cargoDetails": {
"type": "array",
"nillable": "false",
"maxOccurs": "unbounded",
"required": true,
"items": {
"properties": {

20
"cargoSequenceNo": {
"type": "string",
"minOccurs": "1",
"maxLength": 4,
"nillable": "false",
"required": true
},
"documentType": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 4,
"pattern":
"^[S][B]$",
"description": "SB"
},
"documentSite": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 6,
"pattern":
"([I][N])([A-Z]|[0-9]){4}$",
"description": "6
digit alphanumeric, starting with IN"
},
"documentNumber": {
"type": "string",
"minOccurs": "1",
"maxLength": 7,
"required": true
},
"documentDate": {
"type": "string",
"required": true,
"pattern": "^[0-
3]?[0-9].[0-3]?[0-9].(?:[0-9]{2})?[0-9]{2}$",
"description":
"pattern"
},
"shipmentLoadStatus": {
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 3,
"pattern":
"^[P]$|^[F]$",

21
"description":
"Value = P or F"
},
"packageType": {
"type": "string",
"required": false,
"minOccurs": "0",
"maxLength": 2,
"nillable": "true",
"pattern":
"^[P]$|^[L][B]$|^[D][B]$",
"description":
"Value = P OR LB OR DB"
},
"quantity": {
"type": "string",
"minOccurs": "1",
"maxLength": 16,
"required": false
},
"packetsFrom": {
"type": "string",
"minOccurs": "0",
"maxLength": 6,
"nillable": "true",
"required": false
},
"packetsTo": {
"type": "string",
"minOccurs": "0",
"maxLength": 6,
"nillable": "true",
"required": false
},
"packUQC": {
"type": "string",
"minOccurs": "1",
"maxLength": 3,
"required": true
}
}
}
}
}
}
}
}
},

22
"supportingDocuments": {
"type": "array",
"nillable": "true",
"maxOccurs": "unbounded",
"required": false,
"items": {
"properties": {

"equipmentSerialNumber": {
"type": "string",
"minOccurs": "1",
"maxLength": 5,
"required": true
},
"cargoSerialNumber": {
"type": "string",
"minOccurs": "1",
"maxLength": 4,
"required": true
},
"documentSerialNumber": {
"type": "string",
"minOccurs": "1",
"maxLength": 4,
"required": true
},
"ICEGATEUserID": {
"type": "string",
"minOccurs": "1",
"maxLength": 15,
"nillable": "false",
"required": true
},
"IRNNumber": {
"type": "string",
"minOccurs": "0",
"maxLength": 14,
"nillable": "false",
"required": true
},
"documentReferenceNumber": {
"type": "string",
"minOccurs": "0",
"maxLength": 17,
"nillable": "false",
"required": true
},
"documentTypeCode": {

23
"type": "string",
"minOccurs": "0",
"maxLength": 6,
"nillable": "false",
"required": true
},
"beneficiaryCode": {
"type": "string",
"minOccurs": "0",
"maxLength": 35,
"nillable": "false",
"required": true
}
}
}
}}
},
"digSign": {
"type": "object",
"required": true,
"properties": {
"startSignature": {
"type": "string",
"required": true,
"minOccurs": "1",
"description": "start Signature"
},
"startCertificate": {
"type": "string",
"required": true,
"minOccurs": "1",
"description": "start Certificate"
},
"signerVersion": {
"type": "string",
"required": true,
"minOccurs": "1",
"description": "Signer Version"
}
}
}
}

24
B.2. IECHE01-ES - (ESeal Departure Notification) – Sample Json

{
"headerField":{
"senderID":"ICEGAT1",
"receiverID":"INWFD6",
"versionNo":"1.0",
"indicator":"T",
"messageID":"IECHE01",
"sequenceOrControlNumber":4568,
"date":"20190227",
"time":"12:45",
"reportingEvent":"ES"
},
"IECHE01":{
"master":{
"messageType":"F",
"portOfReporting":"INWFD6",
"jobNo":"789",
"jobDate":"20190201",
"reportingEvent":"ES",
"CIMNumber":"123567",
"CIMDate":"20190227",
"reportingPartyType":"EXP",
"reportingPartyCode":"0595032818",
"referenceMovementType":"EW",
"referenceMovementNumber":"452833325145",
"referenceMovementDate":"20170227",
"bondNumber":"9517475884",
"reportingLocationCode":"IINBOM1CCU1",
"reportingLocationName":"NEWDELHI",
"nextDestinationOfUnlading":"INBOM1",
"transportMeansType":"2",
"transportMeansNumber":"MH02RT5059T",
"transportMeanseIDType":"FT",
"transportMeanseID":"T5U3",
"expectedTimeOfDeparture":"20190227T10:45",
"actualTimeOfDeparture":"20190227T11:03",
"expectedTimeOfArrival":"20190227T12:30",
"actualTimeOfArrival":"20190227T01:05",
"authorisedPersonPAN":"DBCPS2230G",
"cargoContainer":[{
"equipmentSequenceNo":1,
"containerID":"4324KJBN334",
"equipmentType":"C",
"equipmentSize":"A234",
"equipmentLoadStatus":"FCL",
"additionalEquipmentHold":"1",
"finalDestinationLocation":"INBOM1",

25
"eventDate":"20190227",
"equipmentSealType":"ESEAL",
"equipmentSealNumber":"IBTR31112349",
"otherEquipmentID":"1",
"equipmentStatus":"127",
"cargoDetails":
[
{
"cargoSequenceNo":1,
"documentType":"SB",
"documentSite":"INTKD6",
"documentNumber":1002606,
"documentDate":"20190103",
"shipmentLoadStatus":"P",
"packageType":"P",
"quantity":200,
"packetsFrom":1,
"packetsTo":10,
"packUQC":"CTN"
}
]
},
{
"equipmentSequenceNo":3,
"containerID":"TLHU123456",
"equipmentType":"C",
"equipmentSize":"A234",
"equipmentLoadStatus":"FCL",
"additionalEquipmentHold":"127",
"finalDestinationLocation":"INMAA12345",
"eventDate":"20170517",
"equipmentSealType":"ESEAL",
"equipmentSealNumber":"12345",
"otherEquipmentID":"12345",
"equipmentStatus":"127",
"cargoDetails":
[
{
"cargoSequenceNo":21,
"documentType":"SB",
"documentSite":"INWFD6",
"documentNumber":9419409,
"documentDate":"20170517",
"shipmentLoadStatus":"P",
"packageType":"P",
"quantity":1200,
"packetsFrom":1,
"packetsTo":10,
"packUQC":"KGS"
}

26
]
}
]
},
"supportingDocuments":
[{
"equipmentSerialNumber":1,
"cargoSerialNumber":1,
"documentSerialNumber":1,
"ICEGATEUserID":"ICEGAT1",
"IRNNumber":"201901010001",
"documentReferenceNumber":1002606,
"documentTypeCode":"SB",
"beneficiaryCode":"ABCD1234N"
},
{
"equipmentSerialNumber":3,
"cargoSerialNumber":21,
"documentSerialNumber":1,
"ICEGATEUserID":"ICEGAT1",
"IRNNumber":"200134566",
"documentReferenceNumber":9419409,
"documentTypeCode":"SB",
"beneficiaryCode":"ABCD1234Y"
}]
}
}

27
B.3 CHIEE01A-ES ( Eseal Departure Notification Ack. )– Json Schema

{
"CHIEE01A" :
{
"type": "object",
"nillable": "true",
"minOccurs": "1",
"required": true,
"properties":
{
"master" :
{
"type": "object",
"properties":
{
"messageType":
{
"type": "string",
"minOccurs": "1",
"maxLength": 1,
"description": "Default value:F ",
"required": true
},
"portOfReporting":
{
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 6,
"pattern": "([I][N]|[i][n])([A-Z]|[0-9]){4}$",
"description": "6 digit alphanumeric, starting with IN"
},
"jobNo":
{
"type": "string",
"minOccurs": "1",
"maxLength": 7,
"required": true
},
"jobDate":
{
"type": "string",

28
"required": true,
"minOccurs": "1",
"maxLength": 8,
"pattern": "^[0-9]{4}(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])$",
"description": "YYYYMMDD"
},
"reportingEvent":
{
"type": "string",
"required": true,
"minOccurs": "1",
"description": "Default value: EDN",
"maxLength": 4
},
"CIMNumber":
{
"type": "string",
"minOccurs": "0",
"maxLength": "12",
"required": false
},
"CIMDate":
{
"type": "string",
"minOccurs": "0",
"maxLength": 8,
"required": false
},
"masterErrorCode" :
{
"type": "array",
"nillable": "true",
"maxOccurs": "unbounded",
"minOccurs":1,
"required": false,
"items":
{
"properties":
{
"pathName" :
{
"type": "string",
"minOccurs": "0",
"maxLength": 100,
"required": false
},
"errorCode" :
{

29
"type": "string",
"minOccurs": "0",
"maxLength": 5,
"required": false
},
"errorMessage" :
{
"type": "string",
"minOccurs": "0",
"maxLength": 100,
"required": false
}
}
}
},
"cargoContainer":
{
"type": "array",
"nillable": "false",
"maxOccurs": "unbounded",
"required": true,
"items":
{
"properties":
{
"equipmentSequenceNo":
{
"type": "string",
"minOccurs": "1",
"maxLength": 5,
"required": true
},
"containerID":
{
"type": "string",
"minOccurs": "1",
"maxLength": 11,
"required": true
},
"equipmentType":
{
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 3,
"pattern": "^[C]$|^[B]$|^[W]$",
"description": "C Or B Or W"
},

30
"cargoContainerErrorCode" :
{
"type": "array",
"nillable": "true",
"maxOccurs": "unbounded",
"minOccurs":1,
"required": false,
"items":
{
"properties":
{
"pathName" :
{
"type": "string",
"minOccurs": "0",
"maxLength": 100,
"required": false
},
"errorCode" :
{
"type": "string",
"minOccurs": "0",
"maxLength": 5,
"required": false
},
"errorMessage" :
{
"type": "string",
"minOccurs": "0",
"maxLength": 100,
"required": false
}
}
}
},
"cargoDetails":
{
"type": "array",
"nillable": "false",
"maxOccurs": "unbounded",
"required": true,
"items":
{
"properties":
{
"cargoSequenceNo":
{
"type": "string",

31
"minOccurs": "0",
"maxLength": 4,
"nillable": "true",
"required": false
},
"documentType":
{
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 4,
"pattern": "^[S][B]$",
"description": "SB"
},
"documentSite":
{
"type": "string",
"required": true,
"minOccurs": "1",
"maxLength": 6,
"pattern": "([I][N]|[i][n])([a-zA-Z]|[0-9]){4}$",
"description": "6 digit alphanumeric, starting with IN"
},
"documentNumber":
{
"type": "string",
"minOccurs": "1",
"maxLength": 12,
"required": true
},
"documentDate":
{
"type": "string",
"required": true,
"pattern": "^[0-3]?[0-9].[0-3]?[0-9].(?:[0-9]{2})?[0-9]{2}$",
"description": "pattern"
},
"cargoDetailsErrorCode" :
{
"type": "array",
"nillable": "true",
"maxOccurs": "unbounded",
"minOccurs":1,
"required": false,
"items":
{
"properties":
{

32
"pathName" :
{
"type": "string",
"minOccurs": "0",
"maxLength": 100,
"required": false
},
"errorCode" :
{
"type": "string",
"minOccurs": "0",
"maxLength": 5,
"required": false
},
"errorMessage" :
{
"type": "string",
"minOccurs": "0",
"maxLength": 100,
"required": false
}

}
}
}
}

}
}

}
}
}
}
},
"supportingDocuments":
{
"type": "array",
"nillable": "true",
"maxOccurs": "unbounded",
"minOccurs":1,
"required": true,
"items":
{
"properties":
{
"equipmentSerialNumber":

33
{
"type": "string",
"minOccurs": "1",
"maxLength": 5,
"required": true
},
"cargoSerialNumber":
{
"type": "string",
"minOccurs": "1",
"maxLength": 4,
"required": true
},
"documentSerialNumber":
{
"type": "string",
"minOccurs": "1",
"maxLength": 4,
"required": true
},
"supportingDocumentsErrorCode" :
{
"type": "array",
"nillable": "true",
"maxOccurs": "unbounded",
"minOccurs":1,
"required": false,
"items":
{
"properties":
{
"pathName" :
{
"type": "string",
"minOccurs": "0",
"maxLength": 100,
"required": false
},
"errorCode" :
{
"type": "string",
"minOccurs": "0",
"maxLength": 5,
"required": false
},
"errorMessage" :
{
"type": "string",

34
"minOccurs": "0",
"maxLength": 100,
"required": false
}
}
}}
}

}}
}},
"digSign": {
"type": "object",
"required": true,
"properties": {
"startSignature": {
"type": "string",
"required": true,
"minOccurs": "1",
"description": "start Signature"
},
"startCertificate": {
"type": "string",
"required": true,
"minOccurs": "1",
"description": "start Certificate"
},
"signerVersion": {
"type": "string",
"required": true,
"minOccurs": "1",
"description": "Signer Version"
}
}
}
}

35
B.4 CHIEE01A – ES ( Eseal Departure Notification Ack.)- Sample Json

{
"CHIEE01A" : {
"master" : {
"messageType" : "F",
"portOfReporting" : "INWFD6",
"jobNo" : "34565",
"jobDate" : "2017-05-09",
"reportingEvent" : "CSM",
"CIMNumber" : "123",
"CIMDate" : "2017-05-09",
"cargoContainer" : [ {
"containerID" : "TLHU123456",
"equipmentType" : "C",
"cargoDetails" : [ {
"cargoSequenceNo" : "1234",
"documentType" : "SB",
"documentSite" : "INWFD6",
"documentNumber" : "9419409",
"documentDate" : "2017-05-09"
} ],
"EquipmentSequenceNo" : "12345"
}]
},
"supportingDocuments" : [ {
"equipmentSerialNumber" : "12345",
"cargoSerialNumber" : "1234",
"documentSerialNumber" : "1234"
}]
}
}

36
Annexure C – List of Values :
Object Name Description Code
Message Type Fresh F
Amendment A
Indicator Production P
Test T
Reporting Event Eseal Departure ES
Export Departure ED

Package Type Packaged P


Liquid Bulk LB
Dry Bulk DB

Load Status Partial P


Full F

EquipSealTYPE E-Seal ESEAL


Bottle Seal BTSL
Other Seal OTH

Equipment Load Status Full Container Load FCL


Less Container Load LCL
Empty EMP

Equipment Type Container C


Bonded Truck B
Wagon W

Trans Mode Rail 2


Road 3

37
Annexure D – Error Codes:
D.1 Error Codes – Structural Validations :

S.No Error Code Error Code Description


1 RS001 Error in case of resubmission of same job number in a day
2 DT-012 [ISC.0082.9469] Value does not match pattern(s)
3 DT-005 [ISC.0082.9465] Value is longer than maximum length
4 NV-009 [ISC.0082.9009] Child element equipmentSerialNumber {} at position
0 is unexpected
5 NV-003 [ISC.0082.9003] Unable to locate a matching element declaration

D.2 Error Code – Data Validations:


S.No Error Code Error Code Description
1 00 Success
2 01 Duplicate Records
3 02 Incorrect Party Type
4 03 Invalid Mesg Type
5 04 Invalid Reporting Event
6 05 Invalid Port of Reporting
7 06 Mandatory Field Contains Null Value
8 07 Incorrect Party Code
9 08 Incorrect Movement Type
10 09 Incorrect Movement Number Format
11 10 Invalid Location Code/Format
12 11 Invalid Next Destination Code/Format
13 12 Invalid Transport Means
14 13 Invalid Authorised Person PAN
15 14 Invalid Equipment Type
16 15 Invalid Equipment Size
17 16 Container Details Not Available
18 17 Cargo Details Not Available
19 18 Invalid Equipment Load Status
20 19 Invalid Final Destination Code/Format
21 20 Invalid Equipment Seal Type
22 21 Invalid Equipment Seal Number
23 22 Invalid Equipment Seal Status
24 23 Incorrect Document Type
25 24 CIM is Already Exists(Entity_Type+PAN) check the unique Parameter

26 25 Only Fresh Message is made online


27 26 Invalid Document Site
28 27 Invalid Shipment Load Status
29 28 Invalid Package Type
30 29 Invalid Document Reference Number

38
31 30 Doc Ref No. Should Indicate Master only
32 31 Doc Ref No. Should Indicate Container only
33 32 Doc Ref No. Should Indicate Cargo only
34 33 Invalid Authorised Party Code
35 34 Invalid Transport Mode
36 35 Invalid Document Type
37 36 No Container Details Exists for the Cargo
38 37 Equipment Details Already Entered
39 38 Authorised Person Not Registered
40 39 RMD Check Failed

39

You might also like