API说明

本API提供委托单上传、发送、报关单数据下载、报关进程下载等功能。

本API采用REST格式。对于POST和PUT请求，请求的主体必须是JSON格式，而且HTTP header的Content-Type需要设置为application/json。

用户验证是通过HTTP header来进行的，除了登录的API，每个API都要在HTTP header 中添加 X-Ticket 头，该值在登录成功的Reponse 中获取到。

API返回有两种格式：xml和json。默认返回json格式。获取不同格式的方法有多种：

1. 将要请求的格式添加在url的后缀，如请求报关单id为1的xml: http://api.yunbaoguan.cn/Bg/1.xml

json格式： http://api.yunbaoguan.cn/Bg/1.json
2. 将要请求的格式添加在url的请求参数中，参数名为 fmt，如请求报关单id为1的xml: http://api.yunbaoguan.cn/Bg/1?fmt=xml

json格式： http://api.yunbaoguan.cn/Bg/1?fmt=json
3. 将要请求的格式添加在HTTP header中，请求头名为 Accept 如请求 xml： Accept: application/xml

json格式： Accept: application/json

响应格式

一个请求是否成功是由HTTP状态码标明的. 一个2XX的状态码表示成功,而一个4XX表示请求失败.当一个请求失败时响应的主体是一个错误信息的字符串

压缩

系统支持两种压缩格式，gzip 和 deflate, 默认不压缩。要启用压缩需要在请求头中添加头 Accept-Encoding，值为gzip 或者 deflate

1、API列表

1.1、用户登录

功能描述：验证用户，获取后续请求的Ticket，Ticket的有效期是12小时。


                    curl -X POST 

                    -H "Content-Type: application/json" 

                    -d '{"name":"test","password":"test"}' 

                    http://api.yunbaoguan.cn/users

响应的主体是一个JSON对象,后续的操作都要在HTTP Header 中的 X-Ticket 使用该 ticket 字符串。


                    { 

                    "ticket":"4g8RF9FGznSMXJ9zwER580/zvGfG/1LxdL5zXoukR1U443X82WSb2MBZk74Fc+yu24n52/wdS1hyJ01M8c21XHeB00D6OxZjg=" 

                    }

1.2、委托单查询

功能描述：按照查询条件查询委托单


                    curl -X POST 

                    -H "X-Ticket: 4g8RF9FGznSMXJ9zwER580/zvGfG/1LxdL5zXoukR1U443X82WSb2MBZk74Fc+yu24n52/wdS1hyJ01M8c21XHeB00D6OxZjg=" 

                    -H "Content-Type: application/json" 

                    -d '{"bg_org_short":"云报关",

                    "so_no":"X1300112333",

                    "goods_name":"手机",

                    "container_no1":"CURE1345813",

                    "trust_no":"2015060099",

                    "created_dt_from":"2015-06-01",

                    "created_dt_to":"2015-06-07" 

                    "sendYn":1 

                    }' 

                    http://api.yunbaoguan.cn/trusts?page=2&rows=20

请求参数

参数	必选	字段类型	说明	填写位置
page	是	int	请求页数	url参数
rows	是	int	每页记录数	url参数
bg_org_short	否	string	报关行	request body
so_no	否	string	S/O号	request body
goods_name	否	string	货名	request body
container_no1	否	string	柜号	request body
trust_no	否	string	委托单号	request body
created_dt_from	否	string	开始委托日期	request body
created_dt_to	否	string	结束委托日期	request body
sendYn	否	int	是否发送（1 已发送、0 为发送、-1 全部）	request body

响应值(json)


                    { 

                    "rows":[{}],

                    "totalRecord":258,

                    "curPage":2,

                    "totalPages":13 

                    }

参数	字段类型	说明
rows	数组	当前委托单头列表，详细请查看
totalRecord	int	查询的记录总数
curPage	int	查询页数
totalPages	int	查询结果总页数

1.3、委托单明细

功能描述：查询单个委托单的详细记录，包括委托单信息、柜号信息、商品信息、随附单证信息。


                    curl -X GET 

                    -H "X-Ticket: 4g8RF9FGznSMXJ9zwER580/zvGfG/1LxdL5zXoukR1U443X82WSb2MBZk74Fc+yu24n52/wdS1hyJ01M8c21XHeB00D6OxZjg=" 

                    http://api.yunbaoguan.cn/trusts?uid=ueffegw123wgwegwegww

