...
版本 | 变更内容 | 备注 | 操作人 | 变更时间 |
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 |
appId 获取方式：开放平台对接参数（appId、回调地址、相关推送）
...
| 接口地址 | 测试URL：http://api.t.baoguan001.com/api/docking/upload 正式URL：http://api.platform.codeflagai.com/api/docking/upload |
| 请求方式 | post |
| 入参（JSON） |
字段 | 类型 | 描述 | 必填 | 备注 |
|---|
appId | String | 权限令牌 | Y | 身份标记(分为测试环境与线上环境) | bghId | String | 报关行ID | Y | 通过接口获取（6 通过货代appId获取报关行列表） | fileUrl | String | 网络下载地址 | Y | http://allseeing-rar.oss-cn-shanghai.aliyuncs.com/A1908010846 5575164/1564620414.zip 海运报关业务支持：zip，rar格式； | orderOutNo | String | 外部订单号 | Y | 业务编号 | isReload | String | 重传标记 | Y | “2” 表示重传，其他暂无意义（暂不支持重传） | parameter | json | 其他参数 | Y |
字段 | 类型 | 描述 | 必填 | 备注 |
|---|
| sourceAppId | String | 来源appId | N | 第三方 | | phone | String | 手机号 | N | 信号旗货代平台如果存在该手机号，为默认为上传人 | | customerName | String | 客户上传人 | N | 默认为空，标记第三方上传人 | | hdEmail | String | 货代邮箱 | N | 如果存在，则显示，不存在，则通过手机查询平台结果（20200805新增） | hdqq | String | 货代QQ | N | 如果存在，则显示，不存在，则通过手机查询平台结果（20200805新增） | declarationPort | String | 申报口岸 | N | 海关编码 | IEPort | String | 出境关别 | N | 洋山：“2248” 外港：“2225” | entyPort | String | 离境口岸 | N | 海关编码 | trafName | String | 船名 | N |
|
| | | | |
| tradeArea | String | 贸易国 | N | 海关编码 | originalCountry | String | 运抵国 | N | 海关编码 | distinatePort | String | 指运港 | N | 海关编码 | trafModeName | String | 运输方式 | N |
|
|
| declareNo | String | 报关ID | N | 业务编号预留字段 | volume | String | 体积 | N |
|
|
| receiptUserName | String | 客户名称 | N | 页面显示 | noticeBgh | boolean | 等通知报关 | N | true=是 （等通知报关） false=否 （直接可报关） 接口上传默认false |
|
| paperType | boolean | 有纸报关/通关无纸化 | N | true=是 false=否 接口上传默认false | linkage | String | 多式联运 | N | twoPortLinkage=两港联动 dushanPort=独山港 Other=其他内支河 | hdUserName | String | 货代联系人 | N | 页面显示 | containerNo | String | 集箱号 | N |
|
|
| source | String | 来源 | N | 用于页面显示 | manuscriptCheck | boolean | 校验单标识 | N | true=是 false=否 是否需要进行预录单校验 | needSecondCheck | boolean | 二审标识 | N | true=是 false=否 接口上传默认false | priorityGrade | boolean | 优先审核标识 | N | true=是 false=否 接口上传默认false | importantCheck | boolean | 重点审核标识 | N | true=是 false=否 接口上传默认false | orderCommissionCheck | boolean | 电子委托标记 | N | true=是 false=否 报关委托书为电子委托或非电子委托 | declareTime | String | 要求报关日期 | Y | yyyy-MM-dd HH：mm：ss | mergeType |
|
| N | 1=出口拼箱 2=出口整箱 3=进口拼箱 4=进口整箱 5=进口分拨 6=出口自拼箱 7=进口报关 8=出口报关 | decContainersJsonArray |
|
| N | 格式： | 字段名称 | 类型 | 描述 | 格式 | 说明 |
|---|
containerMd | json | 规格 | code，value | value必须为以下值：20GP，40GP ，40HQ，45GP，45HQ； code对应value：20GP为21，40GP为11，40HQ为11，45GP为11，45HQ为11； code 21 对应 value 20GP
11对应40GP
11对应40HQ
11对应45GP
11对应45HQ
| goodsNo | json | 商品项号关系 | code，value | value必须为“1,2,3”格式，数字对应报关单商品项号，用英文逗号隔开； code传空字符串 | containerId | json | 集装箱号 | code，value | value为集装箱号； code传空字符串 | lclFlag | json | 拼箱标志 | code，value | value必须为以下值：是，否；（是表示拼箱，否表示整箱） code对应value：是为1，否为0； | containerWt | json | 自重 | code，value | value为集装箱自重； code传空字符串 |
示例：
[{ "containerMd":{"code":"","value":""}, "goodsNo":{"code":"","value":""}, "containerId":{"code":"","value":""}, "lclFlag":{"code":"","value":""}, "containerWt":{"code":"","value":""} }]  Image Modified
|
|
|
| 出参（Object） |
|
| data | json | 返回数据： orderOutNo（外部流水号）
| 信号旗内部流水号 |
|
| 描述 | 上传成功以后，返回orderOutNo
|
1.1 文件流上传接口
1.2 base64上传接口
| 接口地址 | 测试URL：http://api.t.baoguan001.com/api/docking/fileBase64Upload 正式URL：http://api.platform.codeflagai.com/api/docking/fileBase64Upload |
| 请求方式 | post |
| 入参（JSON） |
| | | | |
|---|
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 | String | 货代联系人 | N | 页面显示 | | hdRemark | String | 货代备注 | N |
|
| | hdEmail | String | 货代邮箱 | N | 如果存在，则显示，不存在，则通过手机查询平台结果 | hdqq | String | 货代QQ | N | 如果存在，则显示，不存在，则通过手机查询平台结果 | declareTime | String | 要求报关日期 | Y | yyyy-MM-dd HH：mm：ss (大于当前时间1小时) |
|
| 出参（Object） |
|
2.单一放行数据接口
3.海关回执接口
4.上传拼箱关系接口 (已废弃)
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 |
| | | | |
| 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 |
| |
| containerMd | String | 集装箱规格 | N | 20GP，40GP ，40HQ，45GP，45HQ | containerWt | String | 集装箱自重 | N |
|
| containerMdCode | String | 集装箱规格代码 | N |
| |
| orders | List | 订单列表 | N |
| 字段 | 类型 | 描述 | 必填 |
|---|
| String | orderOutNo | 业务编号 | Y | | String | newBillNo | 新提单号 | N |
|
|
| 出参 |
|
| 描述 | 示例
| 入参 | 出参 |
|---|
{ "appId":"<身份标记>", "fileUrl":"", "bghId":"<报关行>", "outNo":"", "billNo":"<提单号>", "shipName":"<船名>", "voyage":"<航次>", "iEPort":"", "iEPortCode":"", "declarationPort":"", "declarationPortCode":"", "entyPort":"", "entyPortCode":"", "distinatePort":"", "distinatePortCode":"", "containerId":"", "containerMd":"", "containerWt":"", "containerMdCode":"", "packNo":"", "grossWet":"", "orders":[{"orderOutNo":"<业务编号>","newBillNo":"<新提单号>"}] } | code =200 成功 非200 表示失败 |
|
6 通过货代appId获取报关行列表
管理员配置好，报关行合作伙伴后，即可产生报关行列表。货代系统可以直接调用此货代对于的报关行列表
...
...
7 撤回
撤回
接口：
二、数据输出（XHQ >> ERP）
在后台配置回调接口地址,需求对方提供;
...
| 接口地址 | 在信号旗中配置回调接口，接口地址回调方提供。 |
| 请求方式 | post |
| 入参（json） |
字段 | 类型 | 必填 | 描述 |
|---|
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） |
字段 | 类型 | 必填 | 描述 |
|---|
action | String | Y | send_data (制单完成数据) sendBgh_data (报关行发送数据) single_data (单一放行数据) | orderOutNo | String | Y | 业务流水号 | dataJson | json | N | 详见附件1：《单一标准数据》 |
|
| 出参 |
字段 | 类型 | 必填 | 描述 |
|---|
state | boolean | Y | 成功：true 失败：false | msg | String | N |
|
| 描述 | |
|
3.海关回执接口
| 接口地址 | 在信号旗中配置回调接口，接口地址回调方提供。 |
| 请求方式 | post |
| 入参（json） |
字段 | 类型 | 必填 | 描述 |
|---|
action | String | Y | single_receipt(海关回执) | orderOutNo | String | N | 业务流水号 | billNo | String | N | 提运单号 | paramJson | json | Y | 回执json |
| | | | |
| 统一编号 | releaseNotice | String | N | 放行通知书文件地址 | customsDeclaration | String | N | 报关单文件地址 | examinePdf | String | N | 查验通知书(口岸查验通知、报关单查验通知......) |
|
|
| 出参 |
字段 | 类型 | 必填 | 描述 |
|---|
state | boolean | Y | 成功：true 失败：false | msg | String | N |
|
| 描述 |
|
4.订单消息通知
| 接口地址 | 在信号旗中配置回调接口，接口地址回调方提供。 |
| 请求方式 | post |
| 入参（json） |
字段 | 类型 | 必填 | 描述 |
|---|
action | String | Y | msg_notice(订单消息通知) | orderOutNo | String | Y | 业务流水号 | code | int | N | 消息状态码 | msg | String | Y | 通知消息 |
|
| 出参 |
字段 | 类型 | 必填 | 描述 |
|---|
state | boolean | Y | 成功：true 失败：false | msg | String | N |
|
|
| 描述 | 待确认### |
...
1.获取海关回执数据（所有的历史状态记录）
描述：如果对方服务在重启或者长时间未获取到，可以通过该接口来查询数据；数据有效期90天；
...
5.推送AI数据接口
| 接口地址 | 在信号旗中配置回调接口，接口地址回调方提供。 |
| 请求方式 | post |
| 入参（json） |
字段 | 类型 | 必填 | 描述 |
|---|
declareDate | Attribute |
|
| licenseNo | Attribute |
|
| redeclNo | Attribute |
|
|
Attribute 对象： | 字段 | 类型 | 必填 | 描叙 |
|---|
| code | String |
|
| | value | String |
|
| | total | Integer |
|
| | flag | String |
|
| | currency | String |
|
| | dutyNo | String |
|
| | rows | List |
|
| 字段 | 类型 | 必填 | 描叙 |
|---|
| code | String |
|
| | value | String |
|
| | colorFlag | String |
|
| | flag | String |
|
| | cellName | String |
|
| | docType | String |
|
| | used | String |
|
| | extraType | String |
|
| | warningIndex | String |
|
| | top | Integer |
|
| | bottom | Integer |
|
| | left | Integer |
|
| | right | Integer |
|
| | height | Integer |
|
| | width | Integer |
|
| | conceptId | Integer |
|
| | dutyNo | String |
|
| | imgSrc | String |
|
| | sourceFlag | String |
|
| | conceptStr | String |
|
|
|
|
| 出参 |
字段 | 类型 | 必填 | 描述 |
|---|
state | boolean | Y | 成功：true 失败：false | msg | String | N |
|
|
| 描述 |
|
三、数据获取（XHQ << ERP）
1.获取海关回执数据（所有的历史状态记录）
描述：如果对方服务在重启或者长时间未获取到，可以通过该接口来查询数据；数据有效期90天；
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/actionDataRow 正式url：http://api.platform.codeflagai.com/api/docking/actionDataRow |
| 请求方式 | post |
| 入参（json） |
字段 | 类型 | 必填 | 描述 |
|---|
action | String | Y | single_receipt(海关回执) | appId | String | Y |
|
|
| 出参 |
|
| orderOutNo | String | Y | 外部流水号 | msg | String | N |
| | |
|
|
| data.rows | String | 根据action查询返回相应的数据集合 | 返回字符串，如果是明文，字符串里面是一个集合； |
|
| 描述 |
|
2.获取检验稿
描述：通过外部流水号+appId，获取校验稿url
3. 获取报关单
4. 获取放行通知书
5. 获取查验通知书
四. 报关行与信号旗对接 (ERP->报关行)
1. 整箱做箱任务
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/package 正式url：http://api.platform.codeflagai.com/api/docking/package |
| 请求方式 | post |
| 入参（DataForm） |
字段 | 类型 | 描述 | 必填 | 备注 |
|---|
appId | String | 权限令牌 | Y | 身份标记 | | orderOutNo | String | 业务编号 | Y | 订单的身份 | | msg | String |
| | | | | |
| | decContainersJsonArray | JsonArray | 集装箱 | N |
| 字段 | 类型 | 描述 | 必填 | 备注 |
|---|
| String | containerId | 集装箱号 | Y |
|
|
|
| | String | containerMd | 箱规格 | Y | 必须为以下值：20GP，40GP ，40HQ，45GP，45HQ | | String | containerWt | 箱自重 | N |
|
|
|
| String | containerMdCode
| 箱规格代码 | N |
|
|
| |
| | int | lclFlag | 拼箱标识 | Y | 0:非拼箱； 1:拼箱 | | String | goodsNo | 商品项号关系 | N | 格式：1,2,3 |
|
|
|
| 出参 |
|
| 描述 | 做箱任务由货代端ERP发起，通过信号旗IM，传递给报关行； 报关行客户，确定做箱数据后，回填到系统中（这事数据才真正的生效） |
2.获取推送消息
| 接口地址 | 调试url：http://api.t.baoguan001.com/api/docking/sendMsg 正式url：http://api.platform.codeflagai.com/api/docking/sendMsg |
| 请求方式 | post |
| 入参（DataForm） |
字段 | 类型 | 描述 | 必填 | 备注 |
|---|
appId | String | 权限令牌 | Y | 身份标记 | msg | String | 消息内容 | Y | 《消息体》 | | sessionType | String | 会话类型 | Y | 默认是：20 | messageType | String | 消息类型 | Y | 《消息类型》 | | orderOutNo | String | 业务编号 | Y | 订单的身份 |
|
| 出参 |
|
| 描述 | 示例： | 入参 | 出参 |
|---|
{
"appId":"<身份标记>",
"msg":"[{"containerId":"<集装箱号>","containerMd":"<箱规格>","containerWt":"<箱自重>","containerMdCode":"<箱规格代码>","containerSid":"<箱封号>","lclFlag":<拼箱标识>,"goodsNo":"<商品项号关系>"}]",
"sessionType":"20",
"messageType":"1706",
"orderOutNo":"<订单的身份>"
} | {
"code":200,
"msg":null,
"data":true
} |
ERP发送消息，给报关行的客户。直接发送到报关的想要的聊天记录中，并提供消息即使提醒 |
五. 信号旗推送消息给报关行 (报关行->信号旗)
...
| 接口地址 | 在信号旗中配置回调接口，接口地址回调方提供。 |
| 请求方式 | post |
| 入参（json） |
字段 | 类型 | 必填 | 描述 |
|---|
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） |
字段 | 类型 | 必填 | 描述 |
|---|
action | String | Y | send_data (制单完成数据) sendBgh_data (报关行发送数据) single_data (单一放行数据) | orderOutNo | String | Y | 业务流水号 | dataJson | json | N | 详见附件1：《单一标准数据》 |
|
| 出参 |
字段 | 类型 | 必填 | 描述 |
|---|
state | boolean | Y | 成功：true 失败：false | msg | String | N |
|
|
| 描述 |
|
3.海关回执接口
| 接口地址 | 在信号旗中配置回调接口，接口地址回调方提供。 |
| 请求方式 | post |
| 入参（json） |
字段 | 类型 | 必填 | 描述 |
|---|
action | String | Y | single_receipt(海关回执) | orderOutNo | String | N | 业务流水号 | billNo | String | N | 提运单号 | paramJson | json | Y | 回执json |
| | | |
| 统一编号 | releaseNotice | String | N | 放行通知书文件地址 | customsDeclaration | String | N | 报关单文件地址 | examinePdf | String | N | 查验通知书(口岸查验通知、报关单查验通知......) |
|
|
| 出参 |
字段 | 类型 | 必填 | 描述 |
|---|
state | boolean | Y | 成功：true 失败：false | msg | String | N |
|
|
| 描述 | |
4.电子底账日期推送
| 接口地址 | 在信号旗中配置回调接口，接口地址回调方提供。 |
| 请求方式 | post |
| 入参（json） |
字段 | 类型 | 必填 | 描述 |
|---|
action | String | Y | electronic_ledger | orderNo | String | Y | 信号旗流水号 | orderOutNo | String | Y | 业务流水号 | billNo | String | N | 提运单号 | hdCoId | String | N |
|
| dataJson | json | Y | 回执json 字段 | 类型 | 必填 | 描述 |
|---|
qcPassId | String | Y | 电子底账编号 | validDate | String | Y | 电子底账有效结束时间 | signDate | String | Y | 电子底账有效开始时间 | declareNo | String | Y | 报关ID |
|
|
| 出参 |
字段 | 类型 | 必填 | 描述 |
|---|
state | boolean | Y | 成功：true 失败：false | msg | String | N |
|
|
| 描述 | |
...
附件
附件1：导入单一标准数据格式
文件
http://single-xml.oss-cn-shanghai.aliyuncs.com/doc/doc/datajson.json
...
single_receipt(海关回执)
msg_notice (订单消息通知)
附件3：海关状态
| 海关状态描述 |
|---|
7=申报成功 a=签证 A=海关放行前删除或者异常处理（手工申报通知） B=担保放行 C=出口查验通知 D=海关删单 E=海关退单/不受理回执 F=放行交单 G=报关单已审结 H=海关挂起，需手工申报 I=海关无纸放行通知（放行） J=通关无纸化审结回执（审结回执一种） K=通关无纸化担保放行 L=海关已接收 M=报关单重审 N=重传文件 O=准予进卡 P=海关已放行 R=已结关 S=施检 T=需交税费 W=海关无纸验放通知（审结） X=海关准予进港回执（上海洋山保税港区专用） Y=申报失败 Z=退回修改 |
...
附件4：信号旗订单状态
| 信号旗订单状态 |
|---|
43 =已接单 50 =已撤回 61 =待校验稿审核 63 =预录完成（原待导入） 81 =申报成功、导入单一 |
...
phone
