...
版本 | 变更内容 | 备注 | 操作人 | 变更时间 |
V3.2 | 新增数据获取 | sw | 20200515 | |
V3.3 | 船名，航次，提单号改为非必填字段 | Stella | 20200608 | |
V3.4 | 货代上传人、货代邮件，货代QQ | sw | 20200805 | |
| V3.5 | 新增获取客户校验稿 | sw | 20200824 | |
| V3.6 | 新增文件流上传接口 | sw | 20210118 | |
| V3.7 | 新增Base64文件上传接口 | sw | 20210119 | |
| V3.7.1 | 新增查验返回JSON | sw | 20210223 | |
| V3.7.2 | 整箱做箱任务/docking/package | 更新说明 | sw | 20210226 |
...
| V3.11.1 | 新增费用接口 | Gavin | 20231201 |
推送AI数据接口
appId 获取方式：开放平台对接参数（appId、回调地址、相关推送）
...
| 接口地址 | 测试URL：http://api.t.baoguan001.com/api/docking/upload 正式URL：http://api.platform.codeflagai.com/api/docking/upload | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 请求方式 | post | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 入参（JSON） |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 出参（Object） |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 描述 |
|
...
| 接口地址 | 测试URL：http://api.t.baoguan001.com/api/docking/fileUpload 正式URL：http://api.platform.codeflagai.com/api/docking/fileUpload | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 请求方式 | post | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 入参（multipart/form-data） |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 出参（Object） |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 描述 |
|
...
| 接口地址 | 测试URL：http://api.t.baoguan001.com/api/docking/fileBase64Upload 正式URL：http://api.platform.codeflagai.com/api/docking/fileBase64Upload |
| 请求方式 | post |
| 入参（JSON） |
...
字段
...
类型
...
描述
...
必填
...
备注
...
orderOutNo
...
String
...
业务流水号
...
Y
...
唯一标记
...
dataJson
...
json
...
申报后json
...
详见附件1：《单一标准数据》
...
字段
...
类型
...
描述
...
备注
...
code
...
int
...
200=成功
...
msg
...
String
...
接口返回信息
...
data
...
json
...
返回数据
...
3.海关回执接口
...
调试url：http://api.t.baoguan001.com/api/docking/receiptsingle
正式url：http://api.platform.codeflagai.com/api/docking/receiptsingle
...
字段
...
类型
...
描述
...
必填
...
备注
...
orderOutNo
...
String
...
业务流水号
...
Y
...
唯一标记
...
paramJson
...
json
...
回执json
...
Y
...
字段
...
类型
...
描述
...
必填
...
备注
...
channel
...
String
...
...
参见《附件3：海关状态》
...
note
...
String
...
...
noticeDate
...
String
...
...
...
customMaster
...
String
...
...
entryId
...
String
...
...
dDate...
...
...
cusCiqNo...
...
...
...
...
cusRetSeqNo...
描述：红框部分为回执号
...
字段
...
类型
...
描述
...
备注
...
code
...
int
...
200=成功
...
msg
...
String
...
接口返回信息
...
data
...
json
...
返回数据
...
4.上传拼箱关系接口 (已废弃)
...
调试url：http://api.t.baoguan001.com/api/docking/lcl
正式url：http://api.platform.codeflagai.com/api/docking/lcl
...
字段
...
类型
...
描述
...
必填
...
备注
...
outNo
...
String
...
拼箱号
...
Y
...
唯一标记
...
billNo
...
String
...
主提单号
...
N
...
shipName
...
String
...
船名
...
Y
...
voyage
...
String
...
航次
...
Y
...
iEPort
...
String
...
出境关别
...
Y
...
洋山：“2248”
外港：“2225”
...
distinatePort
...
String
...
指运港
...
N
...
containerId
...
String
...
集装箱号
...
Y
...
containerMd
...
String
...
集装箱规格
...
Y
...
packNo
...
String
...
件数
...
Y
...
grossWet
...
String
...
毛重
...
Y
...
clcList
...
json
...
拼箱订单列表
...
Y
...
clcList.orderOutNo
...
String
...
业务订单号
...
clcList.billNo
...
String
...
提运单号
...
字段
...
类型
...
描述
...
备注
...
code
...
int
...
200=成功
...
msg
...
String
...
接口返回信息
...
data
...
json
...
返回数据
...
5.上传拼箱任务给报关行
入参：
必填：业务编号、船名、航次、出境关别、提单号、件数、毛重(kg)、
选填：指运港、集装箱号、集装箱规格、随附文档
接口：
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/lcl_task 正式url：http://api.platform.codeflagai.com/api/docking/lcl_task | |||||||||||||||||||
| 请求方式 | post | |||||||||||||||||||
| 入参（DataForm） | ||||||||||||||||||||
字段 | 类型 | 描述 | 必填 | 备注 | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
appId | String | 权限令牌 | Y | 身份标记 | ||||||||||||||||
fileUrl | String | 随附文档 | N | 图片地址 (图片地址和订单列表必填一个，不能两者都为空) | ||||||||||||||||
taskId | String | 拼箱任务ID | N | 新增成功后返回的ID，修改时必填 | bghId | String | 报关行ID | Y | outNo | String | 拼箱号 | N | billNo | String | 提单号 | Y | shipName | String | 船名 | Y | voyage | String | 航次 | Y |
iEPort | String | 出境关别 | N | 外港海关，洋山港区，吴淞 | ||||||||||||||||
iEPortCode | String | 出境关别代码 | N | 2225-外港海关 2248-洋山港区 2202-吴淞 | ||||||||||||||||
declarationPort | String | 申报地海关 | N | 航交办，洋山市内 | ||||||||||||||||
declarationPortCode | String | 申报地海关代码 | N | 2229-航交办 2231-洋山市内 | ||||||||||||||||
entyPort | String | 离境口岸 | N | 外高桥，洋山港 | ||||||||||||||||
entyPortCode | String | 离境口岸代码 | N | 310701-外高桥 311002-洋山港 | distinatePort | String | 指运港 | N | distinatePortCode | String | 指运港代码 | N | containerId | String | 集装箱号 | N | ||||
containerMd | String | 集装箱规格 | N | 20GP，40GP ，40HQ，45GP，45HQ | containerWt | String | 集装箱自重 | N | containerMdCode | String | 集装箱规格代码 | N | packNo | String | 件数 | N | grossWet | String | 毛重 | N | orders | List | 订单列表 | N |
| 字段 | 类型 | 描述 | 必填 |
|---|---|---|---|
| String | orderOutNo | 业务编号 | Y |
| String | newBillNo | 新提单号 | N |
字段
类型
描述
备注
字段 | 类型 | 描述 | 必填 | 备注 | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
appId | String | 权限令牌 | Y | 身份标记(分为测试环境与线上环境) | ||||||||||||||||
bghId | String | 报关行ID | Y | 通过接口获取（6 通过货代appId获取报关行列表） | ||||||||||||||||
fileName | String | 文件名称 | Y | 海运报关业务支持：zip，rar，pdf等 | ||||||||||||||||
base64File | String | base64文件 | Y | Base64.getEncoder().encodeToString(Paths.get(filePath)) | ||||||||||||||||
orderOutNo | String | 外部订单号 | Y | 业务编号 | ||||||||||||||||
isReload | String | 重传标记 | Y | “2” 表示重传，其他暂无意义 | hdUserName||||||||||||||||
|
| 货代联系人
| N | 页面显示 | hdRemark
|
| ||||||||||||||
|
| 货代备注
|
| hdEmail
| String||||||||||||||||
parameter | 货代邮箱JSON | N其他参数 | 如果存在，则显示，不存在，则通过手机查询平台结果Y | hdqq
| String
| 货代QQ
| N
| 如果存在，则显示，不存在，则通过手机查询平台结果
| declareTime
| 要求报关日期
| Y | yyyy-MM-dd HH：mm：ss (大于当前时间1小时) |
字段
类型
描述
备注
code
int
200=成功
msg
String
接口返回信息
data
json
返回数据
信号旗内部流水号
2.单一放行数据接口
...
调试url：http://api.t.baoguan001.com/api/docking/receiptsea
正式url：http://api.platform.codeflagai.com/api/docking/receiptsea
...
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 出参（Object） |
|
1.3进口文件上传接口
| 接口地址 | 测试URL：http://api.t.baoguan001.com/api/docking/uploadImport 正式URL：http://api.platform.codeflagai.com/api/docking/uploadImport | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 请求方式 | post | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 入参（JSON） |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 出参（Object） |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 入参描述出参 |
2.单一放行数据接口
...
...
code =200 成功
非200 表示失败
...
管理员配置好，报关行合作伙伴后，即可产生报关行列表。货代系统可以直接调用此货代对于的报关行列表
...
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/receiptsea 正式url：http://api.platform.codeflagai.com/api/docking/receiptsea | ||||||||||||||||
| 请求方式 | post | ||||||||||||||||
| 入参（json） |
| ||||||||||||||||
| 出参 |
| ||||||||||||||||
| 描述 |
3.海关回执接口
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/bghListreceiptsingle 正式url：http://api.platform.codeflagai.com/api/docking/bghListreceiptsingle | |||||||||||||||||||||||||||||||||||||||||||
| 请求方式 | post | |||||||||||||||||||||||||||||||||||||||||||
| 入参（DataForm）入参（json） |
| 身份标记 | 出参
| code
| int
| 200=成功 | msg
| 接口返回信息
| data||||||||||||||||||||||||||||||||||||
| 接口地址 | ||||||||||||||||||||||||||||||||||||||||||||
| 请求方式 | post | |||||||||||||||||||||||||||||||||||||||||||
| 入参（DataForm） | 字段 类型 描述 必填 备注 | |||||||||||||||||||||||||||||||||||||||||||
appId | String | 货代身份标记 | Y | 身份标记 | orderOutNo | String | 业务编号 | Y | phone | String | 手机号 | N | hdUserName | String | 操作人名称 | Y |
|
List<Object>
报关行列表，需要在相应的开放平台系统中绑定。详细咨询客服
Attribute
7 撤回
撤回
接口：
| ||||||||||||||||||||||||||||||||||
| 出参 |
| |||||||||||||||||||||||||||||||||
| 描述 | 撤回 | 示例 |
二、数据输出（XHQ >> ERP）
在后台配置回调接口地址,需求对方提供;
1.同步单证状态
...
...
4.上传拼箱关系接口 (已废弃)
| 出参
| 字段
| 类型
| 必填
| 描述
| state
| boolean
| Y
| 成功：true
| 失败：false
| msg
| N
| 描述
|
...
| |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
| 描述 |
3.海关回执接口
...
...
5.上传拼箱任务给报关行
入参：
必填：业务编号、船名、航次、出境关别、提单号、件数、毛重(kg)、
选填：指运港、集装箱号、集装箱规格、随附文档
接口：
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/lcl_task 正式url：http://api.platform.codeflagai.com/api/docking/lcl_task |
| 请求方式 | post入参（json） |
| 入参（json） |
...
当前字段的坐标
...
userJson 结构
...
declarationPort
...
申报地海关
...
IEPort
...
出境关别
...
manualNo
...
备案号
...
contrNo
...
合同协议号
...
IEDate
...
出口日期
...
declareDate
...
申报日期
...
tradeName
...
境内收发货人
...
overseasConsignor
...
境外收发货人
...
ownerName
...
生产销售单位
...
agentName
...
申报单位
...
billNo
...
提运单号
...
trafName
...
运输工具名称
...
voyageNo
...
航次号
...
trafModeName
...
运输方式
...
supervisor
...
监管方式
...
cutMode
...
征免性质
...
licenseNo
...
许可证号
...
originalCountry
...
运抵国地
...
distinatePort
...
指运港
...
transMode
...
成交方式
...
feeMark
...
运费/率
...
insurMark
...
保费/率
...
otherMark
...
杂费/率
...
packNo
...
件数
...
字段
...
类型
...
必填
...
描述
...
state
...
boolean
...
Y
...
成功：true
失败：false
...
msg
...
String
...
N
...
1.获取海关回执数据（所有的历史状态记录）
描述：如果对方服务在重启或者长时间未获取到，可以通过该接口来查询数据；数据有效期90天；
| 接口地址 | 调试url：http
| 出参 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
字段 | 类型 | 必填 | 描述 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
state | boolean | Y | 成功：true 失败：false | msg | String | N | 描述 |
4.订单消息通知
...
在信号旗中配置回调接口，接口地址回调方提供。
...
字段 | 类型 | 必填 | 描述 |
|---|---|---|---|
action | String | Y | msg_notice(订单消息通知) |
orderOutNo | String | Y | 业务流水号 |
code | int | N | 消息状态码 |
msg | String | Y | 通知消息 |
...
字段
...
类型
...
必填
...
描述
...
state
...
boolean
...
Y
...
成功：true
失败：false
...
msg
...
String
...
N
...
待确认###
5.推送AI数据接口
...
在信号旗中配置回调接口，接口地址回调方提供。
...
字段
...
类型
...
必填
...
描述
...
declareDate
...
Attribute
...
licenseNo
...
Attribute
...
redeclNo
...
Attribute
...
userJson
...
userJson
...
拼箱标识 ：1 （拼箱）；2（自拼箱）；
...
Attribute 对象：
...
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 出参 |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 描述 | 示例
|
6 通过货代appId获取报关行列表
管理员配置好，报关行合作伙伴后，即可产生报关行列表。货代系统可以直接调用此货代对于的报关行列表
接口：
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/bghList 正式url：http://api.platform.codeflagai.com/api/docking/bghList | |||||||||||||||||||||||||
| 请求方式 | post | |||||||||||||||||||||||||
| 入参（json） |
| |||||||||||||||||||||||||
| 出参 |
| |||||||||||||||||||||||||
| 描述 | 报关行列表，需要在相应的开放平台系统中绑定。详细咨询客服 | |||||||||||||||||||||||||
| 示例 | |
Attribute
7 撤回
撤回
接口：
| 接口地址 | ||||||||||||||||||||||||||
| 请求方式 | post | |||||||||||||||||||||||||
| 入参（json） |
| |||||||||||||||||||||||||
| 出参 |
| |||||||||||||||||||||||||
| 描述 | 撤回 | |||||||||||||||||||||||||
| 示例 |
8 批量解冻
批量解冻接口
接口：
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/unFrozen 正式url：http://api.platform.codeflagai.com/api/docking/unFrozen | |||||||||||||||||||||||||||||||||||
| 请求方式 | post | |||||||||||||||||||||||||||||||||||
| 入参（json） |
| |||||||||||||||||||||||||||||||||||
| 出参 |
| |||||||||||||||||||||||||||||||||||
| 描述 | 如果有不能解冻的订单会返回错误信息，能解冻订单会解冻但不会提示。 | |||||||||||||||||||||||||||||||||||
| 示例 |
9 订单费用确认
确认信号旗订单费用
接口：
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/actionDataRowfeeConfirm 正式url：http正式url：http://api.platform.codeflagai.com/api/docking/actionDataRowfeeConfirm | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 请求方式 | post | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 入参（json）入参（JSON） |
| 出参
| 字段
| 类型
| 必填
| 描述
| code
| int
| 200=成功
| orderOutNo
| 外部流水号
| msg
| data
| data.rows|||||||||||||||||||||||||||||||||||||||||||||||
| 出参 | String
| 根据action查询返回相应的数据集合 | 返回字符串，如果是明文，字符串里面是一个集合；
|
2.获取检验稿
...
| |||||||||
| 描述 | 确认信号旗订单费用；报关费、联单费无需确认 | ||||||||
| 示例 |
10 订单校验稿审核回执
确认信号旗校验稿
接口：
| 接口地址 |
CheckDraftConfirm |
| 请求方式 | post |
| 入参（JSON） |
|
|
|
|
|
|
| ||||||
| 出参 |
|
|
|
|
| 描述 |
data
| 示例 |
3. 获取报关单
...
调试url：http://api.t.baoguan001.com/api/docking/getCustomsClearance
...
二、数据输出（XHQ >> ERP）
在后台配置回调接口地址,需求对方提供;
1.同步单证状态
...
| 接口地址 | 在信号旗中配置回调接口，接口地址回调方提供（注意：该地址只能提供一个，具体业务根据action字段区分）。 | ||||||||||||||||||||
| 请求方式 | post | ||||||||||||||||||||
| 入参（json） |
| ||||||||||||||||||||
| 出参 |
| ||||||||||||||||||||
| 描述 |
|
...
| 接口地址 | 描述 |
2.推送数据接口
| 接口地址 | 在信号旗中配置回调接口，接口地址回调方提供（注意：该地址只能提供一个，具体业务根据action字段区分）。 | ||||||||||||||||
| 请求方式 | post | ||||||||||||||||
| 入参（json） |
| ||||||||||||||||
| 出参 |
| ||||||||||||||||
| 描述 |
|
...
3.
...
海关回执接口
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/getCheckRows 正式url：http://api.platform.codeflagai.com/api/docking/getCheckRows在信号旗中配置回调接口，接口地址回调方提供（注意：该地址只能提供一个，具体业务根据action字段区分）。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 请求方式 | post | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 入参（json） |
| 出参
| 字段 |
| code
| int | 200=成功 | msg
| Y
| 说明
| data
| List
| 多个下载地址
| 根据type 类型返回，不传type 返回值结构版本1，check返回值结构版本2
| 描述
| 版本1
|
| 版本2
|
|---|
五. 信号旗推送消息给报关行 (报关行->信号旗)
在后台配置回调接口地址,需求对方提供;
1.同步单证状态
...
在信号旗中配置回调接口，接口地址回调方提供。
...
字段
...
类型
...
必填
...
描述
...
action
...
String
...
Y
...
syn_status (同步状态)
...
orderOutNo
...
String
...
Y
...
业务流水号
...
code
...
int
...
Y
...
参见《附件4：信号旗订单状态》
...
msg
...
String
...
Y
...
字段
...
类型
...
必填
...
描述
...
state
...
boolean
...
Y
...
成功：true
失败：false
...
msg
...
String
...
N
...
2.推送数据接口
| 接口地址 | 在信号旗中配置回调接口，接口地址回调方提供。 | |||||||||||||||||
| 请求方式 | post | |||||||||||||||||
| 入参（json） |
|
推送AI数据接口
四. 报关行与信号旗对接 (ERP->报关行)
1. 整箱做箱任务
...
调试url：http://api.t.baoguan001.com/api/docking/package
正式url：http://api.platform.codeflagai.com/api/docking/package
...
字段
...
类型
...
描述
...
必填
...
备注
...
appId
...
String
...
权限令牌
...
Y
...
身份标记
...
shipName...
voyage...
billNo...
packNo...
String...
grossWet...
String...
containerId...
containerMd...
containerWt...
containerMdCode
...
containerSid...
字段
...
类型
...
描述
...
备注
...
code
...
int
...
200=成功
...
msg...
String
...
接口返回信息
...
data
...
Object
...
做箱任务由货代端ERP发起，通过信号旗IM，传递给报关行；
报关行客户，确定做箱数据后，回填到系统中（这事数据才真正的生效）
2.获取推送消息
...
调试url：http://api.t.baoguan001.com/api/docking/sendMsg
正式url：http://api.platform.codeflagai.com/api/docking/sendMsg
...
字段 | 类型 | 描述 | 必填 | 备注 |
|---|---|---|---|---|
appId | String | 权限令牌 | Y | 身份标记 |
msg | String | 消息内容 | Y | |
| sessionType | String | 会话类型 | Y | 默认是：20 |
messageType | String | 消息类型 | Y | 《消息类型》 |
| orderOutNo | String | 业务编号 | Y | 订单的身份 |
...
字段
...
类型
...
描述
...
备注
...
code
...
int
...
200=成功
...
msg...
String
...
接口返回信息
...
data
...
Object
...
示例：
| 入参 | 出参 |
|---|---|
| { "appId":"<身份标记>", "msg":"[{"containerId":"<集装箱号>","containerMd":"<箱规格>","containerWt":"<箱自重>","containerMdCode":"<箱规格代码>","containerSid":"<箱封号>","lclFlag":<拼箱标识>,"goodsNo":"<商品项号关系>"}]", "sessionType":"20", "messageType":"1706", "orderOutNo":"<订单的身份>" } | { "code":200, "msg":null, "data":true } |
ERP发送消息，给报关行的客户。直接发送到报关的想要的聊天记录中，并提供消息即使提醒
| ||||||||||||||||||||||||
| 出参 |
| |||||||||||||||||||||||
| 描述 |
4.订单消息通知
| 接口地址 | 在信号旗中配置回调接口，接口地址回调方提供。 | ||||||||||||||||||||
| 请求方式 | post | ||||||||||||||||||||
| 入参（json） |
| ||||||||||||||||||||
| 出参 |
| ||||||||||||||||||||
| 描述 | 待确认### |
5.推送进口保税数据接口核注清单
| 接口地址 | 在货代配置回调接口，接口地址回调方提供。 | ||||||||||||||||||||||||
| 请求方式 | post | ||||||||||||||||||||||||
| 入参（json） |
| ||||||||||||||||||||||||
| 出参 | |||||||||||||||||||||||||
| 描述 | 待确认### |
6.推送订单费用接口
| 接口地址 | 信号旗中配置回调接口地址，接口地址回调方提供（注意：该地址只能提供一个，具体业务根据action字段区分）。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 请求方式 | post | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 入参（json） |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 出参 |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 描述 |
7.进口流程节点推送数据接口
接口地址 | 在后台配置外部地址url，接口地址外部提供。 | ||||||||||||||||||||||||||||||||
请求方式 | Post | ||||||||||||||||||||||||||||||||
参数（json） |
| ||||||||||||||||||||||||||||||||
| 出参 |
| ||||||||||||||||||||||||||||||||
| 描述 |
8.进口合作方数据对接推送数据接口
接口地址 | 在后台配置外部地址url，接口地址外部提供。 | ||||||||||||||||||||
请求方式 | Post | ||||||||||||||||||||
参数（json） |
| ||||||||||||||||||||
| 出参 |
| ||||||||||||||||||||
| 描述 |
View file name 合作方详细数据推送数据说明240422.docx height 250
三、数据获取（XHQ << ERP）
1.获取海关回执数据（所有的历史状态记录）
描述：如果对方服务在重启或者长时间未获取到，可以通过该接口来查询数据；数据有效期90天；
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/actionDataRow 正式url：http://api.platform.codeflagai.com/api/docking/actionDataRow | ||||||||||||||||||||||||
| 请求方式 | post | ||||||||||||||||||||||||
| 入参（json） |
| ||||||||||||||||||||||||
| 出参 |
| ||||||||||||||||||||||||
| 描述 |
2.获取检验稿
描述：通过外部流水号+appId，获取校验稿url
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/getCheckDraft 正式url：http://api.platform.codeflagai.com/api/docking/getCheckDraft | |||||||||||||||||||
| 请求方式 | post | |||||||||||||||||||
| 入参（json） |
| |||||||||||||||||||
| 出参 |
| |||||||||||||||||||
| 示例 |
|
3. 获取报关单
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/getCustomsClearance 正式url：http://api.platform.codeflagai.com/api/docking/getCustomsClearance | ||||||||||||||||
| 请求方式 | post | ||||||||||||||||
| 入参（json） |
| ||||||||||||||||
| 出参 |
| ||||||||||||||||
| 描述 |
|
4. 获取放行通知书
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/getReleaseNotice 正式url：http://api.platform.codeflagai.com/api/docking/getReleaseNotice | ||||||||||||||||
| 请求方式 | post | ||||||||||||||||
| 入参（json） |
| ||||||||||||||||
| 出参 |
| ||||||||||||||||
| 描述 |
|
5. 获取查验通知书
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/getCheckRows 正式url：http://api.platform.codeflagai.com/api/docking/getCheckRows | ||||||||||||||||
| 请求方式 | post | ||||||||||||||||
| 入参（json） |
| ||||||||||||||||
| 出参 |
| ||||||||||||||||
| 描述 | 版本1  版本2  |
6. 获取报关委托书
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/getAuthorizationLetter 正式url：http://api.platform.codeflagai.com/api/docking/getAuthorizationLetter | ||||||||||||||||
| 请求方式 | post | ||||||||||||||||
| 入参（json） |
| ||||||||||||||||
| 出参 |
| ||||||||||||||||
| 描述 |
|
四. 客户系统与信号旗对接 (ERP->报关行)
1. 整箱做箱任务
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/package 正式url：http://api.platform.codeflagai.com/api/docking/package | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 请求方式 | post | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 入参（DataForm） |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 出参 |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 描述 | 做箱任务由货代端ERP发起，通过信号旗IM，传递给报关行； 报关行客户，确定做箱数据后，回填到系统中（这时数据才真正的生效） |
2.获取推送消息
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/sendMsg 正式url：http://api.platform.codeflagai.com/api/docking/sendMsg | ||||||||||||||||||||||||||||||
| 请求方式 | post | ||||||||||||||||||||||||||||||
| 入参（DataForm） |
| ||||||||||||||||||||||||||||||
| 出参 |
| ||||||||||||||||||||||||||||||
| 描述 | 示例：
ERP发送消息给报关行。直接发送到报关的想要的聊天记录中，并提供消息即使提醒 |
五. 信号旗推送消息给对接方 (信号旗->对接方)
在后台配置回调接口地址,需求对方提供;
1.同步单证状态
| 接口地址 | 在信号旗中配置回调接口，接口地址回调方提供。 | ||||||||||||||||||||
| 请求方式 | post | ||||||||||||||||||||
| 入参（json） |
| ||||||||||||||||||||
| 出参 |
| ||||||||||||||||||||
| 描述 |
2.推送数据接口
| 接口地址 | 在信号旗中配置回调接口，接口地址回调方提供。 | ||||||||||||||||
| 请求方式 | post | ||||||||||||||||
| 入参（json） |
| ||||||||||||||||
| 出参 |
| ||||||||||||||||
| 描述 |
3.海关回执接口
| 接口地址 | 在信号旗中配置回调接口，接口地址回调方提供。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 请求方式 | post | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 入参（json） |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 出参 |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 描述 |
六. 信号旗推送消息失败结果
1. 推送失败清单查询
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/failedPushQuery 正式url：http://api.platform.codeflagai.com/api/docking/failedPushQuery | ||||||||||||||||||||||||||||
| 请求方式 | post | ||||||||||||||||||||||||||||
| 入参（JSON） |
| ||||||||||||||||||||||||||||
| 出参 |
| ||||||||||||||||||||||||||||
| 描述 | 示例：
|
2. 系统流水号查询失败记录
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/queryFailedPush 正式url：http://api.platform.codeflagai.com/api/docking/queryFailedPush | ||||||||||||||||||||||||||||||||||||||||||||
| 请求方式 | post | ||||||||||||||||||||||||||||||||||||||||||||
| 入参（JSON） |
| ||||||||||||||||||||||||||||||||||||||||||||
| 出参 |
| ||||||||||||||||||||||||||||||||||||||||||||
| 描述 | 示例：
|
3. 批量系统流水号查询失败记录
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/queryBatchFailedPush 正式url：http://api.platform.codeflagai.com/api/docking/queryBatchFailedPush | |||||||||||||||||||||||||
| 请求方式 | post | |||||||||||||||||||||||||
| 入参（JSON） |
| |||||||||||||||||||||||||
| 出参 |
|
|
|
成功：true
失败：false
|
|
|
...
|
在信号旗中配置回调接口，接口地址回调方提供。
|
|
N
业务流水号
|
|
|
|
|
|
|
| 描述 |
示例： |
|
|
String
参见《附件3：海关状态》
note
String
海关描述
noticeDate
String
海关时间
customMaster
String
主管海关
entryId
String
海关编码
cusCiqNoreleaseNotice
String
N
放行通知书文件地址
customsDeclaration
String
N
报关单文件地址
examinePdf字段
类型
必填
描述
state
boolean
Y
成功：true
失败：false
msg
String
N
4.电子底账日期推送
...
在信号旗中配置回调接口，接口地址回调方提供。
...
字段
...
类型
...
必填
...
描述
...
action
...
String
...
Y
...
electronic_ledger
...
...
orderOutNo
...
String
...
Y
...
业务流水号
...
billNo
...
String
...
N
...
提运单号
...
...
...
json
...
Y
回执json
字段 | 类型 | 必填 | 描述 |
|---|---|---|---|
qcPassId | String | Y | 电子底账编号 |
validDate | String | Y | 电子底账有效结束时间 |
signDate | String | Y | 电子底账有效开始时间 |
declareNo | String | Y | 报关ID |
...
字段
...
类型
...
必填
...
描述
...
state
...
boolean
...
Y
...
成功：true
失败：false
...
msg
...
String
...
N
...
附件
...
|
4. 推送失败清单确认（清理）
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/failedPushConfirm 正式url：http://api.platform.codeflagai.com/api/docking/failedPushConfirm | |||||||||||||||||||||||||
| 请求方式 | post | |||||||||||||||||||||||||
| 入参（JSON） |
| |||||||||||||||||||||||||
| 出参 |
| |||||||||||||||||||||||||
| 描述 | 示例：
|
七. 合作方最终数据回推信号旗
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/receiptsea 正式url：http://api.platform.codeflagai.com/api/docking/receiptsea |
附件
附件1：导入单一标准数据格式declareDate
文件
http://single-xml-dev.oss-cn-shanghai.aliyuncs.com/doc/doc/datajson.json
说明:
附件2：回调接口类型
syn_status (同步状态)
...