请求参数

参数	必选	字段类型	说明	填写位置
uid	是	string	委托单UID	url参数

响应值(json)


                    { 

                    "head":{},

                    "dtls":[{}],

                    "gdtls":[{}],

                    "adtls":[{}] 

                    }

参数	字段类型	说明
head	对象	委托单头信息，详细请查看
dtls	数组	委托单柜号信息列表，详细请查看
gdtls	数组	委托单商品信息列表，详细请查看
adtls	数组	委托单随附单证信息列表，详细请查看

1.4、委托单上传

功能描述：新增或者修改一个委托单。如果委托单头中提供了uid，且uid是一个已经存在的委托单的uid，则修改该uid对应的委托单，否则将新增一个委托单


                    curl -X POST 

                    -H "X-Ticket: 4g8RF9FGznSMXJ9zwER580/zvGfG/1LxdL5zXoukR1U443X82WSb2MBZk74Fc+yu24n52/wdS1hyJ01M8c21XHeB00D6OxZjg=" 

                    -H "Content-Type: application/json" 

                    -d '{"head":"委托单头",

                    "dtl":"委托单柜号列表",

                    "gdtl":"委托单商品列表",

                    "adtl":"委托单随附单证列表",

                    "callback":"接受报关回执地址"

                    }' 

                    http://api.yunbaoguan.cn/trusts

请求参数

参数	必选	字段类型	说明	填写位置
head	是	对象	委托单头,具体值请查看	request body
dtl	是	数组	委托单柜号列表,具体值请查看	request body
gdtl	是	数组	委托单商品列表,具体值请查看	request body
adtl	是	数组	委托单随附单证列表,具体值请查看	request body
callback	否	字符串	报关回执返回地址。如果需要接受报关回执，设置该地址，云报关采用POST方式向该地址发送回执。回执有两种，都是JSON格式：详情请查看	request body

响应值(json)


                    { 

                    "head":{},

                    "dtls":[{}],

                    "gdtls":[{}],

                    "adtls":[{}] 

                    }

参数	字段类型	说明
head	对象	委托单头信息，详细请查看
dtls	数组	委托单柜号信息列表，详细请查看
gdtls	数组	委托单商品信息列表，详细请查看
adtls	数组	委托单随附单证信息列表，详细请查看

1.5、委托单附件上传

功能描述：上传委托附件，可以是任意格式的文件


                    curl -X POST 

                    -H "X-Ticket: 4g8RF9FGznSMXJ9zwER580/zvGfG/1LxdL5zXoukR1U443X82WSb2MBZk74Fc+yu24n52/wdS1hyJ01M8c21XHeB00D6OxZjg=" 

                    -H "Content-Type: application/json" 

                    -d '文件Base64加密后的字符串' 

                    http://api.yunbaoguan.cn/trusts?uid=123123&fname=a.pdf&ftype=99999999

请求参数

参数	必选	字段类型	说明	填写位置
uid	是	字符串	委托单头UID	request url
fname	是	字符串	文件名，必须包含文件后缀名	request url
ftype	是	字符串	00000001:发票 00000002:装箱单 00000003:提运单 00000004:合同 00000005:其他 00000006:其他 00000007:其他 00000008:纸质代理报关委托协议扫描件 10000001:电子代理委托协议编号 10000002:减免税货物税款担保证明 10000003:减免税货物税款担保延期证明 99999999:所有其他的	request url
data	是	字符串	文件Base64加密后的字符串	request body

响应值(json)


                    { 

                    "message": "上传成功"

                    }

1.6、委托单发送

功能描述：将已经保存的委托单发送给合作伙伴：报关行、货代或者拖车行。这些合作伙伴需要在网页的用户中心中设置，并通过获取委托单合作伙伴来获取


                    curl -X POST 

                    -H "X-Ticket: 4g8RF9FGznSMXJ9zwER580/zvGfG/1LxdL5zXoukR1U443X82WSb2MBZk74Fc+yu24n52/wdS1hyJ01M8c21XHeB00D6OxZjg=" 

                    -H "Content-Type: application/json" 

                    -d '{"orgcds":"接收方列表"}' 


                    http://api.yunbaoguan.cn/trusts?uid=ueffegw123wgwegwegww

