...

版本	变更内容	备注	操作人	变更时间
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

declareDate

...

V3.10.1

新增费用接口

Gavin

20231201

推送AI数据接口

appId 获取方式：开放平台对接参数（appId、回调地址、相关推送）

...

接口地址

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

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

请求方式

post

入参（DataForm）

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

出参

字段

类型

描述

备注

code

int

200=成功

msg

String

接口返回信息

data

描述

撤回

示例

8 批量解冻

批量解冻接口

接口：

接口地址

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

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

请求方式

post

入参（DataForm）

字段	类型	描述	必填	备注
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

描述

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

示例

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

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

1.同步单证状态

...

9 订单费用确认

确认信号旗订单费用

接口：

接口地址

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

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

请求方式

post

入参（json）

入参（JSON）

字段	类型	描述	必填

描述

备注

action

appId

String

货代身份标记

Y

syn_status (同步状态)

身份标记
orderOutNo	String	业务编号	Y

业务流水号

feeId

code

int

msg

String

Y

费⽤id

Y

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

费⽤id，标识唯⼀费⽤
feeName	String	费用名称	N	费用名称；注：报关费、联单费无需确认
phone	String	手机号	Y
hdUserName	String	操作人名称	N
confirmFlag	Boolean	确认标记	Y	true（确认），false为拒绝，需要填写拒绝原因
reason	String	备注	N	拒绝，需要填写拒绝原因

出参

字段	类型

必填

	描述

state

备注

boolean

code

Y

成功：true

失败：false

int	200=成功
msg	String

N

接口返回信息

描述

...

	确认信号旗订单费用；报关费、联单费无需确认
示例

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

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

1.同步单证状态

接口地址

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

请求方式

post

入参（json）

字段	类型	必填	描述
action	String	Y	sendsyn_data status (制单完成数据同步状态) sendBgh_data (报关行发送数据)
orderOutNo	String	Y	业务流水号
code	int	Y	参见《附件4：信号旗订单状态》
msg	String	Y

出参

字段

类型

必填

描述

state

boolean

Y

成功：true

失败：false

msg

String

N

描述

2.推送数据接口

接口地址

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

请求方式

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

接口地址

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

请求方式

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	报关单文件地址
authorizationLetter	String	N	报关委托书地址
examinePdf	String	N	查验通知书(口岸查验通知、报关单查验通知......)

出参

字段

类型

必填

描述

state

boolean

Y

成功：true

失败：false

msg

String

N

描述

...

接口地址

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

请求方式

post

入参（json）

字段

类型

必填

描叙

orderNo

String

Y

系统流水号

orderOutNo

String

Y

业务编号

flag

String

Y

T/F（T：成功，F：失败）

message

String

Y

返回信息

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	征免方式
gNo	Attribute	项号
unCode	Attribute	UN编号
dangPackType	Attribute	包装类别
dangName	Attribute	危险类别
dangPackSpec	Attribute	包装UN标记
noDangFlag	Attribute	非危险货物
goodsAttrName	Attribute	货物属性

Attribute 对象：

字段

类型

必填

描叙

code

String

当前字段值[code](*位数)编码

value

String

当前字段值内容

total

Integer

当前字段总数

flag

String

比对标记（0：提取来源为预录单，发票，箱单上，三者数据比对一致；1：比对不一致；2：仅从预录单提取到，并未从其他分类单据中提取到，那么视作单一来源）

currency

String

docType

String

dutyNo

String

当前字段值社会信用代码

rows

List

当前字段的坐标

字段	类型	描叙
code	String
value	String
colorFlag	String
flag	String
cellName	String
docType	String	值：INVOICE ｜ PRE_DECLARATION ｜ CONTRACT ｜PACKING_LIST ｜DECLARATION_ELEMENTS
used	String
extraType	String
warningIndex	String
top	Integer	当前字段位置：纵向坐标顶部距离
bottom	Integer	当前字段位置：纵向坐标底部距离
left	Integer	当前字段位置：横向坐标左侧距离
right	Integer	当前字段位置：横向坐标右侧距离
height	Integer	当前文件高度（px）
width	Integer	当前文件:宽度 (px)
conceptId	Integer
dutyNo	String
imgSrc	String	图片或文件地址
sourceFlag	String
conceptStr	String

TableList 对象

出参

字段

类型

必填

描述

state

boolean

Y

成功：true

失败：false

msg

String

N

描述

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

接口地址

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

请求方式

post

入参（json）接口地址

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

请求方式

post

入参（json）

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


BussinessData	Json	Y

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

出参

描述

待确认###

7.推送订单费用接口

接口地址

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

请求方式

post

入参（json）

字段	类型	必填	描述
action	String	Y	order_fee(订单费用)
orderOutNo	String	Y	业务流水号
billNo	String	N	提运单号
feeId	int	Y	费⽤id，标识唯⼀费⽤
feeOpt	String	N	操作：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	商品项数
feeRemark	String	N	备注

出参

字段	类型	必填

描叙

描述

orderNo

state

String

boolean

Y

成功：true

系统流水号

失败：false

orderOutNo

msg

String

Y业务编号BussinessDataJsonY

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

出参描述

待确认###

N

描述

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

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

...

接口地址

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

字段	类型	必填	描述
orderNo	String	Y	系统流水号
action	String	Y	推送类型
orderOutNo	String	Y	业务编号
paramJson	String	Y	推送内容
requestBody	String	Y	客户返回消息
createTime	String	Y	推送时间

见下面示例

描述

示例：

入参

出参

{
    "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\":\"SHISI\"}",
            "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"
    }
}

...

接口地址

调试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	带上截止时间可以确保查询和确认清理的数据一致

出参

字段

类型

必填

描述

code

int

Y

200=成功

msg

String

Y

接口返回信息

data

List

Y

字段	类型	必填	描述
orderNo	String	Y	系统流水号
action	String	Y	推送类型
orderOutNo	String	Y	业务编号
paramJson	String	Y	推送内容
requestBody	String	Y	客户返回消息
createTime	String	Y	推送时间

见下面示例

描述

示例：

入参

出参

{
    "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\":\"SHISI\"}",
            "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"
    }
}

...

Page tree

Versions Compared

Old Version 155

New Version 156

Key

8 批量解冻

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

1.同步单证状态

9 订单费用确认

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

1.同步单证状态

2.推送数据接口

3.海关回执接口

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

7.推送订单费用接口

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

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

Page tree

Page History

Versions Compared

Old Version 155

New Version 156

Key

8 批量解冻

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

1.同步单证状态

9 订单费用确认

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

1.同步单证状态

2.推送数据接口

3.海关回执接口

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

7.推送订单费用接口

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

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