文档中心 > API类目 > 五道口API

alibaba.wdk.marketing.coupon.createactivity (优惠券活动创建)

添加优惠券活动

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
param CouponActivity 必须 创建优惠券活动请求入参
  • └ range_type
  • String
  • 必须
  • rangeShop
  • 优惠券适用范围 [rangeShop:店铺券;rangeItem:商品;rangeCategory:品类券]
  • limit_info
  • LimitInfo
  • 必须
  • 通用限购信息,-1为不限制,默认为不限制[如果同时设置了(每人活动期间总限领)和(每人每日限领),则只能生效(每人活动期间总限领)]
  • └ daily_limit_cnt
  • Number
  • 可选
  • 30
  • 活动每日总限领
  • └ user_daily_limit_cnt
  • Number
  • 可选
  • 2
  • 每人每日限领
  • └ user_limit_cnt
  • Number
  • 可选
  • 10
  • 每人活动期间总限领
  • └ total_limit_cnt
  • Number
  • 必须
  • 100
  • 必须指定且值为正数,活动期间总限领
  • └ terminals
  • String []
  • 必须
  • [1,2]
  • 优惠适用场景[APP|POS|POS+APP分别对应的值为1|2|1,2]
  • └ out_act_id
  • String
  • 可选
  • darunfa170907
  • 商家活动id
  • └ send_type
  • String
  • 必须
  • registered
  • 优惠券发放方式 [anonymous:匿名券;registered:记名券]
  • └ logo_url
  • String
  • 可选
  • https://www.taobao.com
  • 优惠券logo url,设置匿名券时为必传参数
  • └ shop_ids
  • String []
  • 必须
  • [123,456]
  • 参加活动的渠道店ids
  • └ end_time
  • Number
  • 可选
  • 1506513600000
  • 活动结束时间,时间戳[ms单位]
  • └ applicable_categories
  • Number []
  • 可选
  • [11,22]
  • 适用类目
  • └ amount
  • Number
  • 必须
  • 200
  • 券面额 [单位为分]
  • └ start_time
  • Number
  • 可选
  • 1503835200000
  • 活动开始时间,时间戳[ms单位]
  • └ apply_channels
  • String []
  • 必须
  • fullSendCoupon
  • 优惠券领取渠道 [fullSendCoupon:满额返券;fallingSendCoupon:天降红包;customerService:客服补偿发券;其他渠道请找接口人申请]
  • └ valid_days
  • Number
  • 可选
  • 5
  • 领取后N日有效;如果设置了该值,则不需要设置优惠券的开始时间和结束时间 [有效期截止至领取日期+N天的23:59:59。例券设置有效期领取后5天有效,2018.1.1领取的券,有效期截止至2018.1.6 23:59:59; 例券设置有效期领取后0天有效,2018.1.1领取的券,有效期截止至2018.1.1 23:59:59]
  • └ description
  • String
  • 必须
  • 优惠券活动描述
  • 优惠券活动描述,不超过100个中文字符
  • └ start_fee
  • Number
  • 可选
  • 300
  • [满减券特有,券类型为满减券时为必传参数]金额门槛,值为-1代表无门槛 [单位为分]
  • └ activity_name
  • String
  • 必须
  • 优惠券活动名称
  • 优惠券活动名称,不超过10个中文字符
  • └ details
  • String []
  • 可选
  • [仅限xx门店使用,本券不兑现]
  • 自定义的优惠券使用详情(支持多条)
  • └ discount_type
  • String
  • 必须
  • fullReduce
  • 优惠券优惠类型 [fullReduce:满减券;reduceTo:减至券,即一口价券]
  • └ start_count
  • Number
  • 可选
  • 3
  • [减至券特有]件数门槛,值为-1代表无门槛 [单位为整数]【已下线】
  • └ count
  • Number
  • 可选
  • 2
  • [减至券特有]优惠件数,限制最多优惠N件,值为-1代表不限制优惠件数 [单位为整数]【已下线】

响应参数

名称 类型 示例值 描述
result MarketResult 创建优惠券活动返回结果
  • └ message
  • String
  • 请求参数非法
  • 错误信息
  • └ data
  • Number
  • 124135
  • 创建成功时会返回五道口优惠券活动id
  • └ error_code
  • String
  • REQUEST_PARAM_ERROR
  • 错误码
  • └ success
  • Boolean
  • true
  • 创建优惠券活动是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWdkMarketingCouponCreateactivityRequest req = new AlibabaWdkMarketingCouponCreateactivityRequest();
AlibabaWdkMarketingCouponCreateactivityRequest.CouponActivity obj1 = new AlibabaWdkMarketingCouponCreateactivityRequest.CouponActivity();
obj1.setRangeType("rangeShop");
AlibabaWdkMarketingCouponCreateactivityRequest.LimitInfo obj2 = new AlibabaWdkMarketingCouponCreateactivityRequest.LimitInfo();
obj2.setDailyLimitCnt(30L);
obj2.setUserDailyLimitCnt(2L);
obj2.setUserLimitCnt(10L);
obj2.setTotalLimitCnt(100L);
obj1.setLimitInfo(obj2);
obj1.setTerminals("1,2");
obj1.setOutActId("darunfa170907");
obj1.setSendType("registered");
obj1.setLogoUrl("https://www.taobao.com");
obj1.setShopIds("123,456");
obj1.setEndTime(1506513600000L);
obj1.setApplicableCategories(new Long[] { 11,22 };
);
obj1.setAmount(200L);
obj1.setStartTime(1503835200000L);
obj1.setApplyChannels("fullSendCoupon");
obj1.setValidDays(5L);
obj1.setDescription("优惠券活动描述");
obj1.setStartFee(300L);
obj1.setActivityName("优惠券活动名称");
obj1.setDetails("仅限xx门店使用,本券不兑现");
obj1.setDiscountType("fullReduce");
obj1.setStartCount(3L);
obj1.setCount(2L);
req.setParam(obj1);
AlibabaWdkMarketingCouponCreateactivityResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_wdk_marketing_coupon_createactivity_response>
    <result>
        <message>请求参数非法</message>
        <data>124135</data>
        <error_code>REQUEST_PARAM_ERROR</error_code>
        <success>true</success>
    </result>
</alibaba_wdk_marketing_coupon_createactivity_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部