请求参数

参数	必选	字段类型	说明	填写位置
uid	是	string	委托单UID	url参数
orgcds	是	数组	接收方列表,具体值请查看	request body

响应值(json)


                    { 

                    "head":{},

                    "dtls":[{}],

                    "gdtls":[{}],

                    "adtls":[{}] 

                    }

参数	字段类型	说明
head	对象	委托单头信息，详细请查看
dtls	数组	委托单柜号信息列表，详细请查看
gdtls	数组	委托单商品信息列表，详细请查看
adtls	数组	委托单随附单证信息列表，详细请查看

1.7、获取委托单合作伙伴

功能描述：获取在云报关的用户中心中设置的合作伙伴


                    curl -X POST 

                    -H "X-Ticket: 4g8RF9FGznSMXJ9zwER580/zvGfG/1LxdL5zXoukR1U443X82WSb2MBZk74Fc+yu24n52/wdS1hyJ01M8c21XHeB00D6OxZjg=" 

                    http://api.yunbaoguan.cn/partners

响应值(json)


                    { 

                    "objs":[{}],

                    "other":[{}]

                    }

参数	字段类型	说明
objs	数组	报关行列表，详细请查看
other	数组	其他合作伙伴列表，详细请查看

1.8、基本数据查询

功能描述：查询进出口口岸、申报口岸、币种、单位、运抵国、指运港、境内货源地、经营单位、发货单位、运输方式、贸易方式、征免性质、结汇方式、成交方式、包装方式、报关单类型等基本数据的查询。显示10条记录


                    curl -X GET 

                    -H "X-Ticket: 4g8RF9FGznSMXJ9zwER580/zvGfG/1LxdL5zXoukR1U443X82WSb2MBZk74Fc+yu24n52/wdS1hyJ01M8c21XHeB00D6OxZjg=" 

                    http://api.yunbaoguan.cn/codes?zclassId=4&term=蛇口&artYn=0

请求参数

