优惠券模板创建 - iPaaS三方执行动作

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

请求参数

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

可选

voucherTemplateId

integer <int64>

必需

有赞优惠券活动 id

outOpenId

string

三方会员 id

可选

voucherTemplateInfo

object (VoucherTemplateInfo)

优惠券信息

必需

applicableGoodsRule

object (ApplicableGoodsRule)

可用商品规则

可选

title

string

标题

必需

value

integer <int64>

必需

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

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

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

remark

string

活动备注

可选

description

string

描述

可选

status

integer

必需

活动状态；0:正常，可发放

voucherTemplateType

integer

必需

活动类型：默认值 7 (优惠券活动)

createdAt

string

可选

优惠券活动创建时间
格式：yyyy-MM-dd HH:mm:ss

updatedAt

string

可选

优惠券活动更新时间
时间格式：yyyy-MM-dd HH:mm:ss

sendStockQty

integer <int64>

库存

必需

applicableShopRangeType

enum<integer>

必需

优惠券活动设置的店铺规则

枚举值:

123

applicableShopInfos

array[object (ApplicableShopInfo) {2}]

可选

优惠券活动店铺规则中对应选择的店铺信息

applicableOnlineGoodsRangeType

enum<integer>

必需

优惠券活动设置的网店商品使用规则

枚举值:

0123

applicableOnlineGoodsInfos

array[object (ApplicableGoodsInfo) {4}]

可选

优惠券活动设置商品部分可用/不可用时，选择的网店商品信息，
与 applicableOnlineGoodsRangeType 配合使用

exchangeableOnlineGoodsInfos

array[object (ApplicableGoodsInfo) {4}]

可选

可兑换的网店商品id
券类型为商品兑换券使用

applicableOfflineGoodsRangeType

enum<integer>

必需

优惠券活动设置的门店商品使用规则

枚举值:

0123

applicableOfflineGoodsInfos

array[object (ApplicableGoodsInfo) {4}]

可选

优惠券活动设置商品部分可用/不可用时，选择的门店商品信息，与 applicableOfflineGoodsRangeType 配合使用

exchangeableOfflineGoodsInfos

array[object (ApplicableGoodsInfo) {4}]

可选

可兑换的门店商品id 券类型为商品兑换券使用
暂时未用

preferentialMode

enum<integer>

优惠券类型

必需

枚举值:

123

validTimeGenerateType

enum<integer>

有效期生成类型

必需

枚举值:

123456

relativeValidTimeDuration

integer

可选

相对有效期持续时间（天）

relativeValidTimeBeginInterval

integer

可选

相对有效期开始生效时间间隔（天）

absoluteValidStartTime

string <date-time>

绝对有效期开始时间

可选

absoluteValidEndTime

string <date-time>

绝对有效期结束时间

可选

takenQty

integer <int64>

领取次数

可选

thresholdAmount

integer <int64>

可选

优惠券金额门槛
0：无门槛（默认值）
n：门槛值（单位：分）

thresholdPiece

integer <int64>

可选

