Transhipper

MessageImplementation Guide

Sea Cargo Manifest & Transshipment

Regulations, 2018

Directorate General of Systems

and Data Management
Volume-1.3

Leveraging Technology2 For Serving Taxpayers

1
Contents
1. Introduction:........................................................................................................................................5
1.1 Background:.................................................................................................................................5
1.2 Scope:..........................................................................................................................................5
1.3 Stakeholders involved:.................................................................................................................6
2. Message Guidelines:............................................................................................................................6
2.1 Introduction.................................................................................................................................6
2.2 Submission of the File – ICEGATE:...............................................................................................6
2.3 Acknowledgement of the Declaration:........................................................................................7
2.3.1 Structural Validation............................................................................................................7
2.3.1.1 Structural Validation File naming format:........................................................................7
2.3.1.2 Vocabulary for errors on Structural Validation failure:....................................................7
2.3.1.3 Sample SFL Outbound Files:.............................................................................................8
2.3.2 Business Validation Acknowledgement:..............................................................................9
2.3.2.1 Business Validation Acknowledgement File Format :.......................................................9
2.3.2.2 Sample ACK Files and Schema :........................................................................................9
3. Process Flow:.....................................................................................................................................10
4. Manifest Master Object.....................................................................................................................11
4.1 JSON Objects: Arrival & Departure of Goods.............................................................................11
4.2 JSON Objects: Allowed for Shipment Request...........................................................................11
4.3 Structure – Hierarchy: Arrival & Departure of Goods................................................................12
4.4 Structure – Hierarchy: Allowed for Shipment Request..............................................................12
4.5 Attribute Table – Common structure.........................................................................................13
4.5.1 Manifest Master: Declaration...........................................................................................13
4.5.2 Manifest Master: CIM.......................................................................................................15
4.5.3 Manifest Master: Location................................................................................................16
4.5.4 Manifest Master: Transport Means..................................................................................19
4.5.5 Manifest Master: Events...................................................................................................20
4.5.6 Manifest Master: Cargo Container....................................................................................22
4.5.7 Manifest Master: Cargo Details.........................................................................................26
4.5.8 Manifest Master: Cargo Itinerary......................................................................................30
4.5.9 Manifest Master: Supporting Document..........................................................................31

2
 4.5.10 Manifest Master: DigiSign.................................................................................................33
5. JSON Schema’s and Sample’s............................................................................................................34
5.1 Inbound JSON Schema...............................................................................................................34
5.2 Inbound JSON Samples..............................................................................................................34
5.3 Outbound SFL JSON Schema......................................................................................................34
5.4 Outbound SFL JSON Samples.....................................................................................................34
5.5 Outbound ACK JSON Schema.....................................................................................................34
5.6 Outbound ACK JSON Samples....................................................................................................34
6. Object Attribute Table.......................................................................................................................35
6.1 Inland Arrival & Departure of Goods.........................................................................................35
6.2 Allowed for Shipment Request (ASR).........................................................................................37
7. List of Values:.....................................................................................................................................40
8. Key Fields for Outbound ACK File:.....................................................................................................42
9. Error Code List:..................................................................................................................................45

3
Revision History

Version Date Author Approved By Owner Comments

Transhipper 22/08/19 Chetna Ananth R ICES

Message Jain
Implementatio
n Guide V.1
Transhipper 19/09/19 Chetna Ananth R ICES Added reporting event ASR
Message Jain object & structure hierarchy,
Implementatio object-attribute table
n Guide V.1.1 including Cargo-Itinerary,
JSON Schema & Sample
Transhipper 25/09/19 Chetna Ananth R ICES JSON Schema’s & Sample files
Message Jain for reporting events: AR, DP,
Implementatio ASR
n Guide V.1.2
Transhipper 04/12/19 Chetna Ananth R ICES
Message Jain
Implementatio
n Guide V.1.3

Transhipper 07/01/19 Chetna Ananth R ICES Updated for indication for list
Message Jain of values, camel-case for each
Implementatio attribute of the table and
Schema modification, Key
n Guide V.1.4
Fields for Outbound file table,
Error Code List, revised_JSONs
Schema and Sample, revised
section 2, 5 and 8.
Transhipper 22/02/20 Rishi, Anuj Gogia ICES Updated field lengths
Message 24 Anil
Implementatio
n Guide V.1.5

4
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 Transshipment 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.

As per the new regulations, the Authorized Sea Carrier (ASC)/Authorized Sea Agent (ASA) shall
submit an Arrival Manifest electronically, prior to departure from the last port of call to the Indian
Port of call. And submit a Departure Manifest electronically before departure from the Indian Port
of call.

