Versions Compared

Old Version 97

changes.mady.by.user 秦小康

Saved on

compared with

New Version Current

changes.mady.by.user 张能

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

版本

变更内容

备注

操作人

变更时间

V3.2

新增数据获取


sw

20200515

V3.3

船名，航次，提单号改为非必填字段


Stella

20200608

V3.4

货代上传人、货代邮件，货代QQ


sw

20200805

V3.5新增获取客户校验稿
sw20200824
V3.6新增文件流上传接口
sw20210118
V3.7新增Base64文件上传接口
sw20210119
V3.7.1新增查验返回JSON
sw20210223
V3.7.2

整箱做箱任务/docking/package

更新说明sw20210226

...

V3.11.1

新增费用接口


Gavin20231201



推送AI数据接口



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

jsonJSON

其他参数

Y


字段

类型

描述

必填

备注

sourceAppIdString来源appIdN第三方
phoneString手机号N信号旗货代平台如果存在该手机号，为默认为上传人
customerNameString客户上传人N默认为空，标记第三方上传人
hdEmailString货代邮箱N如果存在，则显示，不存在，则通过手机查询平台结果（20200805新增）

hdqq

String货代QQN如果存在，则显示，不存在，则通过手机查询平台结果（20200805新增）

declarationPort

String

申报口岸

N

海关编码

IEPort

String

出境关别

N

洋山：“2248”

外港：“2225”

entyPort

String

离境口岸

N

海关编码

trafName

String

船名

N


voyageNo

String

航次

N


billNo

String

提运单号

N


packNo

String

件数

N


grossWet

String

毛重

N


tradeArea

String

贸易国

N

海关编码

originalCountry

String

运抵国

N

海关编码

distinatePort

String

指运港

N

海关编码

trafModeName

String

运输方式

N

2：水路运输；3：铁路运输；4：公路运输；5：航空运输；默认为2

declareNo

String

报关ID

N

业务编号预留字段

customerNo

String

客户自编号

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


hdRemark

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


String


拼箱标识


N

1=出口拼箱

2=出口整箱

3=进口拼箱

4=进口整箱

5=进口分拨

6=出口自拼箱

7=进口报关

8=出口报关

superviseMode

String

监管仓上传方式

N

JGC/9710/9810/HNCZC


Bool

是否退税

N



String

客户报关类型

N



String

入库单号

N



String

进仓单号

N




进仓件数

N


decContainersJsonArray


List


集装箱箱号


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；

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":""}

}]



出参（Object）


字段

类型

描述

备注

code

int

200=成功


msg

String

接口返回信息


data

json

返回数据：

orderOutNo（外部流水号）

信号旗内部流水号


描述

上传成功以后，返回orderOutNo

...

接口地址

测试URL：http://api.t.baoguan001.com/api/docking/fileUpload

正式URL：http://api.platform.codeflagai.com/api/docking/fileUpload

请求方式post
入参（multipart/form-data）


字段

类型

描述

必填

备注

appId

String

权限令牌

Y

身份标记(分为测试环境与线上环境)

bghId

String

报关行ID

Y

通过接口获取（6 通过货代appId获取报关行列表）

file

File

本地文件

Y

海运报关业务支持：zip，rar格式；一套单证需要压缩；

orderOutNo

String

外部订单号

Y

业务编号

isReload

String

重传标记

Y

“2” 表示重传，其他暂无意义

hdUserName

String

货代联系人

N

页面显示

hdRemarkString货代备注N
hdEmailString货代邮箱N如果存在，则显示，不存在，则通过手机查询平台结果

hdqq

String货代QQN如果存在，则显示，不存在，则通过手机查询平台结果

declareTime

String

要求报关日期

Y

yyyy-MM-dd HH：mm：ss (大于当前时间1小时)

trafModeName

String

运输方式

N

2：水路运输；3：铁路运输；4：公路运输；5：航空运输；默认为2


出参（Object）


字段

类型

描述

备注

code

int

200=成功


msg

String

接口返回信息


data

json

返回数据

信号旗内部流水号


描述

1.2 base64上传接口

...

管理员配置好，报关行合作伙伴后，即可产生报关行列表。货代系统可以直接调用此货代对于的报关行列表

...

接口地址

测试URL：http://api.t.baoguan001.com/api/docking/fileBase64Upload

正式URL：http://api.platform.codeflagai.com/api/docking/fileBase64Upload

请求方式post
入参（JSON）


hdUserName货代联系人hdRemark货代备注hdEmailString货代邮箱N如果存在，则显示，不存在，则通过手机查询平台结果hdqqString货代QQN如果存在，则显示，不存在，则通过手机查询平台结果declareTime要求报关日期

字段

类型

描述

必填

备注

appId

String

权限令牌

Y

身份标记(分为测试环境与线上环境)

bghId

String

报关行ID

Y

通过接口获取（6 通过货代appId获取报关行列表）

fileName

String

文件名称

Y

海运报关业务支持：zip，rar，pdf等

base64File
Stringbase64文件Y
Base64.getEncoder().encodeToString(Paths.get(filePath))

orderOutNo

String

外部订单号

Y

业务编号

isReload

String

重传标记

Y

“2” 表示重传，其他暂无意义

declareTime

String

要求报关日期

N

页面显示

Y

yyyy-MM-dd HH：mm：ss (大于当前时间1小时)             已更新至parameter参数中