参数	必选	字段类型	说明	填写位置
zclassId	是	int	基本数据类型(单位1、国家2、币种3、申报口岸4、进出口口岸4、境内货源地(境内目的地) 5、征免性质 7、成交方式 9、贸易方式 10、随附单证类型 11 运输方式 12、用途 13、包装类型 16、结汇方式 17、指运港(装货港) 18、商品征免 20、杂费 23、保费 24、运费 26、报关单类型 28	url参数
term	是	int	要查询的编码或基本类型名称	url参数
artYn	是	int	固定值: 0	url参数

响应值(json 数组)


                    [{"label": "蛇口口岸,5304","value": "蛇口口岸","zucode":"5304"}]

参数	字段类型	说明
label	字符串	基本类型名称+','+基本类型编码
value	字符串	基本类型名称
zucode	字符串	基本类型编码

1.9、公司货号查询

功能描述：按货号、品名或者编码查询公司货号。显示所有货号


                    curl -X GET 

                    -H "X-Ticket: 4g8RF9FGznSMXJ9zwER580/zvGfG/1LxdL5zXoukR1U443X82WSb2MBZk74Fc+yu24n52/wdS1hyJ01M8c21XHeB00D6OxZjg=" 

                    http://api.yunbaoguan.cn/codes?zclassId=1001&term=手机&artYn=0

请求参数

参数	必选	字段类型	说明	填写位置
zclassId	是	int	固定值：1000	url参数
term	是	int	要查询的商品编码或品名	url参数
artYn	是	int	固定值: 0	url参数

响应值(json 数组)


                    [{"label": "蛇口口岸,5304","g_name": "蛇口口岸","value":"5304"}...]

参数	字段类型	说明
item_no	字符串	项号
goods_no	字符串	商品编码
goods_name	字符串	品名
ver_no	字符串	版本号
art_no	字符串	货号
stitems_name	字符串	商品要素名称
control	字符串	随附单证编码
control_name	字符串	随附单证名称
unit_no	字符串	成交单位编码
unit_name	字符串	成交单位名称
unit02_no	字符串	法1单位编码
unit02_name	字符串	法1单位名称
unit03_no	字符串	法2单位编码
unit03_name	字符串	法2单位名称
goods_spec	字符串	规格
price	decimal(18,4)	单价

1.10、报关单下载

功能描述：根据报关单ID或者委托单uid下载对应报关单数据，包含报关单头，柜号，商品，随附单证


                    curl -X GET 

                    -H "X-Ticket: 4g8RF9FGznSMXJ9zwER580/zvGfG/1LxdL5zXoukR1U443X82WSb2MBZk74Fc+yu24n52/wdS1hyJ01M8c21XHeB00D6OxZjg=" 

                    http://api.yunbaoguan.cn/bg?id=34566&idType=1

请求参数

参数	必选	字段类型	说明	填写位置
id	是	string	报关单ID	url参数
idType	是	string	id类型：1代表参数id是报关单的id；2代表参数id是委托单的uid；3代表参数id是报关单的委托号	url参数

响应值(json)


                    { 

                    "head":[{}],

                    "dtls":[{}],

                    "gdtls":[{}],

                    "adtls":[{}] 

                    }

参数	字段类型	说明
head	对象	报关单头信息，详细请查看
dtls	数组	报关单柜号信息列表，详细请查看
gdtls	数组	报关单商品信息列表，详细请查看
adtls	数组	报关单随附单证信息列表，详细请查看

1.11、报关进程

功能描述：按照报关单ID查询报关进程


                    curl -X GET 

                    -H "X-Ticket: 4g8RF9FGznSMXJ9zwER580/zvGfG/1LxdL5zXoukR1U443X82WSb2MBZk74Fc+yu24n52/wdS1hyJ01M8c21XHeB00D6OxZjg=" 

                    http://api.yunbaoguan.cn/bgtrace

请求参数

参数	必选	字段类型	说明	填写位置
id	是	int	报关单ID	url参数

响应值(json)


                    { 

                    "head":{ 

                    "port_no":"进出口岸", 

                    "custom_apply_no": "18位报关单号", 

                    "cabin_no":"提运单号", 

                    "shipper_name":"境内收发货人名称", 

                    "container_no1": "柜号, 

                    "container_count":"柜量", 

                    "num_goods":"商品数", 

                    "goods_name":"品名" 

                    }, 

                    "dtl":[ 

                    { 

                    "bg_state_id": "进程ID", 

                    "cname": "进程名称", 

                    "process_dt": "进程时间", 

                    "p_name": "操作人", 

                    "a_phone": "操作人手机", 

                    "zucode": "操作人代码" 

                    } 

                    ] 

                    }

1.12、委托进程

功能描述：按照委托单ID查询委托进程


                    curl -X GET 

                    -H "X-Ticket: 4g8RF9FGznSMXJ9zwER580/zvGfG/1LxdL5zXoukR1U443X82WSb2MBZk74Fc+yu24n52/wdS1hyJ01M8c21XHeB00D6OxZjg=" 

                    http://api.yunbaoguan.cn/trusttrace

请求参数

参数	必选	字段类型	说明	填写位置
id	是	int	报关单ID	url参数

响应值(json)


                    { 

                    "trustTrace": [{ "created_dt": "2015-06-01 09:09", "FDt": "2015-06-01 13:45", "SDt": "2015-06-01 15:45", 

                    "s_org_name": "蛇口云报关", "state": "已接受","c_name": "创建人","f_name": "发送人","s_name": "接受人" }], 

                    "bgTrace": [{"cname": "逻辑审核","process_dt": "2015-06-11 13:45"}] 

                    }

参数	字段类型	说明
trustTrace	数组	委托进程，详细查看委托进程字段
bgTrace	数组	对应的报关单进程，详细查看报关进程字段

委托进程字段

参数	字段类型	说明
created_dt	datetime	委托创建时间
FDt	datetime	委托发送时间
SDt	datetime	委托接受时间
s_org_name	string	委托接受单位
state	string	委托状态
c_name	string	创建人
f_name	string	发送人
s_name	string	接受人

1.13、合同发票查询

功能描述：按(出口买方/进口卖方名称、地址、电话)查询合同发票信息。显示所有出口买方/进口卖方信息


                    curl -X GET 

                    -H "X-Ticket: 4g8RF9FGznSMXJ9zwER580/zvGfG/1LxdL5zXoukR1U443X82WSb2MBZk74Fc+yu24n52/wdS1hyJ01M8c21XHeB00D6OxZjg=" 

                    http://api.yunbaoguan.cn/codes?zclassId=889&term=HONGKONG&artYn=0

请求参数

参数	必选	字段类型	说明	填写位置
zclassId	是	int	固定值：889	url参数
term	是	int	要查询的出口买方/进口卖方名称、地址或电话	url参数
artYn	是	int	固定值: 0	url参数

响应值(json 数组)

字段名	字段类型	说明
seller_address	字符串	出口卖方、进口买方地址
seller_tel	字符串	出口卖方、进口买方电话
zgd_customer_name	字符串	出口买方、进口卖方全称
buyers_tel	字符串	出口买方、进口卖方电话
buyers_address	字符串	出口买方、进口卖方地址
invoice_no	字符串	发票号码
invoice_dt	字符串	发票日期
contract_no	字符串	合同号
contract_dt	字符串	合同日期
signed_at	字符串	签约地

1.14、公路舱单上传发送

功能描述：导入公路舱单到云报关系统并设置发送状态


                    curl -X POST 

                    -H "X-Ticket: 4g8RF9FGznSMXJ9zwER580/zvGfG/1LxdL5zXoukR1U443X82WSb2MBZk74Fc+yu24n52/wdS1hyJ01M8c21XHeB00D6OxZjg=" 

                    -H "Content-Type: application/json" 

                    -d '{"head":"公路舱单表头",

                    "dtl":"公路舱单报关单项",

                    }' 

                    http://api.yunbaoguan.cn/bill

