...

接口地址

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

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；
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/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” 表示重传，其他暂无意义

~~declareTime~~

~~String~~

~~要求报关日期~~

Y

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

~~trafModeName~~

~~String~~

~~运输方式~~

N

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

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

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

}]

出参（Object）

字段	类型	描述	备注
code	int	200=成功
msg	String	接口返回信息
data	String	返回数据	信号旗内部流水号

...

接口地址

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

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

expectedOrderExchangeTime

海运 / 空运 / 公路 / 铁路

receiptUserName

String

预计换单时间客户名称

NY

预计换单时间客户名称

practicalOrderExchangeTime

receivingRemark

String

实际换单时间接单备注

N

实际换单时间接单备注parameter

packNo

JSON

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	jsonString	返回数据：	信号旗内部流水号

描述

2.单一放行数据接口

...

接口地址

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

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

请求方式

post入参（DataForm）

入参（json）

字段

类型

描述

必填

备注

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

lclFlagCode

String

拼箱标识代码

N

是为1，否为0；（是表示拼箱，否表示整箱）

packNo

String

件数

N

grossWet

String

毛重

N

businessType

String

业务类型

N

sea =海运出口； air=空运出口；不传默认海运出口

orders

List

订单列表

N

字段	类型	描述	必填
String	orderOutNo	业务编号	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 表示失败

...

接口地址

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

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

请求方式

post入参（DataForm）

入参（json）

字段	类型	描述	必填	备注
appId	String	权限令牌	Y	身份标记

出参

字段

类型

描述

备注

code

int

200=成功

msg

String

接口返回信息

data

List<Object>

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

描述

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

示例

...

接口地址

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

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

请求方式

post入参（DataForm）

入参（json）

字段	类型	描述	必填	备注
appId	String	货代身份标记	Y	身份标记
orderOutNo	String	业务编号	Y
phone	String	手机号	N
hdUserName	String	操作人名称	Y

出参

字段

类型

描述

备注

code

int

200=成功

msg

String

接口返回信息

data

描述

撤回

示例

...

接口地址

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

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

请求方式

post入参（DataForm）

入参（json）

字段	类型	描述	必填	备注
appId	String	货代身份标记	Y	身份标记
orderOutNos	List<String>	业务编号	Y
phone	String	手机号	Y
hdUserName	String	操作人名称	N
noticeFlag	Boolean	解冻标记	Y	true（解冻），false为冻结
remark	String	备注	N	冻结、解冻备注或原因

出参

字段

类型

描述

备注

code

int

200=成功

msg

String

接口返回信息

data

List<Object>

失败集合

字段	类型	描述	必填
String	orderOutNo	业务编号	Y
String	errMsg	错误信息	Y

描述

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

示例

...

接口地址

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

请求方式

post

入参（json）

字段

类型

必填

描述

action

String

Y

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

orderNo

String

Y

信号旗系统流水号

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	报关单文件地址（出口）
authorizationLetter	String	N	报关委托书地址（进出口）
examinePdf	String	N	查验通知书(口岸查验通知、报关单查验通知......)（进出口）
allowLifting	String	N	准予提离通知书地址（进口）

出参

字段

类型

必填

描述

state

boolean

Y

成功：true

失败：false

msg

String

N

描述

...

接口地址

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

请求方式

post

入参（json）

字段	类型	必填	描述
action	String	Y	msg_notice(订单消息通知)
orderOutNo	String	Y	业务流水号
code	int	N	消息状态码
msg	String	Y	通知消息

出参

字段

类型

必填

描述

state

boolean

Y

成功：true

失败：false

msg

String

N

描述

待确认###

5.

...

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

接口地址

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

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

请求方式

post

入参（json）

字段	类型	必填	描叙
orderNo	String	Y	系统流水号
orderOutNo	String	Y	业务编号

flag



BussinessData

StringusedStringextraTypeStringwarningIndexStringtopInteger当前字段位置：纵向坐标顶部距离bottomInteger当前字段位置：纵向坐标底部距离leftInteger当前字段位置：横向坐标左侧距离rightInteger当前字段位置：横向坐标右侧距离heightInteger当前文件高度（px）widthInteger当前文件:宽度 (px)conceptIdIntegerdutyNoStringimgSrcString图片或文件地址sourceFlagStringconceptStrString

