...
接口地址 | 测试URL:http://api.t.baoguan001.com/api/docking/upload 正式URL:http://api.platform.codeflagai.com/api/docking/upload | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
请求方式 | post | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
入参(JSON) |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
出参(Object) |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
描述 |
|
...
接口地址 | 测试URL:http://api.t.baoguan001.com/api/docking/fileBase64Upload 正式URL:http://api.platform.codeflagai.com/api/docking/fileBase64Upload | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
请求方式 | post | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
入参(JSON) |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
出参(Object) |
|
...
1.
...
3进口文件上传接口
接口地址 | 调试url:测试URL:http://api.t.baoguan001.com/api/docking/receiptseauploadImport 正式url:正式URL:http://api.platform.codeflagai.com/api/docking/receiptseauploadImport | |||||||
请求方式 | post | |||||||
入参(json)入参(JSON) |
|
...
customMaster
...
String
...
...
entryId
...
String
...
...
dDate
...
...
...
cusCiqNo
...
...
...
...
...
cusRetSeqNo
...
包装种类
描述:红框部分为回执号
...
字段
...
类型
...
描述
...
备注
...
code
...
int
...
200=成功
...
msg
...
String
...
接口返回信息
...
data
...
json
...
返回数据
...
4.上传拼箱关系接口 (已废弃)
|
|
|
|
|
---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
权限令牌 | 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
...
...
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
出参(Object) |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
描述 |
2.单一放行数据接口
接口地址 | 调试url:http://api.t.baoguan001.com/api/docking/receiptsea 正式url:http://api.platform.codeflagai.com/api/docking/receiptsea | ||||||||||||||||
请求方式 | post | ||||||||||||||||
入参(json) |
| ||||||||||||||||
出参 |
| ||||||||||||||||
描述 |
...
3.
...
入参:
必填:业务编号、船名、航次、出境关别、提单号、件数、毛重(kg)、
选填:指运港、集装箱号、集装箱规格、随附文档
接口:
...
海关回执接口
接口地址 | 调试url:http://api.t.baoguan001.com/api/docking/lcl_task正式url:httpreceiptsingle 正式url:http://api.platform.codeflagai.com/api/docking/lcl_taskreceiptsingle | |||||||||||||||
请求方式 | post | |||||||||||||||
入参(DataForm)入参(json) |
| N | 图片地址 (图片地址和订单列表必填一个,不能两者都为空) | |||||||||||||
taskId | String | 拼箱任务ID | N | 新增成功后返回的ID,修改时必填 |
Y |
|
|
|
|
|
|
|
|
|
|
外港海关,洋山港区,吴淞
|
|
2225-外港海关
2248-洋山港区
2202-吴淞
|
|
包装种类 |
描述:红框部分为回执号 |
字段 |
类型 |
2229-航交办
2231-洋山市内
entyPort
离境口岸
描述 | 备注 | ||
code | int | 200=成功 | |
msg | String |
接口返回信息 |
distinatePort
distinatePortCode
containerId
containerMd
20GP,40GP ,40HQ,45GP,45HQ
containerWt
containerMdCode
packNo
件数
grossWet
毛重
orders
newBillNo
hdPackNo
hdGrossWet
data |
310701-外高桥
311002-洋山港
json | 返回数据 |
4.上传拼箱关系接口 (已废弃)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
描述示例 |
5.上传拼箱任务给报关行
入参 | 出参 |
---|---|
{ "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
...
字段 | 类型 | 描述 | 必填 | 备注 |
---|---|---|---|---|
appId | String | 权限令牌 | Y | 身份标记 |
...
字段
...
类型
...
描述
...
备注
...
code
...
int
...
200=成功
...
msg
...
String
...
接口返回信息
...
data
...
List<Object>
...
...
...
...
报关行列表,需要在相应的开放平台系统中绑定。详细咨询客服
...
Attribute
7 撤回
撤回
接口:
...
调试url:http://api.t.baoguan001.com/api/docking/recall
正式url:http://api.platform.codeflagai.com/api/docking/recall
...
字段
...
...
描述
...
必填
...
备注
...
appId
...
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
...
字段
...
类型
...
描述
...
必填
...
备注
...
appId
...
String
...
货代身份标记
...
Y
...
身份标记
...
noticeFlag
...
入参:
必填:业务编号、船名、航次、出境关别、提单号、件数、毛重(kg)、
选填:指运港、集装箱号、集装箱规格、随附文档
接口:
接口地址 | 调试url:http://api.t.baoguan001.com/api/docking/lcl_task 正式url:http://api.platform.codeflagai.com/api/docking/lcl_task | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
请求方式 | post | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
入参(json) |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
出参 |
| List<Object> | 失败集合 | 字段 | 类型
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
描述 | 必填示例 | String
| orderOutNo
...
二、数据输出(XHQ >> ERP)
在后台配置回调接口地址,需求对方提供;
1.同步单证状态
接口地址 | 在信号旗中配置回调接口,接口地址回调方提供(注意:该地址只能提供一个,具体业务根据action字段区分)。 | ||
请求方式 | post | ||
入参(json) | |||
字段 | 类型 | 必填 | 描述 |
---|---|---|---|
action | String | Y | syn_status (同步状态) |
orderOutNo | String | Y | 业务流水号 |
code | int | Y | 参见《附件4:信号旗订单状态》 | msg | String
| 业务编号 | Y |
String | errMsg | 错误信息 | Y |
描述 | 如果有不能解冻的订单会返回错误信息,能解冻订单会解冻但不会提示。 | 示例 |
9 订单费用确认
确认信号旗订单费用
接口:
...
调试url:http://api.t.baoguan001.com/api/docking/feeConfirm
正式url:http://api.platform.codeflagai.com/api/docking/feeConfirm
...
字段
...
类型
...
描述
...
必填
...
备注
...
appId
...
String
...
货代身份标记
...
Y
...
身份标记
...
confirmFlag
...
字段
...
类型
...
描述
...
备注
...
code
...
int
...
200=成功
...
msg
...
String
...
接口返回信息
...
确认信号旗订单费用;报关费、联单费无需确认
|
6 通过货代appId获取报关行列表
管理员配置好,报关行合作伙伴后,即可产生报关行列表。货代系统可以直接调用此货代对于的报关行列表
接口:
接口地址 | 调试url:http://api.t.baoguan001.com/api/docking/bghList 正式url:http://api.platform.codeflagai.com/api/docking/bghList | |||||||||||||||||||||||||
请求方式 | post | |||||||||||||||||||||||||
入参(json) |
| |||||||||||||||||||||||||
出参 |
| |||||||||||||||||||||||||
描述 | 报关行列表,需要在相应的开放平台系统中绑定。详细咨询客服 | |||||||||||||||||||||||||
示例 |
Attribute
7 撤回
撤回
接口:
接口地址 | ||||||||||||||||||||||||||
请求方式 | post | |||||||||||||||||||||||||
入参(json) |
| |||||||||||||||||||||||||
出参 |
| |||||||||||||||||||||||||
描述 |
2.推送数据接口
接口地址 | 在信号旗中配置回调接口,接口地址回调方提供(注意:该地址只能提供一个,具体业务根据action字段区分)。撤回 | |
示例 |
8 批量解冻
批量解冻接口
接口:
接口地址 | 调试url:http://api.t.baoguan001.com/api/docking/unFrozen 正式url:http://api.platform.codeflagai.com/api/docking/unFrozen | ||||||||||||||||||||||||||||||||||||||||||||||||||
请求方式 | post | ||||||||||||||||||||||||||||||||||||||||||||||||||
入参(json) | 入参(json) |
| 出参
| 字段
| 类型
| 必填
| 描述
| state | boolean
| 成功:true
| 失败:false
| msg
| String
| 描述
|
...
出参 | 接口地址
| 在信号旗中配置回调接口,接口地址回调方提供(注意:该地址只能提供一个,具体业务根据action字段区分)。
| 请求方式
| post
| 入参(json)
| 字段
| 类型
| 必填
| 描述
| action
| String
| Y | single_receipt(海关回执) | |||||||||||||
orderOutNo | String | N | 业务流水号 | |||||||||||||||||||||||
billNo | String | N | 提运单号 | paramJson | json | Y | 回执json
| 必填
| channel
| 参见《附件3:海关状态》
| note
| String
| 海关描述 | noticeDate |
| 海关时间
| customMaster
| String
| ||||||||
主管海关描述 | entryId 如果有不能解冻的订单会返回错误信息,能解冻订单会解冻但不会提示。 | |||||||||||||||||||||||||
String示例海关编码 |
9 订单费用确认
...
确认信号旗订单费用
...
接口:
...
releaseNotice
...
String
...
N
...
放行通知书文件地址
...
customsDeclaration
...
String
...
N
...
报关单文件地址
...
authorizationLetter
...
String
...
N
...
报关委托书地址
...
examinePdf
...
字段
...
类型
...
必填
...
描述
...
state
...
boolean
...
Y
...
成功:true
失败:false
...
msg
...
String
...
N
...
4.订单消息通知
接口地址 | 在信号旗中配置回调接口,接口地址回调方提供。 | |||||||||||||||||||||||||||||||||||||||||||||
请求方式 | post | |||||||||||||||||||||||||||||||||||||||||||||
接口地址 | 调试url:http://api.t.baoguan001.com/api/docking/feeConfirm 正式url:http://api.platform.codeflagai.com/api/docking/feeConfirm | |||||||||||||||||||||||||||||||||||||||||||||
请求方式 | post | |||||||||||||||||||||||||||||||||||||||||||||
入参(JSON) |
| |||||||||||||||||||||||||||||||||||||||||||||
出参 |
| |||||||||||||||||||||||||||||||||||||||||||||
描述 | 确认信号旗订单费用;报关费、联单费无需确认 | |||||||||||||||||||||||||||||||||||||||||||||
示例 |
二、数据输出(XHQ >> ERP)
在后台配置回调接口地址,需求对方提供;
1.同步单证状态
接口地址 | 在信号旗中配置回调接口,接口地址回调方提供(注意:该地址只能提供一个,具体业务根据action字段区分)。 | |||||||||||||||||||||
请求方式 | post | |||||||||||||||||||||
入参(json) |
| |||||||||||||||||||||
出参 |
| |||||||||||||||||||||
描述 | 待确认### |
...
2.
...
推送数据接口
接口地址 |
在信号旗中配置回调接口,接口地址回调方提供(注意:该地址只能提供一个,具体业务根据action字段区分)。 | ||||
请求方式 | post | |||
入参(json) |
|
|
|
|
|
|
|
|
|
出参 |
|
|
|
|
|
|
|
|
|
|
描述 |
3.海关回执接口
接口地址 |
在信号旗中配置回调接口,接口地址回调方提供(注意:该地址只能提供一个,具体业务根据action字段区分)。 |
请求方式 |
post |
入参(json) |
|
|
|
|
|
|
overseasConsignor
境外收发货人
ownerName
生产销售单位
agentName
申报单位
billNo
提运单号
trafName
运输工具名称
voyageNo
航次号
trafModeName
运输方式(2:水路运输;3:铁路运输;4:公路运输;5:航空运输;默认为2)
supervisor
监管方式
cutMode
征免性质
licenseNo
许可证号
originalCountry
运抵国地
distinatePort
指运港
transMode
成交方式
feeMark
运费/率 描述
feeCurr
运费/率 价格
feeRate
运费/率 币值单位
insurMark
保费/率 描述
insurCurr
保费/率 价格
insurRate
保费/率 币值单位
otherMark
杂费/率
packNo
件数
wrapType
包装种类
grossWet
毛重(Kg)
netWt
净重(Kg)
tradeArea
贸易国别
goodsPlace
货物存放地
entyPort
离境口岸
entryType
报关单类型: 有纸报关,无纸带清单报关,有纸带清单报关,通关无纸化,无纸报关
noteS
备注
markNo
标记唛码
firstConfirm
特殊关系确认
secondConfirm
价格影响确认
thirdConfirm
使用费支付确认
domesticConsigneeEname
境外发货人英文
otherRate
杂费金额
otherCurr
杂费币制
invoiceAmount
发票总价
packingNetWeightAmount
装箱单总净重
overseasConsignee
海外收货人
districtName
境内货源地
docImageSrc
解析图片集合
PRE_DECLARATION:预录单
INVOICE:发票
PACKING_LIST:装箱单
CONTRACT:销售合同
DECLARATION_ELEMENTS:产品说明&申报要素
ENTRUST_LETTER_OF_INSPECTION:报关委托书
CUSTOMS_POWER_OF_ATTORNEY:代理报关委托书
OTHER:其他
docPdfSrc
解析pdf集合(分类同上)
picArgsList
tableList
商品数组
contrlItem
备案序号
codeTS
商品编号
gName
商品名称
gModel
规格型号
gQty
成交数量
gUnit
成交单位
declPrice
单价
declTotal
总价
tradeCurr
币制
firstQty
法定数量
firstUnit
法定单位
versionNo
版本号
productNo
货号
destinationCountry
最终目的国
secondQty
第二数量
secondUnit
第二单位
originCountry
原产国
districtName
境内货源地
destName
产地
dutyMode
征免方式
项号
unCode
UN编号
dangPackType
包装类别
dangName
危险类别
dangPackSpec
包装UN标记
noDangFlag
非危险货物
goodsAttrName
货物属性
Attribute 对象:
当前字段的坐标
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
出参 |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
描述 |
4.订单消息通知
接口地址 | 在信号旗中配置回调接口,接口地址回调方提供。 | ||||||||||||||||||||
请求方式 | post | ||||||||||||||||||||
入参(json) |
| ||||||||||||||||||||
出参 |
| ||||||||||||||||||||
描述 | 待确认### |
5.推送进口保税数据接口核注清单
接口地址 | 在货代配置回调接口,接口地址回调方提供。 | ||||||||||||||||||||||||
请求方式 | post | ||||||||||||||||||||||||
入参(json) |
| ||||||||||||||||||||||||
出参 | |||||||||||||||||||||||||
描述 | 待确认### |
6.推送订单费用接口
接口地址 | 信号旗中配置回调接口地址,接口地址回调方提供(注意:该地址只能提供一个,具体业务根据action字段区分)。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
请求方式 | post | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
入参(json) |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
出参 |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
描述 |
7.进口流程节点推送数据接口
接口地址 | 在后台配置外部地址url,接口地址外部提供。 | ||||||||||||||||||||||||||||||||
请求方式 | Post | ||||||||||||||||||||||||||||||||
参数(json) |
| ||||||||||||||||||||||||||||||||
出参 |
| ||||||||||||||||||||||||||||||||
描述 |
8.进口合作方数据对接推送数据接口
接口地址 | 在后台配置外部地址url,接口地址外部提供。 | ||||||||||||||||||||
请求方式 | Post | ||||||||||||||||||||
参数(json) |
| ||||||||||||||||||||
出参 |
| ||||||||||||||||||||
描述 |
6.推送进口保税数据接口核注清单
...
在货代配置回调接口,接口地址回调方提供。
...
...
...
待确认###
7.推送订单费用接口
...
信号旗中配置回调接口地址,接口地址回调方提供(注意:该地址只能提供一个,具体业务根据action字段区分)。
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) |
| ||||||||||||||||||||||||||
出参 | int
| Y
| 费⽤id,标识唯⼀费⽤
| feeOpt
| String
| Y | 操作:1--新增;2--修改;3--删除 | feeName
| 费⽤名称;
| 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 | 描述 |
...
1.获取海关回执数据(所有的历史状态记录)
描述:如果对方服务在重启或者长时间未获取到,可以通过该接口来查询数据;数据有效期90天;
接口地址 | 调试url:http
| ||||||||||
描述 |
2.获取检验稿
描述:通过外部流水号+appId,获取校验稿url
接口地址 | 调试url:http://api.t.baoguan001.com/api/docking/actionDataRowgetCheckDraft 正式url:http正式url:http://api.platform.codeflagai.com/api/docking/actionDataRowgetCheckDraft | |||||||||||||||||||||
请求方式 | post | |||||||||||||||||||||
入参(json) |
| |||||||||||||||||||||
出参 |
| |||||||||||||||||||||
示例 | String | 根据action查询返回相应的数据集合 | 返回字符串,如果是明文,字符串里面是一个集合; | 描述 |
2.获取检验稿
描述:通过外部流水号+appId,获取校验稿url
3. 获取报关单
接口地址 | 调试url:http://api.t.baoguan001.com/api/docking/getCheckDraftgetCustomsClearance 正式url:http://api.platform.codeflagai.com/api/docking/getCheckDraftgetCustomsClearance | ||||||||||||||||||||
请求方式 | post | ||||||||||||||||||||
入参(json) |
| ||||||||||||||||||||
出参 |
| ||||||||||||||||||||
示例描述 |
...
4.
...
获取放行通知书
接口地址 | 调试url:http://api.t.baoguan001.com/api/docking/getCustomsClearancegetReleaseNotice 正式url:http://api.platform.codeflagai.com/api/docking/getCustomsClearancegetReleaseNotice | ||||||||||||||||
请求方式 | post | ||||||||||||||||
入参(json) |
| ||||||||||||||||
出参 |
| ||||||||||||||||
描述 |
...
5.
...
获取查验通知书
接口地址 | 调试url:http://api.t.baoguan001.com/api/docking/getReleaseNoticegetCheckRows 正式url:http://api.platform.codeflagai.com/api/docking/getReleaseNoticegetCheckRows | ||||||||||||||||
请求方式 | post | ||||||||||||||||
入参(json) |
| ||||||||||||||||
出参 |
| ||||||||||||||||
描述 |
...
版本1 版本2 |
6. 获取报关委托书
接口地址 | 调试url:http://api.t.baoguan001.com/api/docking/getCheckRowsgetAuthorizationLetter 正式url:http://api.platform.codeflagai.com/api/docking/getCheckRowsgetAuthorizationLetter | ||||||||||||||||||
请求方式 | post | ||||||||||||||||||
入参(json) |
| ||||||||||||||||||
出参 |
| ||||||||||||||||||
描述 | 版本1 版本2 |
...
四. 客户系统与信号旗对接 (ERP->报关行)
1. 整箱做箱任务
接口地址 | 调试url:http://api.t.baoguan001.com/api/docking/getAuthorizationLetterpackage 正式url:http://api.platform.codeflagai.com/api/docking/getAuthorizationLetterpackage | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
请求方式 | post | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
接口地址 | 调试url:http://api.t.baoguan001.com/api/docking/package 正式url:http://api.platform.codeflagai.com/api/docking/package | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
请求方式 | post | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
入参(json)入参(DataForm) |
| 出参
| 描述 | code | int | 200=成功 | msg
| Y
| 说明
| data
| 描述|||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
入参(DataForm)
|
四. 客户系统与信号旗对接 (ERP->报关行)
1. 整箱做箱任务
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
出参 |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
描述 | 做箱任务由货代端ERP发起,通过信号旗IM,传递给报关行; 报关行客户,确定做箱数据后,回填到系统中(这时数据才真正的生效) |
...
接口地址 | 调试url:http://api.t.baoguan001.com/api/docking/sendMsg 正式url:http://api.platform.codeflagai.com/api/docking/sendMsg | ||||||||||||||||||||||||||||||
请求方式 | post | ||||||||||||||||||||||||||||||
入参(DataForm) |
| ||||||||||||||||||||||||||||||
出参 |
| ||||||||||||||||||||||||||||||
描述 | 示例:
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
...
ERP发送消息给报关行。直接发送到报关的想要的聊天记录中,并提供消息即使提醒 |
五. 信号旗推送消息给对接方 (信号旗->对接方)
在后台配置回调接口地址,需求对方提供;
1.同步单证状态
接口地址 | 在信号旗中配置回调接口,接口地址回调方提供。 | ||||||||||||||||||||||||||||
请求方式 | post | ||||||||||||||||||||||||||||
入参(json) |
| ||||||||||||||||||||||||||||
出参 |
| channel
| String
| 参见《附件3:海关状态》
| note
| 海关描述 | noticeDate | String | 海关时间 | customMaster | String | 主管海关 | entryId | String | 海关编码 | cusCiqNo | String | 统一编号 | |||||||||||
releaseNotice | String | N | 放行通知书文件地址 | ||||||||||||||||||||||||||
customsDeclaration | String | N | 报关单文件地址 | examinePdf | String | N | 查验通知书(口岸查验通知、报关单查验通知......)
| ||||||||||||||||||||||
描述 |
2.推送数据接口
接口地址 | 在信号旗中配置回调接口,接口地址回调方提供。 | ||||||||||||||||
请求方式 | post | ||||||||||||||||
入参(json) |
| ||||||||||||||||
出参 |
| ||||||||||||||||
描述 |
...
3.
...
海关回执接口
接口地址 | 在信号旗中配置回调接口,接口地址回调方提供。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
请求方式 | post | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
入参(json) |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
出参 |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
描述 |
...
接口地址 | 调试url:http://api.t.baoguan001.com/api/docking/failedPushConfirm 正式url:http://api.platform.codeflagai.com/api/docking/failedPushConfirm | |||||||||||||||||||||||||
请求方式 | post | |||||||||||||||||||||||||
入参(JSON) |
| |||||||||||||||||||||||||
出参 |
| |||||||||||||||||||||||||
描述 | 示例:
|
七. 合作方最终数据回推信号旗
接口地址 | 调试url:http://api.t.baoguan001.com/api/docking/receiptsea 正式url:http://api.platform.codeflagai.com/api/docking/receiptsea |
附件
附件1:导入单一标准数据格式declareDate
...