The submission of Arrival and Departure Manifest shall have to be complied with by the ASC/ASA
before departure from the last port/customs station of call to every Indian customs station and
Departure then on respectively.

In addition, the responsibility is also entrusted with various stakeholders authorized under Handling
of Cargo in Customs Inland Station. In case of Export, Stuffing or Stripping report generated after
filing Shipping Bill by custodian at Export Departure and in case of Import, Stuffing or Stripping
report generated by custodian at Import Departure.

1.2 Scope:
The Scope of this document is to provide list of messages involved in this carrying out above stated
responsibility by Terminal operators and provide format, sample for such communication. The brief
of messages are as follows:

• CIM-DP: Export Departure (Departure Message for Goods)

• CIM-AR: Goods Arrival (Arrival Message for Goods)

 CIM-ASR: Allowed for Shipment Request

5
 1.3 Stakeholders involved:
Following Stakeholders are involved in the implementation

1. Authorized Sea Carrier (Including Shipping line)

2. Inland Custom Station Operators
3. Terminal Operator
4. Custom Officers
5. Transhipper Custodian
6. Authorized Persons of all the above

2. Message Guidelines:
2.1 Introduction
This message guideline would help the users to prepare the declaration in the required format. The
users can either utilize the data already available in the internal systems to generate this declaration
in the required format by modifying their internal software systems or use of an Java utility provided
by CBIC/NIC in this regard (Link: http://ices.nic.in/ices/cim).

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 - 4.3 & Section - 4.4 of this
document.
b) The attributes of the JSON objects for different messages is provided in Section-6
c) The Schema and Sample Json formats are available in Section-5
d) Certain data elements are coded for bringing uniformity in the processing. The List of values for
those data elements are given in Section-7.
e) The file submitted to the ICEGATE should be in following name format. For e.g

F_TRCHE01_AR_ICEGATEID_6011_20200116_DEC.json

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

The Declaration should be digitally signed as per the required format.

2.2 Submission of the File – ICEGATE:

The Declaration is to be submitted to Customs by User to ICEGATE either through:

- Web Upload or
- MFTP

