...
接口地址 | 在信号旗中配置回调接口,接口地址回调方提供。 | ||||||||||||||||||||
请求方式 | post | ||||||||||||||||||||
入参(json) |
| ||||||||||||||||||||
出参 |
| ||||||||||||||||||||
描述 | 待确认### |
5.
...
推送进口保税数据接口核注清单
接口地址 |
在货代配置回调接口,接口地址回调方提供。 | |||||||||||||
请求方式 | post | ||||||||||||
入参(json) |
|
|
TableList 对象
出参
|
declarationPort
申报地海关
IEPort
出境关别
manualNo
备案号
contrNo
合同协议号
IEDate
出口日期
declareDate
申报日期
tradeName
境内收发货人
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 对象:
当前字段的坐标
出参 | |
描述 | 待确认### |
6.推送订单费用接口
接口地址 | 信号旗中配置回调接口地址,接口地址回调方提供(注意:该地址只能提供一个,具体业务根据action字段区分)。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
请求方式 | post | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
入参(json) |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
出参 |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
描述 |
7.进口流程节点推送数据接口
接口地址 | 在后台配置外部地址url,接口地址外部提供。 | ||||||||||||||||||||||||||||||||
请求方式 | Post | ||||||||||||||||||||||||||||||||
参数(json) |
| ||||||||||||||||||||||||||||||||
出参 |
| ||||||||||||||||||||||||||||||||
描述 |
8.进口合作方数据对接推送数据接口
接口地址 | 在后台配置外部地址url,接口地址外部提供。 | ||||||||||||||||||||
请求方式 | Post | ||||||||||||||||||||
参数(json) |
| ||||||||||||||||||||
出参 |
| ||||||||||||||||||||
描述 |
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) |
| ||||||||||||||||||||||||
出参 |
| ||||||||||||||||||||||||
描述 |
2.获取检验稿
描述:通过外部流水号+appId,获取校验稿url
接口地址 | 调试url:http://api.t.baoguan001.com/api/docking/getCheckDraft 正式url:http://api.platform.codeflagai.com/api/docking/getCheckDraft | |||||||||||||||||||
请求方式 | post | |||||||||||||||||||
入参(json) |
| |||||||||||||||||||
出参 |
| |||||||||||||||||||
示例 |
3. 获取报关单
接口地址 | 调试url:http://api.t.baoguan001.com/api/docking/getCustomsClearance 正式url:http://api.platform.codeflagai.com/api/docking/getCustomsClearance | ||||||||||||||||
请求方式 | post | ||||||||||||||||
入参(json) |
| ||||||||||||||||
出参 |
| ||||||||||||||||
描述 |
4. 获取放行通知书
接口地址 | 调试url:http://api.t.baoguan001.com/api/docking/getReleaseNotice 正式url:http://api.platform.codeflagai.com/api/docking/getReleaseNotice | ||||
请求方式 | post | ||||
入参(json) |
|
|
|
|
|
|
|
出参 |
|
...
|
|
|
|
|
|
|
|
描述 |
5. 获取查验通知书
接口地址 | 调试url:http:// |
getCheckRows 正式url:http:// |
请求方式 |
post |
入参(json) |
7.推送订单费用接口
接口地址 | 信号旗中配置回调接口地址,接口地址回调方提供(注意:该地址只能提供一个,具体业务根据action字段区分)。 | |||||||||||||||||||
请求方式 | post | |||||||||||||||||||
入参(json) |
| |||||||||||||||||||
出参 | billNo
| String
| N
| 提运单号
| feeId
| Y | 费⽤id,标识唯⼀费⽤ | feeOpt
| 操作: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 | 备注
| |||||||||||||
描述 | 版本1 版本2 |
6. 获取报关委托书
接口地址 | 调试url:http://api.t.baoguan001.com/api/docking/getAuthorizationLetter 正式url:http://api.platform.codeflagai.com/api/docking/getAuthorizationLetter | ||||||||||||||
请求方式 | post | ||||||||||||||
入参(json) |
| ||||||||||||||
出参 |
| 描述 |
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://
| |||||
描述 |
四. 客户系统与信号旗对接 (ERP->报关行)
1. 整箱做箱任务
接口地址 | 调试url:http://api.t.baoguan001.com/api/docking/package 正式url:http://api.platform.codeflagai.com/api/docking/package | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
请求方式 | post | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
入参(DataForm) |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
出参 |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
描述 | 做箱任务由货代端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) |
| ||||||||||||||||||||||||||||||||||||||
出参 |
| ||||||||||||||||||||||||||||||||||||||
描述根据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 | 报关行token | |
orderOutNo | String | Y(二选一) | 业务流水号 |
billNo customerNo | String String | 提运单号 | |
客户自编号 |
...
字段
...
类型
...
必填
...
描述
...
code
...
int
...
200=成功
...
msg
...
String
...
Y
...
说明
...
data
...
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
...
...
调试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
...
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
...
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
...
四. 客户系统与信号旗对接 (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
...
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
...