TableList 对象

出参

Json

Y

T/F（T：成功，F：失败）messageStringY返回信息data字段类型必填描叙

declarationPort

Attribute

申报地海关

IEPort

Attribute

出境关别

manualNo

Attribute

备案号

contrNo

Attribute

合同协议号

IEDate

Attribute

出口日期

declareDate

Attribute

申报日期

tradeName

Attribute

境内收发货人

overseasConsignor

Attribute

境外收发货人

ownerName

Attribute

生产销售单位

agentName

Attribute

申报单位

billNo

Attribute

提运单号

trafName

Attribute

运输工具名称

voyageNo

Attribute

航次号

trafModeName

Attribute

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

supervisor

Attribute

监管方式

cutMode

Attribute

征免性质

licenseNo

Attribute

许可证号

originalCountry

Attribute

运抵国地

distinatePort

Attribute

指运港

transMode

Attribute

成交方式

feeMark

Attribute

运费/率描述

feeCurr

Attribute

运费/率价格

feeRate

Attribute

运费/率币值单位

insurMark

Attribute

保费/率描述

insurCurr

Attribute

保费/率价格

insurRate

Attribute

保费/率币值单位

otherMark

Attribute

杂费/率

packNo

Attribute

件数

wrapType

Attribute

包装种类

grossWet

Attribute

毛重(Kg)

netWt

Attribute

净重(Kg)

tradeArea

Attribute

贸易国别

goodsPlace

Attribute

货物存放地

entyPort

Attribute

离境口岸

entryType

Attribute

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

noteS

Attribute

备注

markNo

Attribute

标记唛码

firstConfirm

Attribute

特殊关系确认

secondConfirm

Attribute

价格影响确认

thirdConfirm

Attribute

使用费支付确认

domesticConsigneeEname

Attribute

境内发货人英文

otherRate

Attribute

杂费金额

otherCurr

Attribute

杂费币制

invoiceAmount

Attribute

发票总价

packingNetWeightAmount

Attribute

装箱单总净重

overseasConsignee

Attribute

海外收货人

districtName

Attribute

境内货源地

docImageSrc

Array

解析图片集合

PRE_DECLARATION：预录单

INVOICE：发票

PACKING_LIST：装箱单

CONTRACT：销售合同

DECLARATION_ELEMENTS：产品说明&申报要素

ENTRUST_LETTER_OF_INSPECTION：报关委托书

CUSTOMS_POWER_OF_ATTORNEY：代理报关委托书

OTHER：其他

docPdfSrc

Array

解析pdf集合（分类同上）

picArgsList

Array

tableList

Array

商品数组

字段类型必填描叙

contrlItem

Attribute

备案序号

codeTS

Attribute

商品编号

gName

Attribute

商品名称

gModel

Attribute

规格型号

gQty

Attribute

成交数量

gUnit

Attribute

成交单位

declPrice

Attribute

单价

declTotal

Attribute

总价

tradeCurr

Attribute

币制

firstQty

Attribute

法定数量

firstUnit

Attribute

法定单位

versionNo

Attribute

版本号

productNo

Attribute

货号

destinationCountry

Attribute

最终目的国

secondQty

Attribute

第二数量

secondUnit

Attribute

第二单位

originCountry

Attribute

原产国

districtName

Attribute

境内货源地

destName

Attribute

产地

dutyMode

Attribute

征免方式

gNoAttribute

项号

unCode

Attribute

UN编号

dangPackType

Attribute

包装类别

dangName

Attribute

危险类别

dangPackSpec

Attribute

包装UN标记

noDangFlag

Attribute

非危险货物

goodsAttrName

Attribute

货物属性

Attribute 对象：

字段类型必填描叙codeString当前字段值[code](*位数)编码valueString当前字段值内容totalInteger当前字段总数flagString比对标记（0：提取来源为预录单，发票，箱单上，三者数据比对一致；1：比对不一致；2：仅从预录单提取到，并未从其他分类单据中提取到，那么视作单一来源）currencyStringdocTypeStringdutyNoString当前字段值社会信用代码rowsList