The Declaration should be digitally signed as per the required format. (For more details, refer
the following link: https://www.icegate.gov.in/digitalSign/digitalSign.html)

6
2.3 Acknowledgement of the Declaration:

Any file sent to Icegate through proper channel would be responded through acknowledged
mail with the response codes regarding acceptance or rejection of the declaration. If the file,
sent by the user is non readable, a mail to that extent would be reverted back.
The List of Error Codes are available in Section -9 and key fields for Outbound File has described
in Section – 8 of this document.

The Inbound message from the user undergoes two level of validations:

1. Structural Validation
2. Data and Business Logic Validation

2.3.1 Structural Validation

It is the 1st level validation which matches the schema of the inbound file with its objects and
attributes with the prescribed structure of that message. In case of a mismatch, a structural
validation failure (SFL) acknowledgment would be sent as a response to the User.

2.3.1.1 Structural Validation File naming format:

The file sent by the ICEGATE should be in following name format. For e.g

F_TRCHE01_AR_ICEGATEID_6011_20200116_SFL.json

(<messageType><msgID><reportingEvent><SenderID><jobID><date>_structural validation)

2.3.1.2 Vocabulary for errors on Structural Validation failure:

The most common errors found during structural validation and the Keywords in the SFL
Outbound File are as follows :
 Data Type Mismatch (“maxLength “)
 Numeric Minimum Field Length Mismatch (“minLength”)
 String Maximum Field Length Mismatch (“required”)
 Object/Array Discrepancy Mismatch (“type”)
 Pattern Mismatch (“pattern”)
 Missing required Property/Object (“required”)

7
 For additional details, following links may be referred. (Vocabulary for Structural validation
is in section 6 of Link 1 )

1. https://json-schema.org/draft/2019-09/json-schema-validation.html
2. https://json-schema.org/specification.html
3. https://json-schema.org/draft-06/json-schema-release-notes.html

It is the 1st level validation which arises when submitted file fails at Icegate end due to the error
in matching the file against the structural schema validation.

2.3.1.3 Sample SFL Outbound Files:

Examples of the SFL outbound file have been given below:

SFL Example:

Sample A: (Schema Validation Failure)

NAK Response
{
"headerField": {
"senderID": "ICEGATEID",
"receiverID": "INNSA1",
"versionNo": "1102",
"indicator": "T",
"messageID": "TRCHE01",
"sequenceOrControlNumber": 7031,
"date": "20200110",
"time": "T14:50",
"reportingEvent": "AR"
},
"errorDetails":{
"status": "Schema validation failure",
"errorCode": "ERR100",
"errorMessage":[{
"level": "error",
"schema": {
"loadingURI": "#",
"pointer": "/properties/master/properties/ transportMeans "
},
"instance": {
"pointer": "/master/ "
},
"domain": "validation",
"keyword": "maxLength",
"message": "string \"Cffkdsahlfk\" is too long (length: 11, maximum allowed: 4)",

8
 "value": "Cffkdsahlfk",
"found": 11,
"maxLength": 4
}]
}
}

Additional sample JSON files have been given under Section – 5.4 of this document

The inbound file would undergo Second level business validation will only after successful
structural validation.

2.3.2 Business Validation Acknowledgement:

Once the file has been validated for its structural correctness, the Customs Systems would
validate the data with its inbuilt directories and data tables. The list of Error Codes given in
Section -9 of can serve as an indication on the kind of data validations the inbound files would
undergo. (Latest list of error codes can be accessed from Customs Duty Calculator page
accessible through ICEGATE Website). On Successful integration of the submitted JSON file with
the Customs System, a positive ACK will be sent to the submitter with CSN No., Date and/or
MCIN/PCIN number. In case of error, a negative ACK file with error code and error description
will be sent.

2.3.2.1 Business Validation Acknowledgement File Format :

The file sent by the ICEGATE should be in following name format. For e.g

F_TRCHE01_AR_ICEGATEID_7031_20200110_ACK.json

(<messageType><msgID><reportingEvent><SenderID><jobID><date>_Final Acknowledgment)

2.3.2.2 Sample ACK Files and Schema :

Sample ACK files and schema have been attached under Section – 5.5 and Section – 5.6 for the
benefit of the stakeholders.

9
3. Process Flow:

10
4. Manifest Master Object

4.1 JSON Objects: Arrival & Departure of Goods

1. Manifest Declaration
2. Master CIM
3. Master Location
4. Master TM
5. Master Events
6. Cargo Container
7. Cargo Document
8. Supporting Document
9. Digital Signature

4.2 JSON Objects: Allowed for Shipment Request

10. Manifest Declaration
11. Master CIM
12. Master Location
13. Master TM
14. Master Events
15. Cargo Document
16. Cargo Container
17. Cargo Itinerary
18. Supporting Document
19. Digital Signature

11
4.3 Structure – Hierarchy: Arrival & Departure of Goods

4.4 Structure – Hierarchy: Allowed for Shipment Request

12
 4.5 Attribute Table – Common structure
4.5.1 Manifest Master: Declaration

Object Attribute Data Type Remarks Pattern

Name &
Descrip
tion
Declaration Message CHAR (1) The Flag Desc:
Type specifying Default
Required- (message the action Value –
true Type) requested F
1..1 on this
transmission

LOV:
F - Fresh
A-
Amendment
Port of VARCHAR2 The Custom Pattern:
Reporting (6) Location of ([I][N])
(portOfR Reporting ([A-Z]|
eporting) [0-9])
{4}$

Desc: 6
digit
alphanu
meric
Job No. NUMBER The Unique
(jobNo) (7) ID provided
by User for
this
transmission
Job Date DATE Date of Pattern:
generation ^[0-9]{4}
(jobDate) of unique id (0[1-9]|
provided by 1[0-2])
user for this (0[1-9]|
transmission [1-2][0-
9]|3[0-
1])$

13
Object Attribute Data Type Remarks Pattern
Name &
Descrip
tion

Desc:
YYYYMM
DD
Reporting CHAR (4) The Code Desc:
Event specifying Default
(reportin the Value –
gEvent) Reporting IA, EA,
Event AT, DT
pertaining to
this
transmission

LOV:
AR - Arrival
()Inland
Arrival)
DP -
Departure
(Inland
Departure)
ASR -
Allowed for
Shipment
Request

14
 4.5.2 Manifest Master: CIM

Object Attribut Data Type Remarks Pattern

e Name &
Descrip
tion
CIM CIM No. NUMBER The unique id
(CIMNu (12) generated by
Required- mber) Custom for
true this
1…1 compliance
CIM DATE The date
Date unique id
(CIMDa generated by
te) Custom for
this
compliance

15
 4.5.3 Manifest Master: Location

Object Attribute Data Type Remarks Pattern

