Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

接口地址

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

请求方式post
入参(json)


字段

类型

必填

描述

action

String

Y

electronic_ledger

orderNo
StringY信号旗流水号

orderOutNo

String

Y

业务流水号

billNo

String

N

提运单号

hdCoId
StringN
dataJson

json

Y

回执json

字段

类型

必填

描述

qcPassId
StringY电子底账编号
validDate
StringY电子底账有效结束时间
signDate
StringY电子底账有效开始时间
declareNo
StringY报关ID



出参


字段

类型

必填

描述

state

boolean

Y

成功:true

失败:false

msg

String

N



描述





六. 信号旗推送消息失败结果


1.  推送失败清单查询

接口地址

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

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

请求方式post
入参(JSON)


字段

类型

描述

必填

备注

bghId

String

报关行id

Y

身份标记

type

String

类型(报关行:“BGH”)

Y


cutoffTime
String截止时间(例:"2022-06-07 16:33:28")

N



出参


字段

类型

必填

描述

备注

code

int

Y

200=成功

msg

String

Y

接口返回信息

data

Object

List

Y


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

见下面示例


描述

示例:

入参出参

{
    "type":"BGH",
    "bghId":"D6A8E64D399546CD9B60E1982B61A699",
    "cutoffTime":"2022-06-07 16:33:28"
}

{
    "code"200,
    "msg""成功",
    "data": [
        {
            "orderNo""A22060714485160455",
            "orderOutNo""2022060702"
        },
        {
            "orderNo""A22060714485586949",
            "orderOutNo""2022060706"
        }
    ],
    "foot": {
        "operationTime""2022-06-07 19:39:08"
    }
}



2. 系统流水号查询失败记录

接口地址

调试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\":\"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"
    }
}



3. 批量系统流水号查询失败记录

接口地址

调试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\":\"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"
    }
}



4. 推送失败清单确认(清理)

接口地址

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


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




附件

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

...