当前字段的坐标

字段类型必填描叙codeStringvalueStringcolorFlagStringflagStringcellNameStringdocTypeString值：INVOICE ｜ PRE_DECLARATION ｜ CONTRACT ｜PACKING_LIST ｜DECLARATION_ELEMENTS

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
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）

字段	类型	必填	描述
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
token	String	Y（二选一）	报关行token
orderOutNo	String	Y（二选一）	业务流水号
billNo customerNo	String String		提运单号
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）

字段	类型	必填	描述

state

appId

boolean

String

Y

成功：true

orderOutNo

失败：false

String

msg

Y

String

业务流水号

N

出参

描述

字段

...

类型

接口地址

必填

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

描述

请求方式

code

post

int

入参（json）字段类型必填描叙orderNo

200=成功
msg	String	Y

系统流水号

说明

orderOutNo

data

String

描述

Y

Image Added

业务编号

5. 获取查验通知书

BussinessDataJsonYhttps

接口地址	调试url：http://

single-xml-dev.oss-cn-shanghai.aliyuncs

api.t.baoguan001.com/

doc

api/

doc

docking/

%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.pdfhttps

getCheckRows

正式url：http://

single-xml-dev.oss-cn-shanghai.aliyuncs

api.platform.codeflagai.com/

doc

api/

doc

docking/

%E6%A0%B8%E6%B3%A8%E6%B8%85%E5%8D%95%E6%95%B0%E6%8D%AE.json

getCheckRows

出参

请求方式

描述

post

待确认###

7.推送订单费用接口

billNoStringN提运单号feeIdY费⽤id，标识唯⼀费⽤备注

接口地址

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

请求方式

post

入参（json）

字段	类型	必填	描述
actionappId	String	Yorder_fee(订单费用)
type	String	N	check ：标识区分查验描述
orderOutNo	String	Y	业务流水号

出参

字段

类型

必填

描述

code

int

200=成功

msg

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

说明
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	业务流水号

出参

字段

类型

必填

描述

statecode

boolean

Y

成功：true

失败：falseint

200=成功

msg

String

NY

描述

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

...

接口地址

...

在后台配置外部地址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

...

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

...

接口地址

...

在后台配置外部地址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
height	250

...

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

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

调试url：http://

接口地址

说明
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

身份标记

orderOutNo

String

业务编号

Y

订单的身份

msg

String

字段

类型

描述

必填

shipName

String

船名

N

voyage

String

航次

N

billNo

String

提单号

N

packNo

String

件数

N

grossWet

String

毛重

N

decContainersJsonArray

JsonArray

集装箱

N

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

出参

字段	类型	描述
code	int	200=成功
msg	String	接口返回信息
data	Object

描述

做箱任务由货代端ERP发起，通过信号旗IM，传递给报关行；

报关行客户，确定做箱数据后，回填到系统中（这时数据才真正的生效）

2.获取推送消息

接口地址

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

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

请求方式

post

入参（json）入参（DataForm）

Y

字段	类型	描述	必填	描述
action	String	Y	single_receipt(海关回执)
appId	String		备注
appId	String	权限令牌	Y	身份标记
msg	String	消息内容	Y	《消息体》
sessionType	String	会话类型	Y	默认是：20
messageType	String	消息类型	Y	《消息类型》
orderOutNo	String	业务编号	Y	业务流水号订单的身份

出参

字段	类型	必填描述描述	备注
code	int	200=成功	orderOutNo	String	Y	外部流水号
msg	String	N接口返回信息
datadata.rows	ObjectString

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

示例：

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

入参

描述

出参

2.获取检验稿

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

...

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

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

...

字段	类型	必填	描述
appId	String	Y（二选一）	货代appId
token	String	Y（二选一）	报关行token
orderOutNo	String	Y（二选一）	业务流水号
billNo customerNo	String String		提运单号
billNo customerNo	String String		客户自编号

...

字段

...

类型

...

必填

...

描述

...

code

...

int

...

200=成功

...

msg

...

String

...

Y

...

说明

...

data

...

Image Removed

3. 获取报关单

...

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

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

...

字段

...

类型

...

必填

...

描述

...

appId

...