Name &
descripti
on
Location Reporting CHAR (7) Exporter, Desc:
Party Type Custodian, Default
Required- (reportingP Terminal value –
True artyType) Operators ATO,
1..1 ATP,
LOV: ACU
Exp -
Exporter
C -
Custodian
T - Terminal
Operators
Reporting VARCHAR2 Custom Pattern:
party Code (15) Identification ^[a-zA-
(reportingP No. Z0-9]
artyCode) (Custodian {10}$
Code)
Desc: 03
digit
alphanu
meric,
like –
CON,
AND

Reference VARCHAR e-waybill / Pattern:

Movement (2) other ^[0-9]
Type movement {12}$
(reference
Movement Desc:
Type) EWAY
Bill Flag

Reference VARCHAR2 e-waybill no. Desc:

Movement (35) / Movement EWAY
No. Bill

16
Object Attribute Data Type Remarks Pattern
Name &
descripti
on
(reference No. Number
Movement -12 digit
Number) numeric,
if EW

Reference DATE e-waybill Pattern:

Movement date / ^[0-9]{4}
Date Movement (0[1-9]|
(reference date 1[0-2])
Movement (0[1-9]|
Date) [1-2][0-
9]|3[0-
1])$

Desc:
YYYYMM
DD

Bond No. VARCHAR2 Bond

(bondNum (10) Number
ber)
Reporting VARCHAR2 Reporting Pattern:
Location (15) Location ^([I][N])
Code Code: ([a-zA-
(reportingL Z0-9])
ocationCod Mention IEC {8}$
e) + Branch
Code of Desc: 10
registered digit
premise alphanu
where meric
esealing took starting
place with IN

Reporting VARCHAR2 Where Desc:

Location (35) stuffing took Branch
Name place Location

Next VARCHAR2 Custodian Pattern:

17
Object Attribute Data Type Remarks Pattern
Name &
descripti
on
Destination (10) Code of next ([I][N])
of Unlading site ([A-Z]|
(nextDestin [0-9])
ationOfUnl {8}$
ading)
Desc:
Destinati
on
Custodia
n Code
10 digit
alphanu
meric

Authorized VARCHAR2 PAN No. of

Person (10) Authorized
PAN Person
(authorised
PersonPAN
)

18
 4.5.4 Manifest Master: Transport Means

Object Attribute Data Type Remarks Pattern

Name &
Descrip
tion
Transpor Transport CHAR (1) means of Pattern
t Means Means Type transport. : ^[a-
(transportM zA-Z0-
Required eansType) LOV: 9]{1}$
– True 1.- Sea,
1…1 2 - Rail,
3 - Truck
4 - Air
Transport VARCHAR2 Identification Desc:
Means No. (12) No. of train / Truck
(transportM license plate or
eansNumbe no. of truck Trailer
r) numbe
r | Rail
numbe
r

Transport VARCHAR2 Fastag or any Desc:

Means eID (4) other type Default
Type Value –
(transportM FT
eanseIDTyp
e)
Transport VARCHAR2 Fastag No. Desc:
Means eID (16) RFID
(transportM Tag
eanseID) numbe
r of
vehicle

Total NUMBER Total no. of

Equipment’ (4) transport
s equipment’s
(totalEquip
ments)

19
 4.5.5 Manifest Master: Events

Object Attribute Data Remarks Pattern

Name Type &
Descrip
tion
Events Expected TIMESTA Date and
Time of MP Time of event
Required Departure
– True Actual Time TIMESTA Date and Pattern: ^[0-9]
1…1 of Departure MP Time of event {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])
$

Desc:
Actual
Time of
Departu
re
YYYYM
MDDTH
H:MM

Expected TIMESTA Date and Pattern: ^([0-9]

Time of MP Time of event {4})-([0-1][0-9])-
Arrival ([0-3][0-9])[T]
(expectedTi ([0-1][0-9]|[2]
meOfArriva) [0-
3]):([0-
5][0-9])
$

Desc:
pattern

Actual Time TIMESTA Date and

20
Object Attribute Data Remarks Pattern
Name Type &
Descrip
tion
of Arrival MP Time of event
(actualTime
OfArrival)

21
 4.5.6 Manifest Master: Cargo Container

Object Attribute Data Type Remarks Pattern

Name &
Descrip
tion

Cargo Message CHAR (1) The Flag Desc:

Container Type specifying the Default
(messageT action Value –
Required ype) requested on F
– True this
1…n transmission
F - Fresh
A-
Amendment

Equipment NUMBER The Serial

Sequence (5) number of
No. Equipment
(equipmen referenced in
tSequence the Transport
No) Document.
Starting with
1

Container VARCHAR Identification

