一、基本说明
| 项名 |
说明 |
| 接口名称 |
报关单解析API |
| 调用地址 |
http://ip地址:端口号/PostTask?AppId=<%appid%>&Sign=<%sign%> |
| 调用方式 |
POST |
| 编码格式 |
application/json; charset=utf-8 |
| 其他说明 |
HTTP请求体不能超过15M |
二、签名方法
| 项名 |
说明 |
| 签名过程 |
Sign=md5('AppId=' + AppId + 'AppKey=' + AppKey) 不含引号本身 |
| 其他说明 |
其中AppId与AppKey由我司对接技术人员事先提供给调用请求方,MD5函数中区分大小写 |
三、接口请求说明
请求体是个JSON格式报文体,其构造说明如下:
| 项名 |
说明 |
| TaskInfo.TaskCode |
为固定值XDP00001 |
| TaskInfo.Files[0].FileName |
报关资料压缩后的文件名(支持的文件格式含
.zip/.rar/.doc/.docx/.xls/.xlsx/.pdf/.jpg/.jpeg/.png/.bmp/.eml等)
|
| TaskInfo.Files[0].Content |
上述文件内容用Base64算法编码后的结果 |
四、接口返回说明
返回结果是个JSON格式的报文体,其构造说明如下:
| 项名 |
说明 |
| TaskInfo.TaskID |
是个GUID值,服务端返回的本次操作任务ID,可用于如有问题时的排查 |
| Response.RespCode |
本次调用返回的结果代码,0表示调用成功 |
| Response.RespText |
本次调用返回的结果文本提示信息 |
| Response.Data.Documents[] |
返回解析报关资料的结构化主体内容(注:一次提交的解析任务中可能含有多个报关单,所以这里返回的是数组形式) |
五、请求示例
POST /PostTask?AppId=12345678&Sign=3e53b523d4243c35a89ed87f HTTP/1.1
Host: xxxxx.com
Content-Type: application/json; charset=utf-8
{
"TaskInfo": {
"TaskCode": "XDP00001",
"Files": [
{
"FileName": "Sample.zip",
"Content": "UEsDBBQACAgIAPikPV=="
}
]
}
}
六、回复体示例
{
"TaskInfo": {
"TaskID": "{33cf1ad9-9261-43f2-a901-813c96d0defa}",
"ParseTime": "2022-10-22 09:58:53.537"
},
"Response": {
"RespCode": 0,
"RespText": "OK",
"Data": {
"Documents": [
{
"DecMessage": {
"DecHead": {
"IEFlag": "E",
"DeclTrnRel": "0",
"CustomMaster": "",
"IEPort": "5141",
"ManualNo": "",
"ContrNo": "JM3-6543",
"TradeCoScc": "91440101MA9Y8GXXXX",
"TradeCode": "1234567890",
"TradeCiqCode": "",
"TradeName": "广州XXX电子商贸有限公司",
"OverseasConsigneeEname": "ABC LOGISTICS LIMITED",
"OwnerCodeScc": "91440101MA9Y8GXXXX",
"OwnerCode": "1234567890",
"OwnerCiqCode": "",
"OwnerName": "广州XXX电子商贸有限公司",
"TrafMode": "2",
"TrafName": "",
"BillNo": "",
"TradeMode": "0110",
"CutMode": "101",
"LicenseNo": "",
"TradeCountry": "",
"DistinatePort": "",
"TransMode": "3",
"FeeMark": "",
"FeeRate": 0,
"FeeCurr": "",
"InsurMark": "",
"InsurRate": 0,
"InsurCurr": "",
"OtherMark": "",
"OtherRate": 0,
"OtherCurr": "",
"PackNo": 119,
"WrapType": "99",
"GrossWet": 108,
"NetWt": 92,
"TradeAreaCode": "",
"EntyPortCode": "",
"GoodsPlace": "",
"DespPortCode": "",
"EntryType": "M",
"NoteS": "",
"ExtInfo": {
"CustomMasterName": "",
"IEPortName": "",
"CutModeName": "一般征税",
"TrafModeName": "水路运输",
"WrapTypeName": "其他包装",
"TradeAreaName": "",
"EntyPortName": "",
"DespPortName": "",
"EntryTypeName": "通关无纸化",
"TransModeName": "FOB",
"TradeCountryName": "",
"TradeModeName": "一般贸易",
"DistinatePortName": "",
"FeeMarkName": "",
"FeeCurrName": "",
"InsurMarkName": "",
"InsurCurrName": "",
"OtherMarkName": "",
"OtherCurrName": "",
}
},
"DecLists": [
{
"DecList": {
"GNo": 1,
"ContrItem": 0,
"CodeTS": "3923290000",
"GName": "塑料袋",
"GModel": "0|0|包装货物用|塑料|Disney|无型号",
"GQty": 2150,
"GUnit": "007",
"DeclPrice": 68,
"DeclTotal": 146200,
"TradeCurr": "USD",
"FirstQty": 2150,
"FirstUnit": "007",
"SecondQty": 92,
"SecondUnit": "035",
"DestinationCountry": "",
"OriginCountry": "CHN",
"OrigPlaceCode": "",
"DistrictCode": "",
"DutyMode": "1",
"ExtInfo": {
"GUnitName": "个",
"TradeCurrName": "美元",
"FirstUnitName": "个",
"SecondUnitName": "千克",
"DestCodeName": "",
"DutyModeName": "照章征税",
"OriginCountryName": "中国",
"OrigPlaceCodeName": "",
"DistrictCodeName": "",
"DestinationCountryName": "",
"XModel": "包装货物用/塑料/品牌:Disney/无型号"
}
}
}
],
"DecFreeTxt": {
"VoyNo": ""
},
},
"Undefineds": [
{
"ItemName": "境内货源地",
"OrigValue": "上海周边"
}
]
}
],
}
}
}
七、响应体说明
| 字段名 |
类型 |
说明 |
| +TaskInfo |
object |
任务返回信息 |
| TaskID |
string |
任务ID号 |
| ParseTime |
string |
解析时间值 |
| +Response |
object |
返回段信息 |
| RespCode |
integer |
任务返回代码,0=解析成功,其他=解析失败 |
| RespText |
string |
任务返回错误信息 |
| +Data |
object |
返回的数据段内容 |
| +Documents |
array |
返回解析后的报文数组项 |
| +DecMessage |
object |
返回解析后的单个报文内容段 |
| +DecHead |
object |
报文内容表头段 |
| IEFlag |
string |
进出口标志;I=进口,E=出口 |
| DeclTrnRel |
string |
报关/转关关系标志;0:一般报关单 |
| CustomMaster |
string |
申报地海关 |
| IEPort |
string |
进境关别/出境关别 |
| ManualNo |
string |
备案号 |
| ContrNo |
string |
合同协议号 |
| TradeCoScc |
string |
境内收发货人社会信用代码 |
| TradeCode |
string |
境内收发货人海关代码 |
| TradeCiqCode |
string |
境内收发货人检验检疫编码 |
| TradeName |
string |
境内收发货人企业名称(中文) |
| OverseasConsigneeEname |
string |
境外收发货人名称(外文) |
| OwnerCodeScc |
string |
消费使用单位/生产销售单位社会信用代码 |
| OwnerCode |
string |
消费使用单位/生产销售单位海关代码 |
| OwnerCiqCode |
string |
消费使用单位/生产销售单位检验检疫编码 |
| OwnerName |
string |
消费使用单位/生产销售单位企业名称(中文) |
| TrafMode |
string |
运输方式代码 |
| TrafName |
string |
运输工具名称 |
| BillNo |
string |
提运单号 |
| TradeMode |
string |
监管方式 |
| CutMode |
string |
征免性质 |
| LicenseNo |
string |
许可证号 |
| TradeCountry |
string |
启运国(地区)/运抵国(地区) |
| DistinatePort |
string |
经停港/指运港 |
| TransMode |
string |
成交方式 |
| FeeMark |
string |
运费标记 |
| FeeRate |
number |
运费/率 |
| FeeCurr |
string |
运费币制 |
| InsurMark |
string |
保险费标记 |
| InsurRate |
number |
任务返回信息 |
| InsurCurr |
string |
保险费币制 |
| OtherMark |
string |
杂费标志 |
| OtherRate |
number |
杂费/率 |
| OtherCurr |
string |
杂费币制 |
| PackNo |
integer |
件数 |
| WrapType |
string |
包装种类 |
| GrossWet |
number |
毛重(KG) |
| NetWt |
number |
净重(KG) |
| TradeAreaCode |
string |
贸易国(地区) |
| EntyPortCode |
string |
入境口岸/离境口岸 |
| DespPortCode |
string |
启运港 |
| NoteS |
string |
备注 |
| +ExtInfo |
object |
主表扩展字段 |
| CustomMasterName |
string |
申报地海关名称 |
| IEPortName |
string |
进境关别/出境关别名称 |
| CutModeName |
string |
征免性质名称 |
| TrafModeName |
string |
运输方式名称 |
| WrapTypeName |
string |
包装种类名称 |
| TradeAreaName |
string |
贸易国(地区)名称 |
| EntyPortName |
string |
入境口岸/离境口岸名称 |
| DespPortName |
string |
启运港名称 |
| EntryTypeName |
string |
报关单类型名称 |
| TransModeName |
string |
成交方式名称 |
| TradeCountryName |
string |
启运国(地区)/运抵国(地区)名称 |
| TradeModeName |
string |
监管方式名称 |
| DistinatePortName |
string |
经停港/指运港名称 |
| FeeMarkName |
string |
运费标记名称 |
| FeeCurrName |
string |
运费币制名称 |
| InsurMarkName |
string |
保险费标记名称 |
| InsurCurrName |
string |
保险费币制名称 |
| OtherMarkName |
string |
杂费标记名称 |
| OtherCurrName |
string |
杂费币制名称 |
| +DecLists |
array |
商品行列表 |
| +DecList |
object |
单条商品行信息 |
| GNo |
integer |
项号 |
| ContrItem |
integer |
备案序号 |
| CodeTS |
string |
商品编号 |
| GName |
string |
商品名称 |
| GModel |
string |
商品规格、型号 |
| GQty |
number |
成交数量 |
| GUnit |
string |
成交计量单位 |
| DeclPrice |
number |
单价 |
| DeclTotal |
number |
总价 |
| TradeCurr |
string |
币制 |
| FirstQty |
number |
法定第一数量 |
| FirstUnit |
string |
法定第一计量单位 |
| SecondQty |
number |
法定第二数量 |
| SecondUnit |
string |
法定第二计量单位 |
| DestinationCountry |
string |
最终目的国(地区)代码 |
| OriginCountry |
string |
原产国(地区)代码 |
| OrigPlaceCode |
string |
原产地区代码 |
| DistrictCode |
string |
境内目的地/境内货源地 |
| DutyMode |
string |
征免方式代码 |
| +ExtInfo |
object |
商品区扩展信息 |
| GUnitName |
string |
成交单位名称 |
| TradeCurrName |
string |
成交币制名称 |
| FirstUnitName |
string |
法定第一计量单位名称 |
| SecondUnitName |
string |
法定第二计量单位名称 |
| DutyModeName |
string |
征免方式名称 |
| OriginCountryName |
string |
原产国(地区)名称 |
| DistrictCodeName |
string |
境内目的地/境内货源地名称 |
| DestinationCountryName |
string |
最终目的国(地区)名称 |
| XModel |
string |
用户提供的原始申报要素 |
| +DecFreeTxt |
object |
其他扩展信息 |
| VoyNo |
string |
航次号 |
| +Undefineds |
object |
不可识别项列表 |
| ItemName |
string |
项的类型名称 |
| OrigValue |
string |
项的具体值 |