创建优惠券

POST

/promotioncenter/coupon/createCoupon

请求参数

Body 参数application/json

appKey

string

访问者的AppKey，用于验证程序

必需

data

object

必需

businessSystemId

integer

业务体系id

必需

canReturn

enum<integer>

是否支持退返

必需

枚举值:

默认值:

canTransfer

enum<integer>

是否支持转增

必需

枚举值:

默认值:

couponDescription

string

券描述使用描述

必需

couponName

string

优惠券名称

必需

couponType

enum<string>

优惠券类型

必需

枚举值:

REDUCE DISCOUNT VOUCHER

couponWorth

integer

优惠券价值

必需

deliverChannel

string

投放渠道

必需

discountAmount

integer

折扣金额

必需

discountRate

integer

折扣率

必需

issueMaxAmount

integer

最大发行数量

必需

maxDiscountAmount

integer

最大折扣金额

必需

miniOrderAmount

integer

订单最小金额限制

必需

pickupEndTime

string

领用结束时间

必需

pickupStartTime

string

领用开始时间

必需

pickupAfterDays

integer

领用后有效期

可选

pickupAfterPeriod

integer

领取后几天生效

可选

立即生效传0（动态有效期）

ruleInstanceList

array [object {5}]

规则实例列表

必需

financialAllocationList

array [object {3}]

券财务分摊列表

必需

useEndTime

string

券使用结束时间

必需

useStartTime

string

券使用开始时间

必需

operator

string

操作人

必需

operatorOrgId

string

操作人所属组织id

必需

operatorOrgType

string

操作人所属组织类型

必需

示例

{
    "appKey": "AppKey",
    "data": {
        "businessSystemId": 1000,
        "canReturn": 0,
        "canTransfer": 0,
        "code": "Code",
        "couponDescription": "CouponDescription",
        "couponName": "CouponName",
        "couponStatus": "CouponStatus",
        "couponType": "CouponType",
        "couponWorth": 1,
        "deliverChannel": "DeliverChannel",
        "discountAmount": 1,
        "discountRate": 1,
        "issueMaxAmount": 100,
        "maxDiscountAmount": 10,
        "miniOrderAmount": 1000,
        "pickupEndTime": "2021-01-30 00:00:00",
        "pickupStartTime": "2021-01-10 00:00:00",
        "pickupAfterDays": 10,
        "ruleInstanceList": [
            {
                "actionType": 0,
                "name": "Name",
                "ruleInstanceDesc": "RuleInstanceDesc",
                "ruleDetails": [
                    {
                        "ruleDetailValue": "12345,67890",
                        "ruleDictCode": "allow_products",
                        "ruleDictType": "list"
                    }
                ],
                "ruleTemplateId": 1000
            }
        ],
        "financialAllocationList": [
            {
                "allocationOrgId": "AllocationOrgId",
                "allocationOrgType": "AllocationOrgType",
                "allocationRatio": 1
            }
        ],
        "useEndTime": "2021-01-30 00:00:00",
        "useStartTime": "2021-01-10 00:00:00"
    },
    "operator": "Operator",
    "operatorOrgId": "OperatorOrgId",
    "operatorOrgType": "OperatorOrgType"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/promotioncenter/coupon/createCoupon' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appKey": "AppKey",
    "data": {
        "businessSystemId": 1000,
        "canReturn": 0,
        "canTransfer": 0,
        "code": "Code",
        "couponDescription": "CouponDescription",
        "couponName": "CouponName",
        "couponStatus": "CouponStatus",
        "couponType": "CouponType",
        "couponWorth": 1,
        "deliverChannel": "DeliverChannel",
        "discountAmount": 1,
        "discountRate": 1,
        "issueMaxAmount": 100,
        "maxDiscountAmount": 10,
        "miniOrderAmount": 1000,
        "pickupEndTime": "2021-01-30 00:00:00",
        "pickupStartTime": "2021-01-10 00:00:00",
        "pickupAfterDays": 10,
        "ruleInstanceList": [
            {
                "actionType": 0,
                "name": "Name",
                "ruleInstanceDesc": "RuleInstanceDesc",
                "ruleDetails": [
                    {
                        "ruleDetailValue": "12345,67890",
                        "ruleDictCode": "allow_products",
                        "ruleDictType": "list"
                    }
                ],
                "ruleTemplateId": 1000
            }
        ],
        "financialAllocationList": [
            {
                "allocationOrgId": "AllocationOrgId",
                "allocationOrgType": "AllocationOrgType",
                "allocationRatio": 1
            }
        ],
        "useEndTime": "2021-01-30 00:00:00",
        "useStartTime": "2021-01-10 00:00:00"
    },
    "operator": "Operator",
    "operatorOrgId": "OperatorOrgId",
    "operatorOrgType": "OperatorOrgType"
}'

返回响应

🟢200成功

application/json

Body

code

string

响应状态

必需

message

null

响应消息

必需

data

object

返回信息

必需

string

券主表id

必需

code

string

券主表code

必需

success

boolean

是否成功

必需

示例

{
    "code": "200",
    "message": null,
    "data": {
        "id": 17679494926515656,
        "code": "0zMoACQHyI1"
    },
    "success": true
}

修改于 2023-11-28 06:29:34

查询可用优惠券列表 (返回可用和不可用的券列表)

回退优惠券