ID 2 (11) of container
(containerI or truck no.
D) in case of
bonded truck

Marks
(letters
and/or
numbers)
which
identify
equipment
e.g. unit load
device,

22
Object Attribute Data Type Remarks Pattern
Name &
Descrip
tion

Container

Equipment VARCHAR The Code Pattern:

type 2 (3) specifying the ^[C]$|
(equipmen type of the ^[B]$|
tType) Equipment ^[W]$
used for
Transport Desc: C
Or B Or
LOV: W
C–
Container,
B - Bonded
truck,
W - wagon
Equipment CHAR (4) ISO code of Pattern:
Size container ^[a-zA-
(equipmen type Z0-9]
tSize) {4}$

Desc: 4
digit
alphanu
meric

Equipment CHAR (3) Code pattern:

Load specifying ^[A-Z]
Status how full {3}$
(equipmen piece of
tLoadStatu transport is. Desc:
s) FCL, LCL,
LOV: EMP
FCL - Full
LCL - Partial
EMP -
Empty
Additional VARCHAR Wagon No., Desc:
Equipment 2 (256) Trailer No, Wagon
Hold number

23
Object Attribute Data Type Remarks Pattern
Name &
Descrip
tion

(additional coded incase

Equipment of Rail
Hold) The Identifier
for Additional
Equipment
used for Hold
e.g Tray etc.

Final VARCHAR Port Code of Pattern:

Destination 2 (10) gateway port ([I][N])
Location ([A-Z]|
(finalDestin [0-9])
ationLocati {8}$
on)
Desc:
10 digit
alphanu
meric

Event Date DATE Date of event Pattern: ^([0-9]

(eventDate when cargo is {4})-([0-1][0-9])-
) being ([0-3][0-
transported 9])[T]
([0-1][0-
9]|[2][0-
3]):([0-
5][0-9])$

Desc:
Sealing
Date

Equipment CHAR (5) Eseal / other Pattern:

seal Type type: ^[A-Z]
(equipmen {5}$
tSealType) LOV:
ESEAL – E- Desc:
Seal, ESEAL,
BTSL – Bottle

24
Object Attribute Data Type Remarks Pattern
Name &
Descrip
tion

Seal, BTSL
OTH – Other
Seal
Equipment CHAR (15) No. of Pattern:
Seal No. Equipment "^[a-zA-
(equipmen Seal Z0-9]
tSealNumb {15}$
er)
Desc: a
lphanu
meric

Other VARCHAR RFID tag or

Equipment 2 (256) other
ID Reference
(otherEqui
pmentID)
Equipment CHAR (6) The Status of Pattern:
Status the Transport [0-9]{6}
(crgoMvmt Equipment
) Desc:
Damaged value=
Intact 127
Shaort
landed
Delay etc
Equipment VARCHAR Container
Pkg 2 (2) BULK
(equipmen
tPkg)
Equipment NUMBER No. of
Quantity (16) container/pk
(equipmen g
tQuantity)
Equipment CHAR (3) UQC Code
QUC
(equipmen LOV:
tQUC) PKG -

25
Object Attribute Data Type Remarks Pattern
Name &
Descrip
tion

Package
KGS -
Kilograms
4.5.7 Manifest Master: Cargo Details

Object Attribute Data Type Remarks Pattern &

Name Descripti
on

Cargo Message CHAR (1) The Flag Desc:

Details Type specifying Default
(message the action value – F
Required Type) requested on
– True this
1…n transmission

LOV:
F - Fresh
A-
Amendment

Cargo NUMBER The serial

Sequence (4) No.
No. indicating
(cargoSeq the cargo
uenceNo) items carried
I transport
document

Document VARCHAR2 Identity the Pattern:

Type (10) type of ^[S][B]$
(documen document
tType) Desc: SB,
LOV: BE
PCIN
MCIN
Document VARCHAR2 Indian port Pattern:
Site code where "([I][N])

26
Object Attribute Data Type Remarks Pattern &
Name Descripti
on

(documen (6) document ([A-Z]|[0-

tSite) issued 9]){4}$

Desc: 6
digit
alphanu
meric

Document NUMBER Identification

No. (12) No. of
(documen document
tNo) BE No.
SB No.
MCIN No.
PCIN No.

EBE No – EDI BE No,

ZBE No – SEZ BE No,
MBE No –
Manual BE
No,
ESB No - EDI SB No,
ZSB No - SEZ SB No,
MSB No –
Manual SB
No
Document DATE Date of Pattern: ^[0-
Date document 3]?[0-9].
(documen [0-3]?[0-
9].(?:[0-9]
tDate)
{2})?[0-9]
{2}$