String

...

Y

...

orderOutNo

...

String

...

Y

...

业务流水号

...

字段

...

类型

...

必填

...

描述

...

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

...

字段

...

类型

...

必填

...

描述

...

appId

...

String

...

Y

...

orderOutNo

...

String

...

Y

...

业务流水号

...

字段

...

类型

...

必填

...

描述

...

code

...

int

...

200=成功

...

msg

...

String

...

Y

...

说明

...

data

...

Image Removed

5. 获取查验通知书

...

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

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

...

字段

...

类型

...

必填

...

描述

...

appId

...

String

...

Y

...

orderOutNo

...

String

...

Y

...

业务流水号

...

字段

...

类型

...

必填

...

描述

...

code

...

int

...

200=成功

...

msg

...

String

...

Y

...

说明

...

data

...

List

...

多个下载地址

...

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

...

版本1

Image Removed

版本2

Image Removed

6. 获取报关委托书

...

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

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

...

字段

...

类型

...

必填

...

描述

...

appId

...

String

...

Y

...

orderOutNo

...

String

...

Y

...

业务流水号

...

字段

...

类型

...

必填

...

描述

...

code

...

int

...

200=成功

...

msg

...

String

...

Y

...

说明

...

data

...

String

...

Image Removed

四. 客户系统与信号旗对接 (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发送消息给报关行。直接发送到报关的想要的聊天记录中，并提供消息即使提醒

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

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

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.推送数据接口

...

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

...

字段

类型

必填

描述

action

String

Y

send_data (制单完成数据)

sendBgh_data (报关行发送数据)

single_data (单一放行数据)

orderOutNo

String

Y

业务流水号

dataJson

json

N

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

...

字段

...

类型

...

必填

...

描述

...

state

...

boolean

...

Y

...

成功：true

失败：false

...

msg

...

String

...

N

...

{
    "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	singlesyn_receiptstatus (海关回执同步状态)
orderOutNo	String	NY	业务流水号
billNocode	Stringint	NY提运单号	参见《附件4：信号旗订单状态》
paramJsonmsg	jsonString	Y回执json

出参

字段	类型	必填	描述

channel

String

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

note

String

海关描述

noticeDate

String

海关时间

customMaster

String

主管海关

entryId

String

海关编码

cusCiqNo

String

统一编号

releaseNotice

String

N

放行通知书文件地址

customsDeclaration

String

N

报关单文件地址

examinePdf

String

N

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

electronic_ledger

orderNo

String

Y

single_receipt(海关回执)

orderOutNo

String

YN

业务流水号

billNo

String

N

提运单号

hdCoId

String

N

dataJson

paramJson

json

Y

回执json

报关ID

字段	类型	必填	描述
qcPassId	String	Y	电子底账编号
validDate	String	Y	电子底账有效结束时间
signDate	String	Y	电子底账有效开始时间
declareNo	String	Y
channel	String		参见《附件3：海关状态》
note	String		海关描述
noticeDate	String		海关时间
customMaster	String		主管海关
entryId	String		海关编码
cusCiqNo	String		统一编号
releaseNotice	String	N	放行通知书文件地址
customsDeclaration	String	N	报关单文件地址
examinePdf	String	N	查验通知书(口岸查验通知、报关单查验通知......)

出参

字段

类型

必填

描述

state

boolean

Y

成功：true

失败：false

msg

String

N

描述

...

接口地址

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

...

Page tree

Page History

Versions Compared

Old Version 171

New Version Current

Key

2.单一放行数据接口

5.

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

6.推送订单费用接口

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

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

三、数据获取（XHQ << ERP）

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

2.获取检验稿

3. 获取报关单

4. 获取放行通知书

5. 获取查验通知书

7.推送订单费用接口

6. 获取报关委托书

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

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

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

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

1. 整箱做箱任务

2.获取推送消息

2.获取检验稿

3. 获取报关单

5. 获取查验通知书

6. 获取报关委托书

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

1. 整箱做箱任务

2.获取推送消息

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

1.同步单证状态

2.推送数据接口

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

1.同步单证状态

2.推送数据接口

3.

海关回执接口

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

附件

附件1：导入单一标准数据格式declareDate