优惠券发放 - iPaaS三方执行动作

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

请求参数

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

必需

outOpenId

string

三方会员 id

必需

outStoreId

string

三方门店 id

必需

yzOpenId

string

有赞会员 id

可选

mobile

string

手机号

可选

requestId

string

此次请求唯一标识

必需

sendSource

string

发放来源

可选

extMap

object (Map«Object»)

优惠券扩展信息

可选

key

object (key)

可选

voucherDetailInfo

object (VoucherDetailInfo)

优惠券详情信息

必需

voucherId

string

有赞优惠券 id

可选

sendSource

string

发放来源

可选

voucherNo

string

有赞优惠券编码

必需

voucherTemplateId

integer <int64>

必需

有赞优惠券活动 id

outVoucherTemplateId

string

必需

三方优惠券活动 id

value

integer <int64>

必需

优惠券面额 (配合优惠类型 preferentialMode 字段使用)

代金券：面额，单位为分 (MAX: 10W * 100 )

折扣券：折扣数百分比( 1-99 )，例：7折为70

preferentialMode

enum<integer>

优惠券类型

必需

枚举值:

123

verifyCode

string

可选

有赞优惠券默认生成核销码, 此码是优惠券展示码。
可被覆盖成开发者自编码

status

enum<integer>

优惠券状态

可选

枚举值:

1234

validStartTime

string <date-time>

必需

优惠券有效期开始时间

validEndTime

string <date-time>

必需

优惠券有效期结束时间

sentTime

string <date-time>

发放时间

必需

num

integer

发送数量

必需

示例

{
    "rootKdtId": 0,
    "appId": "string",
    "globalProps": {
        "key": {}
    },
    "extendMap": {
        "key": {}
    },
    "kdtId": 0,
    "outOpenId": "string",
    "outStoreId": "string",
    "yzOpenId": "string",
    "mobile": "string",
    "requestId": "string",
    "sendSource": "string",
    "extMap": {
        "key": {}
    },
    "voucherDetailInfo": {
        "voucherId": "string",
        "sendSource": "string",
        "voucherNo": "string",
        "voucherTemplateId": 0,
        "outVoucherTemplateId": "string",
        "value": 0,
        "preferentialMode": 1,
        "verifyCode": "string",
        "status": 1,
        "validStartTime": "2019-08-24T14:15:22Z",
        "validEndTime": "2019-08-24T14:15:22Z",
        "sentTime": "2019-08-24T14:15:22Z"
    },
    "num": 0
}

返回响应

🟢200成功

application/json

Body

success

boolean

可选

标识本次调用是否返回

code

integer

可选

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

message

string

可选

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

requestId

string

请求Id

可选

errorData

object (Map«Object»)

调用失败返回的数据

可选

key

object (key)

可选

data

object (VoucherSendExtResponse)

调用返回的数据

可选

outVoucherId

string

三方优惠券 id

必需

outVoucherNo

string

外部券号

必需

verifyCode

string

必需

核销码-若核销码以线下为准必填

voucherNo

string

可选

有赞优惠券编码-若核销码以线下为准必填

validStartTime

string <date-time>

优惠券可用开始时间

可选

validEndTime

string <date-time>

优惠券可用结束时间

可选

示例

{
  "success": false,
  "code": 0,
  "message": "",
  "requestId": "",
  "errorData": {
    "": {}
  },
  "data": {
    "outVoucherId": "",
    "outVoucherNo": "",
    "verifyCode": "",
    "voucherNo": "",
    "validStartTime": "",
    "validEndTime": ""
  }
}