Desc:
Pattern

Shipment CHAR (3) To indicate if Pattern:

Load all cargo ^[P]$|
Status pertaining to ^[F]$
(shipment this SB is in
LoadStatu this Desc:

27
Object Attribute Data Type Remarks Pattern &
Name Descripti
on

s) container (F) Value = P

or if it is or F
loaded in
multiple
containers
(P)

LOV:
F - Full
P - Partial
Package VARCHAR2 LOV: Pattern:
Type (2) P - ^[P]$|
(packageT Packaged, ^[L][B]$|
ype) LB - Liquid ^[D][B]$
Bulk,
DB - Dry Desc:
Bulk Value = P
OR LB OR
DB

Quantity NUMBER No. of

(quantity) (16,6) Packages

Packets NUMBER Starting no.

From (6) of quantity
(packetsFr in the
om) container

Packets NUMBER Ending no of

To (6) quantity in
(packetsT the
o) container

Pack UQC CHAR (3) UQC of

(packUQC quantity
)
PKG -
package
KGS -
kilograms

28
Object Attribute Data Type Remarks Pattern &
Name Descripti
on

MCIN / VARCHAR2 No. of

PCIN (20) MCIN / PCIN
(MCIN/PCI where
N) applicable

29
 4.5.8 Manifest Master: Cargo Itinerary

Object Attribute Data Type Remarks Pattern &

Name Descripti
on

Cargo Port of call NUMBER The Serial

Itinerary sequence (3) number
number Indicating the
Required (prtOfCall sequence of
– True SeqNmbr the port of
1…n ) call by the
referenced
cargo.
Port of VARCHAR2 The Code indicating
Call, (10) the
Coded Place/Port of
(prtOfCall call, Coded.
Cdd)
Port of Call VARCHAR2 The Code
Name (256) indicating the
(prtOfCall place/Port of
Name) call, Text
Next port VARCHAR2 The
of call, (10) Registered
Coded Coded of
(nxtPrtOf Next Port of
CallCdd) Call, Coded

Next port VARCHAR2 The

of call (256) Registered
name Coded of
(nxtPrtOf Next Port of
CallName Call, Text
)
Mode of CHAR (1) Mode of
Transport Transport
(modeOfT used for
rnsprt) crossing the
Border/Mov
ement,

30
Object Attribute Data Type Remarks Pattern &
Name Descripti
on

Coded

4.5.9 Manifest Master: Supporting Document

Object Attribute Data Type Remarks Pattern

Name &
Descripti
on

Supporting Message CHAR (1) The Flag Desc:

Document Type specifying Default
(messageT the action value - F
Required – ype) requested
True on this
0…n transmission
LOV:
F - Fresh
A-
Amendment

Equipment NUMBER
Serial No. (5)
(equipmen
tSerialNu
mber)
Document NUMBER Serial No. of
Serial no. (4) document
(document
SerialNum
ber)
Icegate CHAR (15) Icegate ID of
User ID user who
(ICEGATEU uploaded
serID) the
supporting

31
Object Attribute Data Type Remarks Pattern
Name &
Descripti
on

documents

IRN No. NUMBER The unique

(IRNNumb (17) reference no
er) given by
eSanchit on
uploading of
document

Document VARCHAR The unique

Reference (17) reference
No. no. given by
(document issue to this
Reference document.
Number)
Eg. Aadhaar
No.

Document CHAR (6) The

Type Code identifier
(document assigned by
TypeCode) Custom to
identify the
type of
document

Beneficiary CHAR (35) The

Code identifier of
(beneficiar beneficiary
yCode) of this
document

Eg. IEC,
Custodian
Code etc.

32
 4.5.10 Manifest Master: DigiSign

Object Attribute Data Remarks Pattern &

Name Type Description

Digi Sign Signature VARCHAR Start

Required (startSignat 2 Signature
– True ure)
1…1 Certificate VARCHAR Start
(startCertifi 2 Certificate
cate)
Version VARCHAR Signer
(signerVersi 2 Version
on)

33
5. JSON Schema’s and Sample’s

5.1 Inbound JSON Schema

5.2 Inbound JSON Samples

5.3 Outbound SFL JSON Schema

5.4 Outbound SFL JSON Samples

Maximum Length Validation Failure

5.5 Outbound ACK JSON Schema

Will insert later

5.6 Outbound ACK JSON Samples

Will insert later

34
6. Object Attribute Table
6.1 Inland Arrival & Departure of Goods