请求参数

参数	必选	字段类型	说明	填写位置
head	是	对象	公路舱单表头,具体值请查看	request body
dtl	是	数组	公路舱单报关单列表,具体值请查看	request body

响应值(json)


                    { 

                    "message":"操作成功"

                    }

2、数据字典

字段类型说明

类型名	说明
string	字符串
date	yyyy-MM-dd 格式的字符串
datetime	yyyy-MM-dd HH:mm:ss 格式的字符串
int	整形，可以是整形转换后的字符串
decimal	浮点类型，可以是浮点类型转换后的字符串，decimal(18,5) 表示总长最长18位，小数最长5位的浮点数

2.1、委托单头

字段	类型	中文名	说明
uid	string	后台生成的委托ID	新增时不用赋值，修改时需要赋值。新增后会将该字段返回给前台，在修改委托单时需要该值
declare_id	int	报关类型	保存委托单时需要提供，1 出口、2进口
port_no2	string	进出口口岸编号
port_no	string	申报地海关
indate_dt	date	进出口日期	进口必须填写,格式 YYYY-MM-DD
so_no	string	S/O号
entry_type	string	报关单类型编号
records_no	string	备案号
transmode_no	string	运输方式编号
shipper_no	string	收发货人编号
shipper_code	string	收发货人18位信用代码
shipper_name	string	收发货人名称
consignee_no	string	生产销售单位编号	出口填写生产销售单位编号，进口填写消费使用单位编号
consignee_code	string	生产销售单位18位信用代码	出口填写生产销售单位18位信用代码，进口填写消费使用单位18位信用代码
consignee_name	string	生产销售单位名称	出口填写生产销售单位名称，进口填写消费使用单位名称
agent_no	string	申报单位编号
agent_code	string	申报单位18位信用代码
agent_name	string	申报单位名称
transname	string	运输工具名称
trade_no	string	监管方式编号
imposemode_no	string	征免性质编号
remitmode_no	string	结汇方式编号
licence_no	string	许可证号
start_country_no	string	运抵国编号
loadport_no	string	指运港编号
end_country_no	string	进内货源地编号
trade_country_no	string	贸易国别编号
bargainmode_no	string	成交方式编号
freightmode_no	string	运费标识
freight_currency_no	string	运费币种编号
freight	decimal(18,4)	运费
subscribemode_no	string	保费标识
subscribe_currency_no	string	保费币种编号
subscribe	decimal(18,4)	保费
incidentalmode_no	string	杂费标识
incidental_currency_no	string	杂费币种编号
incidental	decimal(18,4)	杂费
contract_no	string	合同协议号
piece	int	件数
pack_no	string	包装方式编号
grossweight	decimal(18,4)	毛重
netweight	decimal(18,4)	净重
truck_no	string	车牌号
book_no	string	订舱号
cabin_no	string	提运单号
drawback_no	string	是否退税	01 退税,02 不退税,没有则不填写
vessel	string	船名
voyage	string	航次
tsgxqr	string	特殊关系确认	0或者1
jgyxqr	string	价格影响确认	0或者1
zftxqsyfqr	string	支付特许权使用费确认	0或者1
note	string	备注
contract_dt	date	合同日期
invoice_dt	date	发票日期
invoice_no	string	发票号
signed_at	string	签约地址
seller_address	string	卖方地址
seller_tel	string	卖方电话
buyers_address	string	买方地址
buyers_tel	string	买方电话
bus_no	string (30)	委托号	新增的字段
declare_group_id	int	报关组ID	新增的字段
despport	string	离境口岸	单一窗口新增字段
goodsplace	string	货物存放地	单一窗口新增字段
markno	string	标记唛码	单一窗口新增字段
distinateport	string	经停港	单一窗口新增字段
buyer_no	string	境外收发货人代码	单一窗口新增字段
buyer_name	string	境外收发货人英文名	单一窗口新增字段

