优惠券详情查询 - iPaaS三方执行动作

请求参数

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)

可选

kdtId

integer <int64>

当前店铺 id

必需

outStoreId

string

三方门店 id

必需

outOpenId

string

三方会员 id

必需

voucherDetailInfo

object (VoucherDetailInfo)

券详情

必需

voucherId

string

有赞优惠券 id

可选

voucherNo

string

有赞优惠券核销码

可选

outVoucherId

string

三方优惠券 id

必需

outVoucherNo

string

三方优惠券编码

必需

outVoucherTemplateId

string

必需

三方优惠券活动 id

voucherTemplateId

integer <int64>

可选

有赞优惠券活动 id

示例

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

返回响应

🟢200成功

application/json

Body

success

boolean

可选

标识本次调用是否返回

code

integer

可选

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

message

string

可选

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

requestId

string

请求Id

可选

errorData

object (Map«Object»)

调用失败返回的数据

可选

key

object (key)

可选

data

object (VoucherDetailQueryExtResponse)

调用返回的数据

可选

status

enum<integer>

优惠券状态

必需

枚举值:

1234

sentTime

string <date-time>

券发送时间

必需

value

integer <int64>

必需

券面额 - 为折扣优惠方式时，只能取1-99 - 为代金优惠方式时小于10W * 100 分
配合优惠类型preferentialMode字段使用

代金券：面额，单位为分

折扣券：折扣数百分比，例：7折为70

preferentialMode

enum<integer>

优惠券类型

可选

枚举值:

123

validStartTime

string <date-time>

优惠券可用开始时间

必需

validEndTime

string <date-time>

优惠券可用结束时间

必需

verifyCode

string

券核销码

必需

示例

{
  "success": false,
  "code": 0,
  "message": "",
  "requestId": "",
  "errorData": {
    "": {}
  },
  "data": {
    "status": 0,
    "sentTime": "",
    "value": 0,
    "preferentialMode": 0,
    "validStartTime": "",
    "validEndTime": "",
    "verifyCode": ""
  }
}