Object Attribute Name CIM-DP CIM-AR

Declaration M M
Message Type M M
(F) (R)
Port of Reporting M M
Job No. M X
Job Date M X
Reporting Event M M
(ID) (IA)
CIM X M
CIM No. M
CIM Date M
Location M M
Reporting Party Type M M
(ATP) (ATP)
Reporting party Code M M
Reference Movement Type O O
Reference Movement No. O O
Reference Movement Date O O
Bond No. M M
Reporting Location Code M M
Reporting Location Name X X
Next Destination of Unlading M M
Authorized Person PAN M M
Transport Means M M
Transport Means Type M M
Transport Means No. M M
Transport Means eID Type O O
Transport Means eID O O
Total Equipment’s M M
Events M M
Expected Time of Departure M X
Actual Time of Departure X X
Expected Time of Arrival M X
Actual Time of Arrival X M
Cargo Container M M
Message Type M M

35
Object Attribute Name CIM-DP CIM-AR
Equipment Sequence No. M M
Container ID M M
Equipment type M M
Equipment Size M M
Equipment Load Status M M
Additional Equipment Hold O O
Final Destination Location M X
Event Date X X
Equipment seal Type M X
Equipment Seal No. M X
Other Equipment ID O O
Equipment Status X M
Equipment Pkg O O
Equipment Quantity O O
Equipment QUC O O
Cargo Document M X
Message Type M
Cargo Sequence No. M
Document Type M
Document Site O
Document No. O
Document Date O
Shipment Load Status M
Package Type M
Quantity O
Packets From O
Packets To O
Pack UQC O
MCIN / PCIN O
Supporting
O O
Document
Message Type M M
Equipment Serial No. M M
Document Serial no. M M
Icegate User ID M M
IRN No. M M
Document Reference No. M M
Document Type Code M M
Beneficiary Code O O

36
 6.2 Allowed for Shipment Request (ASR)

Object Attribute Name CIM-ASR

Declaration M
Message Type M
(F)
Port of Reporting M
Job No. M
Job Date M
Reporting Event M
(AS)
CIM X
CIM No.
CIM Date
Location M
Reporting Party Type M
(ATP)
Reporting party Code M
Reference Movement Type X
Reference Movement No. X
Reference Movement Date X
Bond No. X
Reporting Location Code M
Reporting Location Name M
Next Destination of Unlading X
Authorized Person PAN M
Transport X
Means
Transport Means Type
Transport Means No.
Transport Means eID Type
Transport Means eID
Total Equipment’s
Events X
Expected Time of Departure
Actual Time of Departure
Expected Time of Arrival
Actual Time of Arrival
Cargo M
Details
Message Type M
(F)
Cargo Sequence No. M
Document Type M
Document Site M

37
Object Attribute Name CIM-ASR
Document No. M
Document Date M
Shipment Load Status M
Package Type M
Quantity O
Packets From O
Packets To O
Pack UQC O
MCIN / PCIN M
Cargo M
Container
Message Type M
(F)
Equipment Sequence No. M
Container ID M
Equipment type M
Equipment Size M
Equipment Load Status M
Additional Equipment Hold O
Final Destination Location M
Event Date M
Equipment seal Type M
Equipment Seal No. M
Other Equipment ID O
Equipment Status M
Equipment Pkg O
Equipment Quantity O
Equipment QUC O
Cargo M
Itinerary
Port of call sequence number M
Port of Call, Coded M
Port of Call Name M
Next port of call, Coded M
Next port of call name M
Mode of Transport M
Supporting O
Document
Message Type M
(F)
Equipment Serial No. M
Document Serial no. M
Icegate User ID M
IRN No. M
Document Reference No. M

38
Object Attribute Name CIM-ASR
Document Type Code M
Beneficiary Code O

39
7. List of Values:

Object Name Description Code

Message Type Fresh F
Amendment A
Indicator Production P
Test T
Reporting Event Departure (Inland Departure) DP
Arrival (Inland Arrival) AR
Reporting Party Type Exporter EXP
Custodian C
Terminal Operators T
Transport Means Type Sea 1
Rail 2
Truck 3
Air 4
Equipment type Container C
Bonded truck B
wagon W
Package Type Packaged P
Liquid Bulk LB
Dry Bulk DB
Equipment Load Status Partial LCL
Empty EMP
Full FCL
Equipment Seal Type E-Seal ESEAL
Bottle Seal BTSL
Other Seal OTH
Equipment QUC Package PKG
Kilograms KGS
Document Type Entry Bill EBE – EDI BE,
ZBE – SEZ BE,
MBE – Manual BE
Shipping Bill ESB - EDI SB,
ZSB - SEZ SB,
MSB – Manual SB
Primary Cargo Identification PCIN
No.
Master Cargo Identification MCIN