优惠券满件门槛 (单位：件）

thresholdMaxPiece

integer <int64>

满件上限

可选

budgetSendTotalQty

integer <int64>

预算发放总量

可选

maxDiscountAmount

integer

可选

最大折扣上限单位(单位：分)
0：代表没有折扣上限

voucherValueGenerateType

enum<integer>

面额生成规则类型

必需

枚举值:

1234

isForbidOverlayPreferential

boolean

可选

是否禁止叠加优惠(仅原价购买商品时可用)

thresholdType

enum<integer>

优惠券使用门槛类型

可选

枚举值:

012

canOverlayAsset

boolean

可选

优惠券是否允许叠加，最多可叠加3张。

userTakeNumLimit

integer

可选

用户领取数量限制
0:不限制（默认值）
n:限领n张

validPeriodType

enum<string>

生效周期类型

可选

枚举值:

validDayOfWeeks

array[string]

生效时间( 天 )

可选

枚举值:

MONTUEWEDTHUFRISATSUN

timePeriods

array[object (VoucherTemplateTimePeriodDTO) {3}]

时间段（支持2个）

可选

thirdPartyVerifyChannelType

integer

可选

线下三方核销渠道字段

isSharable

boolean

是否允许分享活动

可选

isPublicDisplay

boolean

可选

是否公开展示（默认值: false）

isForbidPublicTake

boolean

可选

是否禁止公开领取（默认值: false）

minValue

integer <int64>

可选

随机满减范围-最小值 ( 单位：分 )

maxValue

integer <int64>

可选

随机满减范围-最大值 ( 单位：分 )

示例

{
    "rootKdtId": 0,
    "appId": "string",
    "globalProps": {
        "key": {}
    },
    "extendMap": {
        "key": {}
    },
    "kdtId": 0,
    "outStoreId": "string",
    "voucherTemplateId": 0,
    "outOpenId": "string",
    "voucherTemplateInfo": {
        "applicableGoodsRule": {
            "discount": 0,
            "type": "GREATER_THAN"
        },
        "title": "string",
        "value": 0,
        "remark": "string",
        "description": "string",
        "status": 0,
        "voucherTemplateType": 0,
        "createdAt": "string",
        "updatedAt": "string",
        "sendStockQty": 0,
        "applicableShopRangeType": 1,
        "applicableShopInfos": [
            {
                "kdtId": 0,
                "outStoreId": "string"
            }
        ],
        "applicableOnlineGoodsRangeType": 0,
        "applicableOnlineGoodsInfos": [
            {
                "yzItemId": 0,
                "outItemId": "string",
                "spuCode": "string",
                "rootItemId": 0
            }
        ],
        "exchangeableOnlineGoodsInfos": [
            {
                "yzItemId": 0,
                "outItemId": "string",
                "spuCode": "string",
                "rootItemId": 0
            }
        ],
        "applicableOfflineGoodsRangeType": 0,
        "applicableOfflineGoodsInfos": [
            {
                "yzItemId": 0,
                "outItemId": "string",
                "spuCode": "string",
                "rootItemId": 0
            }
        ],
        "exchangeableOfflineGoodsInfos": [
            {
                "yzItemId": 0,
                "outItemId": "string",
                "spuCode": "string",
                "rootItemId": 0
            }
        ],
        "preferentialMode": 1,
        "validTimeGenerateType": 1,
        "relativeValidTimeDuration": 0,
        "relativeValidTimeBeginInterval": 0,
        "absoluteValidStartTime": "2019-08-24T14:15:22Z",
        "absoluteValidEndTime": "2019-08-24T14:15:22Z",
        "takenQty": 0,
        "thresholdAmount": 0,
        "thresholdPiece": 0,
        "thresholdMaxPiece": 0,
        "budgetSendTotalQty": 0,
        "maxDiscountAmount": 0,
        "voucherValueGenerateType": 1,
        "isForbidOverlayPreferential": true,
        "thresholdType": 0,
        "canOverlayAsset": true,
        "userTakeNumLimit": 0,
        "validPeriodType": "1",
        "validDayOfWeeks": [
            "MON"
        ],
        "timePeriods": [
            {
                "startTime": "string",
                "endTime": "string",
                "format": "string"
            }
        ],
        "thirdPartyVerifyChannelType": 0,
        "isSharable": true,
        "isPublicDisplay": true,
        "isForbidPublicTake": true,
        "minValue": 0,
        "maxValue": 0
    }
}

返回响应

🟢200成功

application/json

Body

success

boolean

可选

标识本次调用是否返回

code

integer

可选

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

message

string

可选

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

requestId

string

请求Id

可选

errorData

object (Map«Object»)

调用失败返回的数据

可选

key

object (key)

可选

data

object (VoucherTemplateCreateExtResponse)

调用返回的数据

可选

outVoucherTemplateId

string

外部券模板Id

必需

示例

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