优惠券回收 - iPaaS三方执行动作

特殊说明：该接口需保证幂等，执行异常时，上游会进行重试，可使用 outVoucherNo 作为幂等键

请求参数

Body 参数application/json

rootKdtId

integer <int64>

有赞店铺总部Id

必需

appId

string

必需

应用厂商标识appId

globalProps

object (Map«Object»)

全局变量

必需

key

object (key)

可选

extendMap

object (Map«Object»)

必需

上下文扩展信息，透传信息key

key

object (key)

可选

requestId

string

必需

本次请求requestId

outStoreId

string

三方门店 id

可选

kdtId

integer <int64>

有赞店铺 id

必需

bizId

string

可选

有赞侧业务流水标识
如核销场景: 该字段为有赞订单号，E开头+年月日时分秒+随机数，长度24位字母和数字组合

outOpenId

string

三方会员 id

必需

voucherDetailInfo

object (VoucherDetailInfo)

优惠券详情

必需

voucherId

string

有赞优惠券 id

可选

voucherNo

string

有赞优惠券核销码

可选

outVoucherId

string

三方优惠券 id

必需

outVoucherNo

string

三方优惠券编码

必需

outVoucherTemplateId

string

必需

三方优惠券活动 id

示例

{
    "rootKdtId": 0,
    "appId": "string",
    "globalProps": {
        "key": {}
    },
    "extendMap": {
        "key": {}
    },
    "requestId": "string",
    "outStoreId": "string",
    "kdtId": 0,
    "bizId": "string",
    "outOpenId": "string",
    "voucherDetailInfo": {
        "voucherId": "string",
        "voucherNo": "string",
        "outVoucherId": "string",
        "outVoucherNo": "string",
        "outVoucherTemplateId": "string"
    }
}

返回响应

🟢200成功

application/json

Body

success

boolean

可选

标识本次调用是否返回

code

integer

可选

本次调用返回code，一般为错误代码

message

string

可选

本次调用返回的消息，一般为错误消息

requestId

string

请求Id

可选

errorData

object (Map«Object»)

调用失败返回的数据

可选

key

object (key)

可选

data

object (VoucherRecycleExtResponse)

调用返回的数据

可选

success

boolean

是否成功

必需

示例

{
  "success": false,
  "code": 0,
  "message": "",
  "requestId": "",
  "errorData": {
    "": {}
  },
  "data": {
    "success": false
  }
}