40
 Object Name Description Code
No.
Shipment Load Status Full F
Partial P

Equipment Status List

Code_Type Code Code Name

Equ_Status 001 Arrival, completed

Equ_Status 3 Arrival, in defective condition

Equ_Status 15 Consolidated

Equ_Status 16 Crossed border

Equ_Status 18 Damaged in the course of transportation

Equ_Status 35 Forwarded to destination

Equ_Status 208 Seals, replaced

Equ_Status 218 Damaged

Equ_Status 238 Means of transport, damaged

Equ_Status 309 Packaging/equipment opened

Equ_Status 335 Seals, damaged

Equ_Status 336 Seals, broken

Equ_Status 337 Seals, tampered

Equ_Status 127 Departed, completed on a means of transport

Equ_Status 94 Stuffed and sealed

Equ_Status 71 Ready for transportation

41
8. Key Fields for Outbound ACK File:

Key Field Key Field

Object Attribute Name Key Field (DP)
(AR) (ASR)
Declaration M M M
Message Type M M M
Port of Reporting M M M
Job No. M M M
Job Date M M M
Reporting Event M M M
Error Code M M M
CIM M M X
CIM No. O M
CIM Date O M
Error Code M M
Location M M M
Reporting Party Type M M M
Reporting party Code M M M
Reference Movement Type X X X
Reference Movement No. X X X
Reference Movement Date X X X
Bond No. X X X
Reporting Location Code X X X
Reporting Location Name X X X
Next Destination of Unlading X X X
Authorized Person PAN X X X
Error Code M M M
Transport
M M X
Means
Transport Means Type M M
Transport Means No. M M
Transport Means eID Type X X
Transport Means eID X X
Total Equipment’s X X
Error Code M M
Events M M X
Expected Time of Departure X X
Actual Time of Departure X X
Expected Time of Arrival X X
Actual Time of Arrival X X

42
 Key Field Key Field
Object Attribute Name Key Field (DP)
(AR) (ASR)
Error Code M M
Cargo Details M M M
Message Type M M M
Cargo Sequence No. M M M
Document Type X X X
Document Site X X X
Document No. X X X
Document Date X X X
Shipment Load Status X X X
Package Type X X X
Quantity X X X
Packets From X X X
Packets To X X X
Pack UQC X X X
MCIN / PCIN X X X
Error Code M M M
Cargo
M M M
Container
Message Type M M M
Equipment Sequence No. M M M
Container ID M M M
Equipment type X X X
Equipment Size X X X
Equipment Load Status X X X
Additional Equipment Hold X X X
Final Destination Location X X X
Event Date X X X
Equipment seal Type X X X
Equipment Seal No. X X X
Other Equipment ID X X X
Equipment Status X X X
Equipment Pkg X X X
Equipment Quantity X X X
Equipment QUC X X X
Error Code M M M
Cargo Itinerary X X M
Port of call sequence number M
Port of Call, Coded X
Port of Call Name X

43
 Key Field Key Field
Object Attribute Name Key Field (DP)
(AR) (ASR)
Next port of call, Coded X
Next port of call name X
Mode of Transport X
Error Code M
Supporting
O O O
Document
Message Type M M M
Equipment Serial No. M M M
Document Serial no. M M M
Icegate User ID X X X
IRN No. X X X
Document Reference No. X X X
Document Type Code X X X
Beneficiary Code X X X
Error Code M M M

44
9. Error Code List:

Error Code Description (Message Level)

M 01 There is duplicate records in master tag
CCM 02 Duplicate records in container
CDM 03 Duplicate records in Cargo
SDM 04 Duplicate records in supporting Document
ITM05 Duplicate records in Itnary
M 06 If a record present in control table there should be a record in master table

Error Code Description (Business level)

HFB02 Reporting event not in (ASR,DP,AR)

DCB03 Reporting event not in (ASR,DP,AR)
LCB04 Party type should be ‘ATP’.

CDB05 If rep_event is ‘ASR’ then MCIN/PCIN must be populated.

CDB06 PCIN is not valid

CDB07 If pcin and rep_event site is same then the Current Queue of the Shipping Bill
should be ‘EGM’.

HF – Header Field Object, LC - Location Object, DC – Declaration Object, CD – Cargo Details Object,
CC – Cargo Container Object, IT – Itnary Object, SD – Supporting Documents Object

45