trafModeName

String

运输方式

N

2：水路运输；3：铁路运输；4：公路运输；5：航空运输；默认为2   已更新至parameter参数中

parameter

JSON

其他参数

Y


字段

类型

描述

必填

备注

sourceAppIdString
来源appId

Y

yyyy-MM-dd HH：mm：ss (大于当前时间1小时)

出参（Object）

字段

类型

描述

备注

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

...

字段

...

类型

...

描述

...

必填

...

备注

...

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

...

通知时间

...

yyyy-MM-dd HH:mm:ss

...

customMaster

...

String

...

申报地海关

...

entryId

...

String

...

报关单编号

...

dDate

...

申报日期

...

yyyy-MM-dd

...

cusCiqNo

...

关检关联号

...

ieDate

...

进出口日期

...

yyyy-MM-dd

...

cusRetSeqNo

...

包装种类

Image Removed

描述：红框部分为回执号

...

字段

...

类型

...

描述

...

备注

...

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

...

字段

...

描述

...

必填

...

备注

...

appId

...

String

...

权限令牌

...

Y

...

身份标记

...

fileUrl

...

taskId

...

bghId

...

outNo

...

billNo

...

shipName

...

voyage

...

iEPort

...

外港海关，洋山港区，吴淞

...

iEPortCode

...

出境关别代码

...

2225-外港海关

2248-洋山港区

2202-吴淞

...

declarationPort

...

申报地海关

...

declarationPortCode

...

申报地海关代码

...

2229-航交办

2231-洋山市内

...

entyPort

...

离境口岸

...

entyPortCode

...

离境口岸代码

...

310701-外高桥

311002-洋山港

...

distinatePort

...

distinatePortCode

...

containerId

...

containerMd

...

20GP，40GP ，40HQ，45GP，45HQ

...

containerWt

...

containerMdCode

...

packNo

...

件数

...

grossWet

...

毛重

...

orders

...

字段类型描述必填
StringorderOutNo业务编号Y
String
newBillNo
新提单号N

...

字段

...

类型

...

描述

...

备注

...

code

...

int

...

200=成功

...

msg

...

String

...

接口返回信息

...

data

...

JSON

...

示例