2.2、委托单柜号

字段	类型	中文名	说明
num_no	int	序号
container_type_no	string	柜型	4选1： 20、40、45、53
container_type	string	柜型	2选1：GP、HQ
container_no	string	柜号
fee_type	string	是否拼柜,拼柜填写L、整柜填写F
seal_no	string	封条号
piece	int	件数
grossweight	decimal(18,4)	毛重
goodsname	string	品名

2.3、委托单商品

字段	类型	中文名	说明
num_no	int	序号
item_no	string	项号
goods_no	string	商品编号
goods_name	string	品名
goods_spec	string	规格
ver_no	string	版本号
amount	decimal(18,5)	成交数量
unit_no	string	成交单位编号
amount02	decimal(18,5)	法1数量
unit02_no	string	法1单位编号
amount03	decimal(18,5)	法2数量
unit03_no	string	法2单位编号
country_no	string	目的国/原产国	出口填写目的国，进口填写原产国
other_country_no	string	原产国/目的国	出口填写原产国，进口填写目的国
sum	decimal(18,4)	总价
price	decimal(18,4)	单价
currency_no	string	币种编号
impose_no	string	征免性质编号
grossweight	decimal(18,4)	毛重
netweight	decimal(18,4)	净重
piece	int	件数
exg_no	string	货号	新增
gjf	int	工缴费	新增
sjgoods_no	string	检验检疫代码	单一窗口新增字段
ciq_name	string	检验检疫名称	单一窗口新增字段
districtcode	string	境内货源地	单一窗口新增字段
origincode	string	地区代码	单一窗口新增字段

2.4、委托单随附单证

字段	类型	中文名
num_no	int	序号
control_no	string	随附单证编号代码
accompany_no	string	随附单证编号

2.5、报关单头

