Versions Compared

Old Version 156

changes.mady.by.user 熊兴

Saved on

compared with

New Version 157

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.1011.1

新增费用接口


Gavin20231201


推送AI数据接口

...

接口地址

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

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

请求方式post
入参（DataForm）


字段

类型

描述

必填

备注

appId

String

货代身份标记

Y

身份标记

orderOutNosList<String>业务编号Y
phoneString手机号Y
hdUserNameString操作人名称N
noticeFlag
Boolean解冻标记Ytrue（解冻），false为冻结
remarkString备注N冻结、解冻备注或原因


出参


字段

类型

描述

备注

code

int

200=成功


msg

String

接口返回信息


data

List<Object>

 失败集合


字段

类型

描述

必填

String

orderOutNo

业务编号Y
String

errMsg

错误信息Y



描述

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

示例



9 订单费用确认

确认信号旗订单费用

接口：

接口地址

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

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

请求方式post
入参（JSON）


字段

类型

描述

必填

备注

appId

String

货代身份标记

Y

身份标记

orderOutNoString业务编号Y
feeIdint费⽤idY费⽤id，标识唯⼀费⽤
feeNameString费用名称N费用名称；注：报关费、联单费无需确认
phoneString手机号Y
hdUserNameString操作人名称N
confirmFlag
Boolean确认标记Ytrue（确认），false为拒绝，需要填写拒绝原因
reasonString备注N拒绝，需要填写拒绝原因


出参


字段

类型

描述

备注

code

int

200=成功


msg

String

接口返回信息



描述

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

示例




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

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

...

接口地址

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

请求方式post
入参（json）


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








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


出参



描述

待确认###

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

备注


出参


字段

类型

必填

描述

state

boolean

Y

成功：true

失败：false

msg

String

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


字段类型必填描述
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\":\"SHISIS521345\"}",
            "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


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

见下面示例


描述

示例：

入参出参

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


...