Parameter Name | Mandatory Field | Value Type | Remarks |
---|
platformCode | Yes | String | Corp Identification Code |
privateKey | Yes | String | Corp Private Key |
serverPublicKey | Yes | String | Corp public key provided by CIC |
serverHost | Yes | String | CIC external domain name |
Parameter Name | Value Type | Remarks |
---|
status | number | Return Status |
msg | String | Error message |
code | String | Error Code |
data | Object | The following interface defines the return parameter structure which is the data structure |
Return Code | Description |
---|
10000 | Please check if the parameters are correct |
10001 | Please use the POST method to request |
10002 | Missing key parameter |
10003 | Missing business data parameters |
10004 | Missing signature parameter |
10005 | System private key error |
10006 | Key Error |
10007 | Parameter decryption error |
10008 | Missing file name |
10009 | Illegal signatures |
10010 | Invalid platform code |
10011 | Invalid platform public key |
10012 | Missing timestamp |
10013 | Request Time expired |
10014 | Missing business line number |
10015 | Missing platform code |
10016 | Interface request duplicated |
10017 | No permission |
10018 | Current user not belong to the requested platform |
10019 | The file should not exceed 5M |
10020 | Requests originate from restricted IP |
10021 | Platform information invalid |
10022 | Platform information not exist |
10023 | The configuration rule of point deduction cannot be empty. |
10024 | An error occurred during the points freezing process. Failed to freeze: insufficient points. |
10025 | The platform is out of service. |
20001 | B/L code cannot be empty |
20002 | Company name cannot be empty |
20003 | Import/export type cannot be empty |
20004 | The country code cannot be empty |
20005 | Paging of company trade data details, up to 500 data items at a time |
20006 | Paging of company trade data details with a minimum of 10 data items at a time |
20007 | Company name up to 100 digits |
20008 | Maximum length of product code is 50 digits |
20009 | Maximum length of the product description is 1000 digits |
20010 | Key of trade record cannot be empty |
1001 | Platform private key error |
1002 | Missing platform code |
1003 | Returned symmetric key is incorrect |
1004 | Missing key parameter of return value |
1005 | Missing business data parameters of return value |
1006 | Missing signature parameter of return value |
1007 | Decrypted return data error |
1008 | Missing file name of return value |
1009 | Illegal signature of return value |
1010 | Maximum file size 5M |
500 | system error |
Country or area name | ISO ALPHA-3 code |
---|
Country or area name | ISO ALPHA-3 code |
---|
Afghanistan | AFG |
Afghanistan | AFG |
Parameter Name | Mandatory Field | Value Type | Remarks |
---|
dataSource | Yes | String | Data source, i: Import e: Export |
startTime | No | number | Start time |
endTime | No | number | End time |
product | No | String | Product Description, Text type, 1000 characters |
hsCode | No | String | HS code, Text type, 0~50 characters |
country | No | String | Three digit country code (ALPHA-3 code from country interface) |
pageIndex | Yes | String | Current page, Default 1 |
pageSize | Yes | String | Queries per page, Default 10 |
Parameter Name | Value Type | Remarks |
---|
timestamp | number | Timestamp |
consumePonits | number | Points consumed |
remainingPoints | number | Available points left |
blDetailInfoList | array | |
key | String | Key of Trade Record |
countryCode | String | Country Code |
exporterName | String | Exporter Name |
importerName | String | Importer Name |
masterBillOfLading | String | Master B/L |
billOfLadingNo | String | Bill of Lading |
portOfLoading | String | Port of Loading |
portOfDischarge | String | Port of Discharge |
countryOfOrigin | String | Country of Origin |
grossWeight | String | Gross weight |
importCustomsDate | String | Import clearance date |
hsCode | String | Item number |
goodValue | String | Value of goods |
hsQty | String | Quantity of goods |
goodsDescription | String | Description of goods |
Parameter Name | Mandatory Field | Value Type | Remarks |
---|
tradeKey | Yes | String | Key of Trade Record |
Parameter Name | Value Type | Remarks |
---|
timestamp | number | Timestamp |
consumePonits | number | Points consumed |
remainingPoints | number | Available points left |
blDetailInfoList | array | |
key | String | Unique Identification |
countryCode | String | Country Code |
ie | String | Import/export marking |
parties | Object | Information of Importers and Exporters |
exporterName | String | Exporter Name |
exporterAddress | String | Exporter's address |
exporterContactInfo | String | Exporter Contact |
importerName | String | Importer Name |
importerAddress | String | Importer's address |
importerContactInfo | String | Importer Contact |
forwarderName | String | Name of Shipping Company |
forwarderName | String | Shipping Information |
masterBillOfLading | String | Master B/L |
billOfLadingNo | String | Bill of Lading |
vesselName | String | Vessel Name/Flight number |
placeOfReceipt | String | Place of Receipt |
portOfLoading | String | Port of Loading |
portOfDischarge | String | Port of Discharge |
placeOfDelivery | String | Place of Delivery |
countryOfOrigin | String | Country of Origin |
destinationCountry | String | Country of Destination |
numberOfPieces | String | Number of pieces |
grossWeight | String | Gross weight |
netWeight | String | Net weight |
totalVolume | String | Total volume |
arrivalDate | String | Arrival Date |
onBoardDate | String | Loading Date |
typeOfTransport | String | Mode of transportation |
importCustomsDate | String | Import clearance date |
grossWeightUnit | String | Gross weight unit |
netWeightUnit | String | Net weight unit |
totalVolumeUnit | String | Total volume unit |
invoice | String | Ticket Information |
invoiceNo | String | Invoice number |
invoiceDate | String | Invoice date |
invoiveValue | String | Invoice amount |
goods | String | Product Information |
hsCode | String | Item number |
hsType | String | Type of goods |
price | String | Unit price of goods |
priceUnit | String | Unit |
totalUnit | String | Total Price Unit |
goodValue | String | Value of goods |
totalDutiableQty | String | Total number of taxes |
hsQty | String | Quantity of goods |
goodsDescription | String | Description of goods |
monetaryUnit | String | Currency Unit |
cargo | Object | Cargo Information |
releaseLocation | String | Place of discharge |
receiptLocation | String | Place of receipt |
storageLocation | String | Storage Location |
blanketStartDate | String | Start date of blanket list |
containerData | String | Container Information |
containerNo | String | Container number |
loadStatus | String | Loading status |
containerDimensions | String | Container volume |
marksAndNumbers | String | Marks |