字段	类型	中文名	说明
declare_name	string	报关类型
entry_type	string	报关单类型
customer_no	string	客户编号
customer_name	string	客户名称
cust_linkman	string	客户联系人
records_no	string	备案号
goods_name	string	品名
indate_dt	datetime	进出口日期
apply_dt	datetime	报关日期
apply_no	string	报关单号
custom_apply_no	string	18位报关单号
unify_no	string	统一编号
verify_no	string	批准文号
transmode_no	string	运输方式
factory_no	string	用途编号
factory_name	string	用途名称
shipper_no	string	经营单位编号
shipper_name	string	经营单位名称
consignee_no	string	发货单位编号
consignee_name	string	发货单位名称
agent_no	string	申报单位编号
agent_name	string	申报单位名称
transname	string	运输工具名称
cabin_no	string	提运单号
serial_no	string	流水号
trade_no	string	贸易方式
drawback_no	string	是否退税	01 退税，02 不退税
imposemode_no	string	征免性质
remitmode_no	string	结汇方式
imposepro	decimal(18,4)	征税比例
licence_no	string	许可证号
start_country_no	string	运抵国	进口: 起运国
loadport_no	string	指运港	进口: 装货港
end_country_no	string	境内货源地	进口: 境内目的地
bargainmode_no	string	成交方式
freightmode_no	string	运费类型
freight_currency_no	string	运费币种
freight	decimal(18,4)	运费
subscribemode_no	string	保费类型
subscribe_currency_no	string	保费币种
subscribe	decimal(18,4)	保费
incidentalmode_no	string	杂费类型
incidental_currency_no	string	杂费币种
incidental	decimal(18,4)	杂费
contract_no	string	合同号
piece	int	件数
pack_no	string	包装类型
grossweight	decimal(18,4)	毛重
netweight	decimal(18,4)	净重
truck_no	string	车牌号
bus_no	string	业务号
check_no	string	随附单据号
vessel	string	船名
voyage	string	航次
book_no	string	订舱号
wharf_name	string	码头
ship_agent_no	string	船代编号
ship_agent_name	string	船代名
factory	string	生产厂家
entrust_no	string	委托书号
container_count	int	柜量
mark	string	备注
port_no	string	申报口岸
num_goods	int	商品项数
port_no2	string	进出口口岸
despport	string	离境口岸	单一窗口新增字段
goodsplace	string	货物存放地	单一窗口新增字段
markno	string	标记唛码	单一窗口新增字段
distinateport	string	经停港	单一窗口新增字段
buyer_no	string	境外收发货人代码	单一窗口新增字段
buyer_name	string	境外收发货人英文名	单一窗口新增字段
formNo	string	核增(核扣)单号	金关系统字段
gsdjqr	string	公司定价确认	单一窗口新增字段
zdjgqr	string	暂定价格确认	单一窗口新增字段

2.6、报关单柜号

字段	类型	中文名	说明
num_no	int	序号
container_type_no	string	柜型1
container_type	string	柜型2
container_no	string	柜号
fee_type	string	是否拼柜	L 拼柜 F整柜
seal_no	string	封条号
goodsname	string	品名
piece	int	件数
grossweight	decimal(18,4)	毛重

2.7、报关单商品

字段	类型	中文名	说明
num_no	int	序号
item_no	string	项号
goods_no	string	商品编码
goods_name	string	品名
goods_brand	string	品牌
goods_spec	string	规格
ver_no	string	版本号
amount	decimal(18,5)	成交数量
unit_no	string	成交单位
amount02	decimal(18,5)	法1数量
unit02_no	string	法1单位代码
unit02_name	string	法1单位名称	下载报关单数据时显示，上传数据时不填写
amount03	decimal(18,5)	法2数量
unit03_no	string	法2单位代码
unit03_name	string	法2单位名称	下载报关单数据时显示，上传数据时不填写
country_no	string	出口目的国/进口原产国
other_country_no	string	出口原产国/进口目的国
sum	decimal(18,4)	总价
price	decimal(18,4)	单价
currency_no	string	币种
impose_no	string	结汇方式
grossweight	decimal(18,4)	毛重
netweight	decimal(18,4)	净重
piece	int	件数
exg_no	string	货号	新增字段
gjf	int	工缴费	新增字段
sjgoods_no	string	检验检疫代码	单一窗口新增字段
ciq_name	string	检验检疫名称	单一窗口新增字段
districtcode	string	境内货源地	单一窗口新增字段
origincode	string	地区代码	单一窗口新增字段
jgeqgno	string	金关序号	新增金关序号
sourceMarkcd	string	来源标识	来源标识

2.8、报关单随附单证

字段	类型	中文名
num_no	int	序号
control_no	string	监管条件
accompany_no	string	随附单证号码

2.9、公路舱单表头

字段	类型	中文名	说明
declare_id	int	进出口类型	出口：1，进口：2
shipping_no	string	载货清单号	13位。进口舱单必须是1开头；出口舱单必须是5开头
port_no2	string	进出境口岸代码	目前支持 5301，5320，5321，5345，5795 口岸
port_no	string	装卸货代码	4位。口岸代码
shipping_dt	datetime	装货时间	格式：YYYY-MM-DD HH:mm:ss
rd_no	string	海关货物通关代码	目前支持 RD01\|公路口岸直通,RD02\|公路口岸直通转关,RD03\|公路口岸卸货,RD04\|公路口岸卸货转关,RD05\|公路口岸掏箱,RD06\|公路口岸掏箱转关,RD07\|公路口岸卸箱,RD08\|公路口岸卸箱转关,RD09\|跨境快速通关（非过境）,RD10\|空车,RD11\|公路暂时进出境空集装箱,RD12\|公路暂时进境空集装箱口岸卸箱,RD13\|非转关公路口岸直通非贸货物,RD14\|公路口岸装货（出口）,RD15\|公路口岸装箱（出口）,RD16\|跨境快速通关货物（过境）
container_no	string	柜号	每个柜号格式为4位字母+7位数字，多个柜号之间用竖线\|分割