入参出参
{
"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 表示失败

N第三方
phoneString手机号N信号旗货代平台如果存在该手机号，为默认为上传人
customerNameString客户上传人N默认为空，标记第三方上传人
hdEmailString货代邮箱N如果存在，则显示，不存在，则通过手机查询平台结果（20200805新增）

hdqq

String货代QQN如果存在，则显示，不存在，则通过手机查询平台结果（20200805新增）

declarationPort

String

申报口岸

N

海关编码

IEPort

String

出境关别

N

洋山：“2248”

外港：“2225”

entyPort

String

离境口岸

N

海关编码

trafName

String

船名

N


voyageNo

String

航次

N


billNo

String

提运单号

N


packNo

String

件数

N


grossWet

String

毛重

N


tradeArea

String

贸易国

N

海关编码

originalCountry

String

运抵国

N

海关编码

distinatePort

String

指运港

N

海关编码

trafModeName

String

运输方式

N

2：水路运输；3：铁路运输；4：公路运输；5：航空运输；默认为2

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


hdRemark

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 (大于当前时间1小时) 

mergeType


String


拼箱标识


N

1=出口拼箱

2=出口整箱

3=进口拼箱

4=进口整箱

5=进口分拨

6=出口自拼箱

7=进口报关

8=出口报关

superviseMode

String

监管仓上传方式

N

JGC/9710/9810/HNCZC

decContainersJsonArray


List


集装箱箱号


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 Added



出参（Object）


字段

类型

描述

备注

code

int

200=成功


msg

String

接口返回信息


data

String

返回数据

信号旗内部流水号


1.3进口文件上传接口

接口地址

测试URL：http://api.t.baoguan001.com/api/docking/uploadImport

正式URL：http://api.platform.codeflagai.com/api/docking/uploadImport

请求方式post
入参（JSON）


字段

类型

描述

必填

备注

appId

String

权限令牌

Y

身份标记(分为测试环境与线上环境)

bghId

String

报关行ID

Y

报关行ID

fileUrl

String

网络下载地址

Y

http://allseeing-rar.oss-cn-shanghai.aliyuncs.com/A1908010846

5575164/1564620414.zip

海运报关业务支持：zip，rar格式；

orderOutNo

String

外部订单号

Y

业务编号

settlementNo

String

结算编号

N

结算编号

isReload

String

重传标记

Y

“2” 表示重传，其他暂无意义（暂不支持重传）

customerNo

String

客户自编号

N

客户自编号

receivingRemark

String

接单备注

N

接单备注

isNotice

Bool

是否等通知报关

N

是否等通知报关

trafName

String

船名

N

船名

voyageNo

String

航次

N

航次

billNo

String

提运单号

N

提运单号

trafModeName

String

运输方式

N

海运  / 空运  /  公路 / 铁路

receiptUserName

String

客户名称

Y

客户名称

receivingRemark

String

接单备注

N

接单备注

packNo

String

件数

N

件数

grossWet

String

毛重

N

毛重

tradeName

String

境内收发货人

N

境内收发货人

tradeNameCode

String

境内10位编码

N

境内10位编码

tradeNameDutyNo

String

境内18位编码

N

境内18位编码

expectedOrderExchangeTime

String

预计换单时间

N

预计换单时间

practicalOrderExchangeTime

String

实际换单时间

N

实际换单时间

parameter

JSON

其他参数

N


字段

类型

描述

必填

备注


















出参（Object）


字段

类型

描述

备注

code

int

200=成功


msg

String

接口返回信息


data

String

返回数据：

信号旗内部流水号


描述




2.单一放行数据接口 

接口地址

调试url：http://api.t.baoguan001.com/api/docking/bghListreceiptsea

正式url：http://api.platform.codeflagai.com/api/docking/bghListreceiptsea

请求方式post
入参（DataForm）入参（json）


字段

类型

描述

必填

备注

appIdorderOutNo

String

权限令牌业务流水号

Y身份标记

唯一标记

dataJson

json

申报后json


详见附件1：《单一标准数据》


出参


字段

类型

描述

备注

code

int

200=成功


msg

String

接口返回信息


data

List<Object>json

字段

返回数据

类型



描述bghID报关行idbghName报关行名称
描述

报关行列表，需要在相应的开放平台系统中绑定。详细咨询客服

示例
Image Removed

Attribute

7 撤回

撤回

接口：


3.海关回执接口

出参字段类型描述备注
接口地址

调试url：http://api.t.baoguan001.com/api/docking/recallreceiptsingle

正式url：http://api.platform.codeflagai.com/api/docking/recallreceiptsingle

请求方式post
入参（DataForm）入参（json）


字段

类型

描述

必填

备注

appId

orderOutNo

String

货代身份标记

业务流水号

Y

身份标记

唯一标记

orderOutNo

paramJson

String

json

业务编号

回执json

Y

phone


字段

类型

String

描述

手机号

必填

N

备注

hdUserName

channel

String

操作人名称
回执代码
Y


参见《附件3：海关状态》

note

String

回执说明



noticeDate

接口地址

在信号旗中配置回调接口，接口地址回调方提供。

请求方式post
入参（json）

字段

类型

必填

描述

action

String

Y

syn_status (同步状态)

orderOutNo

String

Y

业务流水号

code

int

Y

参见《附件4：信号旗订单状态》

msg

String

Y

String

code

int

200=成功

msg

String

接口返回信息

data

描述

撤回

示例

二、数据输出（XHQ >> ERP）

在后台配置回调接口地址,需求对方提供;

1.同步单证状态

通知时间


yyyy-MM-dd HH:mm:ss

customMaster

String

申报地海关



entryId

String

报关单编号



dDate
String
申报日期

yyyy-MM-dd
cusCiqNo
String
关检关联号

列如:E20200000410351727
ieDate
String
进出口日期

yyyy-MM-dd
cusRetSeqNo
String回执号

包装种类


Image Added

描述：红框部分为回执号


出参

...

当前字段的坐标

...

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

...

件数

...

wrapType

...

包装种类

...

grossWet

...

毛重(Kg)

...

netWt

...

净重(Kg)

...

tradeArea

...

贸易国别

...

goodsPlace

...

货物存放地

...

entyPort

...

离境口岸

...

entryType

...

报关单类型: 有纸报关,无纸带清单报关,有纸带清单报关,通关无纸化,无纸报关

...

noteS

...

备注

...

字段

...

类型

...

必填

...

描述

...

state

...

boolean

...

Y

...

成功：true

失败：false

...

msg

...

String

...

N

...

1.获取海关回执数据（所有的历史状态记录）

       描述：如果对方服务在重启或者长时间未获取到，可以通过该接口来查询数据；数据有效期90天；

调试url：http
接口地址


字段

类型

必填

描述

state

备注

booleancode

Y

成功：true

失败：falseint

200=成功


msg

String

N接口返回信息

描述


data

2.推送数据接口

...

在信号旗中配置回调接口，接口地址回调方提供。

...

字段

类型

必填

描述

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.海关回执接口

...

在信号旗中配置回调接口，接口地址回调方提供。

...

字段

...

类型

...

必填

...

描述

...

action

...

String

...

Y

...

single_receipt(海关回执)

...

orderOutNo

...

String

...

N

...

业务流水号

...

billNo

...

String

...

N

...

提运单号

...

paramJson

...

json

...

Y

回执json

...

字段

...

类型

...

必填

...

描述

...

channel

...

String

...

参见《附件3：海关状态》

...

note

...

String

...

海关描述

...

noticeDate

...

String

...

海关时间

...

customMaster

...

String

...

主管海关

...

entryId

...

String

...

海关编码

...

cusCiqNo

...

releaseNotice

...

String

...

N

...

放行通知书文件地址

...

customsDeclaration

...

String

...

N

...

报关单文件地址

...

examinePdf

...

字段

...

类型

...

必填

...

描述

...

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 

...

string

...

拼箱标识 ：1 （拼箱）；2（自拼箱）；

...

Attribute 对象：

...

json

返回数据



描述


4.上传拼箱关系接口 (已废弃)

接口地址

调试url：http://api.t.baoguan001.com/api/docking/lcl

正式url：http://api.platform.codeflagai.com/api/docking/lcl

请求方式post
入参（json）


字段

类型

描述

必填

备注

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
入参（json）


字段

类型

描述

必填

备注

appId

String

权限令牌

Y

身份标记

fileUrl
String随附文档N图片地址 (图片地址和订单列表必填一个，不能两者都为空)
taskId
String拼箱任务IDN新增成功后返回的ID，修改时必填
bghId
String报关行IDY
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


lclFlagCodeString拼箱标识代码N是为1，否为0；（是表示拼箱，否表示整箱）
packNo
String
件数
N
grossWet
String
毛重
N
businessTypeString业务类型Nsea =海运出口 ；  air=空运出口；不传默认海运出口
orders
List 订单列表N


字段类型描述必填
StringorderOutNo业务编号Y
String
newBillNo
新提单号N
String
hdPackNo
件数N
String
hdGrossWet
毛重N



出参


字段

类型

描述

备注

code

int

200=成功


msg

String

接口返回信息


data

JSON




描述

示例


入参出参
{
"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获取报关行列表

管理员配置好，报关行合作伙伴后，即可产生报关行列表。货代系统可以直接调用此货代对于的报关行列表

接口：

接口地址

调试url：http://api.t.baoguan001.com/api/docking/bghList

正式url：http://api.platform.codeflagai.com/api/docking/bghList

请求方式post
入参（json）


字段

类型

描述

必填

备注

appId

String

权限令牌

Y

身份标记


出参


字段

类型

描述

备注

code

int

200=成功


msg

String

接口返回信息


data

List<Object>


字段
类型
描述
bghID报关行id
bghName报关行名称




描述

报关行列表，需要在相应的开放平台系统中绑定。详细咨询客服

示例
Image Added


Attribute



7 撤回

撤回

接口：

接口地址

调试url：http://api.t.baoguan001.com/api/docking/recall

正式url：http://api.platform.codeflagai.com/api/docking/recall

请求方式post
入参（json）


字段

类型

描述

必填

备注

appId

String

货代身份标记

Y

身份标记

orderOutNoString业务编号Y
phoneString手机号N
hdUserNameString操作人名称Y


出参


字段

类型

描述

备注

code

int

200=成功


msg

String

接口返回信息


data






描述

撤回

示例



8 批量解冻

批量解冻接口

接口：

必填描述orderOutNomsgNdatadata.rows根据action查询返回相应的数据集合返回字符串，如果是明文，字符串里面是一个集合；
接口地址

调试url：http://api.t.baoguan001.com/api/docking/actionDataRowunFrozen

正式url：http正式url：http://api.platform.codeflagai.com/api/docking/actionDataRowunFrozen

请求方式post入参（json）
入参（json）


描述

字段

类型

描述

必填

备注

actionappId

String

Y

single_receipt(海关回执)

appId货代身份标记

Y

身份标记

orderOutNosList<String>业务编号Y
phoneString手机号Y
orderOutNohdUserNameString

Y

业务流水号操作人名称N
noticeFlag
Boolean解冻标记Ytrue（解冻），false为冻结
remarkString备注N冻结、解冻备注或原因


出参


字段

类型

描述

备注

code

int

200=成功


msg

String

Y

外部流水号

接口返回信息


data

List<Object>

 失败集合


字段

类型

描述

必填

String

orderOutNo

业务编号
Y
String

errMsg

错误信息
Y



描述

2.获取检验稿

...

如果有不能解冻的订单会返回错误信息，能解冻订单会解冻但不会提示。

示例



9 订单费用确认

确认信号旗订单费用

接口：

出参字段类型必填描述codemsg说明data示例Image Removed
接口地址

调试url：http://api.t.baoguan001.com/api/docking/getCheckDraftfeeConfirm

正式url：http://api.platform.codeflagai.com/api/docking/getCheckDraftfeeConfirm

请求方式post
入参（json）入参（JSON）


描述Y（二选一）token

字段

类型

描述

必填

备注

appId

String

货代身份标记

货代appIdY

身份标记

String报关行tokenorderOutNoString业务编号Y
feeId业务流水号int
费⽤id
Y
费⽤id，标识唯⼀费⽤
feeName
String
费用名称

int

200=成功

N费用名称；注：报关费、联单费无需确认
phoneString手机号Y
hdUserNameString
操作人名称
N

confirmFlag
Boolean

...

必填描述说明
确认标记
接口地址

调试url：http://api.t.baoguan001.com/api/docking/getCustomsClearance

正式url：http://api.platform.codeflagai.com/api/docking/getCustomsClearance

请求方式post
入参（json）

字段

类型

必填

描述

appId

String

Y

orderOutNo

String

Y

业务流水号Ytrue（确认），false为拒绝，需要填写拒绝原因
reasonString备注N拒绝，需要填写拒绝原因


出参


字段

类型

描述

备注

code

int

200=成功


msg

String

Y

接口返回信息



data

描述

Image Removed

...

接口地址

调试url：http://api.t.baoguan001.com/api/docking/getReleaseNotice

正式url：http://api.platform.codeflagai.com/api/docking/getReleaseNotice确认信号旗订单费用；报关费、联单费无需确认

示例




二、数据输出（XHQ >> ERP）

在后台配置回调接口地址,需求对方提供;

1.同步单证状态

接口地址

在信号旗中配置回调接口，接口地址回调方提供（注意：该地址只能提供一个，具体业务根据action字段区分）。

请求方式post
入参（json）


字段

类型

必填

描述

appIdaction

String

Y

syn_status (同步状态)

orderOutNo

String

Y

业务流水号

code

int

Y

参见《附件4：信号旗订单状态》

msg

String

Y



出参


字段

类型

必填

描述

state

codeboolean

Y

int成功：true

200=成功失败：false

msg

String

YN

说明

data



描述

Image Removed

...


2.

...

推送数据接口

调试url：http://api.t.baoguan001.com/api/docking/package

正式url：http://api.platform.codeflagai.com/api/docking/package
接口地址

调试url：http://api.t.baoguan001.com/api/docking/getCheckRows

正式url：http://api.platform.codeflagai.com/api/docking/getCheckRows

在信号旗中配置回调接口，接口地址回调方提供（注意：该地址只能提供一个，具体业务根据action字段区分）。

请求方式post
入参（json）


字段

类型

必填

描述

appIdaction

String

Y

typeStringNcheck ：标识区分查验描述

send_data (制单完成数据)

sendBgh_data (报关行发送数据)

single_data (单一放行数据)

orderOutNo

String

Y

业务流水号

dataJson

json

N

详见附件1：《单一标准数据》


出参接口地址


字段

类型

必填

描述

state

codeboolean

int

200=成功Y

成功：true

失败：false

msg

String

Y

说明

data

List

多个下载地址

根据type 类型返回，不传type 返回值结构版本1，check返回值结构版本2

描述
版本1
Image Removed
版本2
Image Removed

推送AI数据接口

四. 报关行与信号旗对接 (ERP->报关行)

1. 整箱做箱任务

N



描述


3.海关回执接口

StringcontainerSid箱封号Nint拼箱标识
接口地址

在信号旗中配置回调接口，接口地址回调方提供（注意：该地址只能提供一个，具体业务根据action字段区分）。

请求方式post
入参（DataForm）入参（json）


权限令牌身份标记String必填voyage航次billNo提单号N件数N毛重NdecContainersJsonArrayJsonArray集装箱备注containerId集装箱号YcontainerMd箱规格YNcontainerMdCode箱规格代码N

字段

类型

必填

描述

必填

备注

appId

String

action

String

Y

single_receipt(海关回执) ， single_receipt_I(进口海关回执)

orderNo

String

Y

信号旗系统流水号

orderOutNo

String

业务编号Y订单的身份msg

N

业务流水号

billNo

String

N

提运单号

paramJson

json

Y

回执json

字段

类型

必填

描述

channel

shipName

String

船名N


参见《附件3：海关状态》

note

String


海关描述

N

noticeDate

String


海关时间

customMaster

packNo

String


主管海关

entryId

grossWet

String


海关编码

cusCiqNo
String

统一编号

releaseNotice

String

N

字段类型描述必填

放行通知书文件地址（出口）

customsDeclaration

String

N

报关单文件地址（出口）

authorizationLetter

String

N

报关委托书地址（进出口）

examinePdf
必须为以下值：20GP，40GP ，40HQ，45GP，45HQ
String
containerWt
箱自重
N查验通知书(口岸查验通知、报关单查验通知......)（进出口）
allowLifting
String
N
准予提离通知书地址（进口）



出参


字段

类型

必填

描述

state

lclFlag
StringgoodsNo商品项号关系N格式：1,2,3
出参

boolean

Y

0:非拼箱； 1:拼箱

成功：true

失败：false

msg

String

N



描述


4.订单消息通知

备注200=成功
接口地址

在信号旗中配置回调接口，接口地址回调方提供。

请求方式post
入参（json）


字段

类型

必填

描述

action

String

Y

msg_notice(订单消息通知)

orderOutNo

String

Y

业务流水号

code

int

N

消息状态码

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

请求方式post
入参（DataForm）

Y

 通知消息


出参


字段

类型

必填

描述

state

boolean

Y

成功：true

失败：false

msg

String

N



描述

待确认###

5.推送进口保税数据接口核注清单

接口地址

在货代配置回调接口，接口地址回调方提供。

请求方式post
入参（json）


字段类型

描述

必填
备注
描叙
appId
orderNoString
权限令牌
Y
身份标记
系统流水号
msg
orderOutNoString

消息内容

Y
《消息体》
业务编号
sessionType








BussinessData
String会话类型Y

默认是：20

messageType
String
消息类型Y《消息类型》orderOutNoString业务编号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发送消息，给报关行的客户。直接发送到报关的想要的聊天记录中，并提供消息即使提醒

五. 信号旗推送消息给报关行 (报关行->信号旗)

在后台配置回调接口地址,需求对方提供;

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）

字段

类型

必填

描述

action

String

Y

send_data (制单完成数据)

sendBgh_data (报关行发送数据)

single_data (单一放行数据)

orderOutNo

String

Y

业务流水号

dataJson

json

N

详见附件1：《单一标准数据》
JsonY

https://single-xml-dev.oss-cn-shanghai.aliyuncs.com/doc/doc/%E6%8E%A8%E9%80%81%E8%BF%9B%E5%8F%A3%E4%BF%9D%E7%A8%8E%E6%A0%B8%E6%B3%A8%E6%B8%85%E5%8D%95%E6%95%B0%E6%8D%AE%E6%8E%A5%E5%8F%A3.pdf



https://single-xml-dev.oss-cn-shanghai.aliyuncs.com/doc/doc/%E6%A0%B8%E6%B3%A8%E6%B8%85%E5%8D%95%E6%95%B0%E6%8D%AE.json


出参



描述

待确认###

6.推送订单费用接口

接口地址

信号旗中配置回调接口地址，接口地址回调方提供（注意：该地址只能提供一个，具体业务根据action字段区分）。

请求方式post
入参（json）


字段

类型

必填

描述

action

String

Y

order_fee(订单费用)

orderOutNo

String

Y

业务流水号

billNo

String

N

提运单号

feeId

int

Y

费⽤id，标识唯⼀费⽤

feeOpt

String

Y

操作：1--新增；2--修改；3--删除

feeName

String

Y

费⽤名称；

feeType

int

Y

收付：1--应收；2--应付

feeAcctType

int

Y

费⽤类型：1--普通费⽤；2--代收代付

feeAmount

decimal

Y

费用金额

feeCurrency

String

Y

币制

goodsNumber

Integer

N

商品项数

orderOperator

String

Y

货代联系人（订单操作人）

feeRemark

String

N

备注


出参


字段

类型

必填

描述

state

boolean

Y

成功：true

失败：false

msg

String

N



描述


7.进口流程节点推送数据接口

接口地址

在后台配置外部地址url，接口地址外部提供。

请求方式

Post

参数（json）


action

String

Y

node_data_I(进口流程节点)

orderOutNo

String

N

业务流水号

orderNo

String

Y

系统流水号

StatusCode

String

Y

操作code; 30=进口接单，31=进口锁单，32=进口发单

StatusName

String

Y

操作名

StatusDate

String

Y

操作日志

StatusBy

String

Y

操作人

CustomerName

String

Y

客户名称


出参


字段

类型

必填

描述

state

boolean

Y

成功：true

失败：false

msg

String

N



描述


8.进口合作方数据对接推送数据接口

接口地址

在后台配置外部地址url，接口地址外部提供。

请求方式

Post

参数（json）


action

String

Y

send_data_I (报关行发送数据) 

single_data_I (海关放行数据) 

orderOutNo

String

N

业务流水号

orderNo

String

Y

系统流水号

billNo

String

Y

提运单号

dataJson

JSON

Y

报关单数据参考下面文档


出参


字段

类型

必填

描述

state

boolean

Y

成功：true

失败：false

msg

String

N



描述


View file
name合作方详细数据推送数据说明240422.docx
height250


三、数据获取（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

业务流水号


出参


字段

类型

必填

描述

code

int

200=成功


orderOutNo

String

Y

外部流水号

msg

String

N


data




data.rows

String

根据action查询返回相应的数据集合

返回字符串，如果是明文，字符串里面是一个集合；


描述


2.获取检验稿

       描述：通过外部流水号+appId，获取校验稿url

接口地址

调试url：http://api.t.baoguan001.com/api/docking/getCheckDraft

正式url：http://api.platform.codeflagai.com/api/docking/getCheckDraft

请求方式post
入参（json）


字段

类型

必填

描述

appId

String

Y（二选一）

货代appId

tokenString报关行token

orderOutNo

String

Y（二选一）

业务流水号

billNo

customerNo

String

String

 提运单号

客户自编号


出参


字段

类型

必填

描述

code

int

200=成功


msg

String

Y

说明

data





示例

Image Added

3. 获取报关单

接口地址

调试url：http://api.t.baoguan001.com/api/docking/getCustomsClearance

正式url：http://api.platform.codeflagai.com/api/docking/getCustomsClearance

请求方式post
入参（json）


字段

类型

必填

描述

appId

String

Y


orderOutNo

String

Y

业务流水号


出参


字段

类型

必填

描述

code

int

200=成功


msg

String

Y

说明

data





描述

Image Added



4. 获取放行通知书

接口地址

调试url：http://api.t.baoguan001.com/api/docking/getReleaseNotice

正式url：http://api.platform.codeflagai.com/api/docking/getReleaseNotice

请求方式post
入参（json）


字段

类型

必填

描述

appId

String

Y


orderOutNo

String

Y

业务流水号


出参


字段

类型

必填

描述

code

int

200=成功


msg

String

Y

说明

data





描述

Image Added

5. 获取查验通知书

接口地址

调试url：http://api.t.baoguan001.com/api/docking/getCheckRows

正式url：http://api.platform.codeflagai.com/api/docking/getCheckRows

请求方式post
入参（json）


字段

类型

必填

描述

appId

String

Y


typeStringNcheck ：标识区分查验描述

orderOutNo

String

Y

业务流水号


出参


字段

类型

必填

描述

code

int

200=成功


msg

String

Y

说明

data

List

多个下载地址

根据type 类型返回，不传type 返回值结构版本1，check返回值结构版本2


描述
版本1
Image Added
版本2
Image Added


6. 获取报关委托书

接口地址

调试url：http://api.t.baoguan001.com/api/docking/getAuthorizationLetter

正式url：http://api.platform.codeflagai.com/api/docking/getAuthorizationLetter

请求方式post
入参（json）


字段

类型

必填

描述

appId

String

Y


orderOutNo

String

Y

业务流水号


出参


字段

类型

必填

描述

code

int

200=成功


msg

String

Y

说明

data

String




描述

Image Added



四. 客户系统与信号旗对接 (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

身份标记

orderOutNoString业务编号Y订单的身份
msgString


字段类型描述必填
shipName
String船名N
voyage
String航次N
billNo
String提单号N
packNo
String
件数N
grossWet
String
毛重N
decContainersJsonArrayJsonArray集装箱N


字段类型描述必填备注
String
containerId
集装箱号Y
String
containerMd
箱规格Y必须为以下值：20GP，40GP ，40HQ，45GP，45HQ
String
containerWt
箱自重N
String
containerMdCode
箱规格代码N
String
containerSid
箱封号N
intlclFlag拼箱标识Y0:非拼箱； 1:拼箱
StringgoodsNo商品项号关系N格式：1,2,3




出参


字段

类型

描述

备注

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

请求方式post
入参（DataForm）


字段

类型

描述

必填

备注

appId

String

权限令牌

Y

身份标记

msg

String

消息内容

Y

《消息体》

sessionTypeString会话类型Y

默认是：20

messageType
String
消息类型Y《消息类型》
orderOutNoString业务编号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发送消息给报关行。直接发送到报关的想要的聊天记录中，并提供消息即使提醒


五. 信号旗推送消息给对接方 (信号旗->对接方)

在后台配置回调接口地址,需求对方提供;

1.同步单证状态

接口地址

在信号旗中配置回调接口，接口地址回调方提供。

请求方式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

字段

类型

必填

描述

channel

String


参见《附件3：海关状态》

note

String


海关描述

noticeDate

String


海关时间

customMaster

String


主管海关

entryId

String


海关编码

cusCiqNo
String
统一编号

releaseNotice

String

N

放行通知书文件地址

customsDeclaration

String

N

报关单文件地址

examinePdf
StringN查验通知书(口岸查验通知、报关单查验通知......)



出参


字段

类型

必填

描述

state

boolean

Y

成功：true

失败：false

msg

String

N



描述





六. 信号旗推送消息失败结果


1.  推送失败清单查询

接口地址

调试url：http://api.t.baoguan001.com/api/docking/failedPushQuery

正式url：http://api.platform.codeflagai.com/api/docking/failedPushQuery

请求方式post
入参（JSON）


字段

类型

描述

必填

备注

bghId

String

报关行id

Y

身份标记

type

String

类型（报关行：“BGH”）

Y


cutoffTime
String截止时间（例："2022-06-07 16:33:28"）

N



出参


字段

类型

必填

描述

code

int

Y

200=成功

msg

String

Y

接口返回信息

data

List

Y


字段类型必填描述
orderNoStringY系统流水号
orderOutNoStringY业务编号

见下面示例


描述

示例：

入参出参

{
    "type":"BGH",
    "bghId":"D6A8E64D399546CD9B60E1982B61A699",
    "cutoffTime":"2022-06-07 16:33:28"
}

{
    "code": 200,
    "msg": "成功",
    "data": [
        {
            "orderNo": "A22060714485160455",
            "orderOutNo": "2022060702"
        },
        {
            "orderNo": "A22060714485586949",
            "orderOutNo": "2022060706"
        }
    ],
    "foot": {
        "operationTime": "2022-06-07 19:39:08"
    }
}



2. 系统流水号查询失败记录

接口地址

调试url：http://api.t.baoguan001.com/api/docking/queryFailedPush

正式url：http://api.platform.codeflagai.com/api/docking/queryFailedPush

请求方式post
入参（JSON）


字段

类型

描述

必填

备注

bghId

String

报关行id

Y

身份标记

type

String

类型（报关行：“BGH”）

Y


orderNo

String系统流水号

Y


cutoffTime
String截止时间（例："2022-06-07 16:33:28"）

N

带上截止时间可以确保查询和确认清理的数据一致


出参


字段

类型

必填

描述

code

int

Y

200=成功

msg

String

Y

接口返回信息

data

List

Y


字段类型必填描述
orderNoStringY系统流水号
actionStringY推送类型
orderOutNoStringY业务编号
paramJsonStringY推送内容
requestBodyStringY客户返回消息
createTimeStringY推送时间

见下面示例


描述

示例：

入参出参

{
    "type":"BGH",
    "bghId":"D6A8E64D399546CD9B60E1982B61A699",
    "orderNo":"A22060714485160455",
    "cutoffTime":"2022-06-07 22:18:28"
}

{
    "code": 200,
    "msg": "成功",
    "data": [
        {
            "orderNo": "A22060714485160455",
            "action": "sendMakeInvo_data",
            "orderOutNo": "2022060702",
            "paramJson": "{\"containerNo\":\"\",\"orderNo\":\"A22060714485160455\",\"orderOutNo\":\"2022060702\",

\"action\":\"sendMakeInvo_data\",\"hdCoId\":\"153\",\"billNo\":\"S521345\"}",
            "requestBody": "",
            "createTime": "2022-06-07 17:17:29"
        },
        {
            "orderNo": "A22060714485160455",
            "action": "sendMakeInvo_data",
            "orderOutNo": "2022060702",
            "paramJson": "{\"containerNo\":\"\",\"orderNo\":\"A22060714485160455\",\"orderOutNo\":\"2022060702\",

\"action\":\"sendMakeInvo_data\",\"hdCoId\":\"153\",\"billNo\":\"\"}",
            "requestBody": "",
            "createTime": "2022-06-07 17:20:55"
        }
    ],
    "page": null,
    "foot": {
        "operationTime": "2022-06-08 09:56:16"
    }
}



3. 批量系统流水号查询失败记录

接口地址

调试url：http://api.t.baoguan001.com/api/docking/queryBatchFailedPush

正式url：http://api.platform.codeflagai.com/api/docking/queryBatchFailedPush

请求方式post
入参（JSON）


字段

类型

描述

必填

备注

bghId

String

报关行id

Y

身份标记

type

String

类型（报关行：“BGH”）

Y


orderNos

List<String>系统流水号

Y

如果数量太多，请多次查询，每次最好不超过100个
cutoffTime
String截止时间（例："2022-06-07 16:33:28"）

N

带上截止时间可以确保查询和确认清理的数据一致


出参


字段

类型

必填

描述

state

code

boolean

int

Y

成功：true

200=成功

失败：false

msg

String

N

Y

描述

接口返回信息

...

入参（json）

data

接口地址

在信号旗中配置回调接口，接口地址回调方提供。

请求方式post

List

Y


字段类型必填描述
orderNoStringY系统流水号
actionStringY
single_receipt(海关回执)
推送类型
orderOutNoString
N
Y
业务流水号
业务编号
billNo
paramJsonString
N
Y
提运单号
推送内容
paramJson
requestBody
json
StringY
回执json
客户返回消息
字段
createTime
类型
String
必填
Y
描述
推送时间
channel

见下面示例

String


描述
参见《附件3：海关状态》

示例：

note
入参
String
出参

海关描述

noticeDate

String

海关时间

customMaster

String

主管海关

entryId

String

海关编码

cusCiqNo
String统一编号

releaseNotice

String

N

放行通知书文件地址

customsDeclaration

String

N

报关单文件地址

examinePdf
StringN查验通知书(口岸查验通知、报关单查验通知......)出参

字段

类型

必填

描述

state

boolean

Y

成功：true

失败：false

msg

String

N

描述

4.电子底账日期推送

...

在信号旗中配置回调接口，接口地址回调方提供。

...

字段

...

类型

...

必填

...

描述

...

action

...

String

...

Y

...

electronic_ledger

...

orderNo

...

orderOutNo

...

String

...

Y

...

业务流水号

...

billNo

...

String

...

N

...

提运单号

...

hdCoId

...

dataJson

...

json

...

Y

回执json

字段

类型

必填

描述

qcPassId
StringY电子底账编号
validDate
StringY电子底账有效结束时间
signDate
StringY电子底账有效开始时间
declareNo
StringY报关ID

...

字段

...

类型

...

必填

...

描述

...

state

...

boolean

...

Y

...

成功：true

失败：false

...

msg

...

String

...

N

...

附件

...

{
    "type":"BGH",
    "bghId":"D6A8E64D399546CD9B60E1982B61A699",
    "orderNos":["A22060714485160455","A22060714485586949"],
    "cutoffTime":"2022-06-07 22:18:28"
}

{
    "code": 200,
    "msg": "成功",
    "data": [
        {
            "orderNo": "A22060714485160455",
            "action": "sendMakeInvo_data",
            "orderOutNo": "2022060702",
            "paramJson": "{\"containerNo\":\"\",\"orderNo\":\"A22060714485160455\",\"orderOutNo\":\"2022060702\",

\"action\":\"sendMakeInvo_data\",\"hdCoId\":\"153\",\"billNo\":\"S51252\"}",
            "requestBody": "",
            "createTime": "2022-06-07 17:17:29"
        },
        {
            "orderNo": "A22060714485160455",
            "action": "sendMakeInvo_data",
            "orderOutNo": "2022060702",
            "paramJson": "{\"containerNo\":\"\",\"orderNo\":\"A22060714485160455\",\"orderOutNo\":\"2022060702\",

\"action\":\"sendMakeInvo_data\",\"hdCoId\":\"153\",\"billNo\":\"\"}",
            "requestBody": "",
            "createTime": "2022-06-07 17:20:55"
        }
    ],
    "page": null,
    "foot": {
        "operationTime": "2022-06-08 09:56:16"
    }
}



4. 推送失败清单确认（清理）

接口地址

调试url：http://api.t.baoguan001.com/api/docking/failedPushConfirm

正式url：http://api.platform.codeflagai.com/api/docking/failedPushConfirm

请求方式post
入参（JSON）


字段

类型

描述

必填

备注

bghId

String

报关行id

Y

身份标记

type

String

类型（报关行：“BGH”）

Y


orderNosList<String>系统流水号

Y


cutoffTime
String截止时间（例："2022-06-07 16:33:28"）

N

带上截止时间可以确保查询和确认清理的数据一致


出参


字段

类型

描述

备注

code

int

200=成功


msg

String

接口返回信息


data

int

更新数量



描述

示例：

入参出参

{
    "type":"BGH",
    "bghId":"D6A8E64D399546CD9B60E1982B61A699",
    "orderNos":["A22060714485586949","A22051713521716668"],
    "cutoffTime":"2022-06-07 14:49:50"
}

{
    "code": 200,
    "msg": "成功",
    "data": 1,
    "foot": {
        "operationTime": "2022-06-07 19:33:28"
    }
}




七. 合作方最终数据回推信号旗


接口地址

调试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

说明:

http://single-xml-dev.oss-cn-shanghai.aliyuncs.com/doc/doc/%E8%AF%A6%E7%BB%86%E6%95%B0%E6%8D%AE%E6%A0%BC%E5%BC%8F_1.pdf

附件2：回调接口类型

syn_status (同步状态)

...