2.10、公路舱单报关单项

字段	类型	中文名	说明
shipper	string	发货人
receiver	string	收货人
cabin_no	string	提运单号	每个提运单号不能重复
goods_name	string	商品项简要描述	每份报关单的第一项商品品名
piece	int	货物总件数	报关单的总件数
pack_no	string	包装种类代码	目前支持 CS\|箱,CH\|箱，柜,CT\|纸板箱,PE\|托盘,BD\|板,BU\|散装,BY\|以堆/束/捆形式的板
grossweight	decimal(18,4)	货物总毛重	报关单的总毛重
sum	decimal(18,2)	货物价值	报关单的总价值
currency_no	string	币种代码	HKD\|港币,IDR\|印度尼西亚卢比,JPY\|日本元,MOP\|澳门元,MYR\|马来西亚林吉特,PHP\|菲律宾比索,SGD\|新加坡元,KRW\|韩国圆,THB\|泰国铢,CNY\|人民币,TWD\|新台币,EUR\|欧元,DKK\|丹麦克朗,GBP\|英镑,NOK\|挪威克朗,SEK\|瑞典克朗,CHF\|瑞士法郎,RUB\|俄罗斯卢布,CAD\|加拿大元,USD\|美元,AUD\|澳大利亚元,NZD\|新西兰元

2.11、报关单回执

报关单号：格式为 `{"ApplyNo": "535220200520429800","ApplyDt": "2020/07/06"}`
字段	类型	中文名	说明
ApplyNo	string	18位海关编号
ApplyDt	string	报关日期

海关状态：格式为 `{"StateNo": "106","StateDt": "2020-07-06T14:16:04","Note": "结关;","StateName": "海关已结关" }`
字段	类型	中文名
StateNo	string	海关状态编码
StateDt	string	状态时间
Note	string	状态备注
StateName	string	海关状态名称

API说明

响应格式

压缩

1、API列表

1.1、 用户登录

1.2、 委托单查询

请求参数

响应值(json)

1.3、 委托单明细

请求参数

响应值(json)

1.4、 委托单上传

请求参数

响应值(json)

1.5、 委托单附件上传

请求参数

响应值(json)

1.6、 委托单发送

请求参数

响应值(json)

1.7、获取委托单合作伙伴

响应值(json)

1.8、 基本数据查询

请求参数

响应值(json 数组)

1.9、 公司货号查询

请求参数

响应值(json 数组)

1.10、报关单下载

请求参数

响应值(json)

1.11、 报关进程

请求参数

响应值(json)

1.12、 委托进程

请求参数

响应值(json)

委托进程字段

1.13、 合同发票查询

请求参数

响应值(json 数组)

1.14、 公路舱单上传发送

请求参数

响应值(json)

2、数据字典

字段类型说明

2.1、 委托单头

2.2、 委托单柜号

2.3、 委托单商品

2.4、 委托单随附单证

2.5、 报关单头

2.6、 报关单柜号

2.7、 报关单商品

2.8、 报关单随附单证

2.9、 公路舱单表头

2.10、 公路舱单报关单项

2.11、 报关单回执

1.1、用户登录

1.2、委托单查询

1.3、委托单明细

1.4、委托单上传

1.5、委托单附件上传

1.6、委托单发送

1.8、基本数据查询

1.9、公司货号查询

1.11、报关进程

1.12、委托进程

1.13、合同发票查询

1.14、公路舱单上传发送

2.1、委托单头

2.2、委托单柜号

2.3、委托单商品

2.4、委托单随附单证

2.5、报关单头

2.6、报关单柜号

2.7、报关单商品

2.8、报关单随附单证

2.9、公路舱单表头

2.10、公路舱单报关单项

2.11、报关单回执