文档中心 > API类目 > 天猫好房营销API

alibaba.alihouse.marketing.merchant.coupon.activity.create (商家卡券活动创建)

商家卡券活动创建

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
etc_coupon_activity_create_req ETCCouponActivityCreateReqDTO 必须 入参
  • └ discount_rate
  • Number
  • 可选
  • 99
  • discountRate
  • └ promotion_type
  • Number
  • 可选
  • 3
  • /** * 优惠类型 * 3:折扣率 * 4:满减 */
  • └ upper_limit_amount
  • Number
  • 可选
  • 1000
  • /** * 多次核销扣减上限(封顶金额) */
  • └ biz_type
  • String
  • 必须
  • rent_home
  • 业务类型 ● "new_home": 新房 ● "existing_home":二手房 ● "rent_home": 租房
  • └ effective_end_time
  • String
  • 可选
  • 2022-12-07 12:00:00
  • 活动结束时间
  • etc_coupon_template_config_context
  • ETCCouponTemplateConfigContextDTO
  • 可选
  • 扩展信息
  • └ spread_end_time
  • String
  • 可选
  • 2022-12-07 12:00:00
  • 领取结束时间
  • └ expire_time
  • String
  • 可选
  • 2022-12-08 12:00:00
  • 有效期至(生效时间)
  • └ time_mode
  • Number
  • 可选
  • 1
  • 有效时间类型(固定有效时间/相对当前时间/相对指定时间)
  • └ account_white_list
  • String
  • 可选
  • ""
  • 白名单账号列表
  • └ spread_start_time
  • String
  • 可选
  • 2022-12-06 12:00:00
  • 领取开始时间
  • └ rent_promotion_price_type
  • Number
  • 可选
  • 1
  • /** * 租金优惠金额类型 * 1:租金 * 2:租客服务费(寄租) * 3:服务费(直租) */
  • └ rent_promotion_date_type
  • Number
  • 可选
  • 1
  • /** * 租金优惠期数类型 * 1:首期 * 2:末期 * 3:每期 */
  • └ inventory
  • Number
  • 可选
  • 100
  • 库存数量
  • use_rule_struct_list
  • UseRuleStruct []
  • 可选
  • ""
  • 卡券使用门槛
  • └ type
  • Number
  • 可选
  • 1
  • 1-圈月租金(展示/核销条件)【范围】、2-圈总租金【范围】(核销条件) 3-圈二手总价(展示条件)【范围】 4-圈合同租期范围(展示/核销条件)【范围 or 列表】 5-圈付款方式(核销条件)【列表】 6-圈指定租客寄租服务费范围(核销范围)【范围】
  • use_rule
  • UseRule
  • 可选
  • 门槛信息
  • └ min
  • Number
  • 可选
  • 100
  • 针对区间范围类型,若传金额,单位为分
  • └ max
  • Number
  • 可选
  • 1000
  • 针对区间范围类型,若传金额,单位为分
  • └ oper
  • String
  • 可选
  • in
  • ● in, <, <=, >, >=, == ● 如需拼接操作符,使用"^"进行分隔,^左侧操作符作用于minValue,^右侧操作符作用于maxValue,minValue、maxValue均在操作符右侧 ● 例1:>=^<= 意为minValue <= ${value} <= maxValue ● 例2: >=^ 意为仅比较minValue,即 ${value} >= minValue ● 例3:^< 意为仅比较maxValue,即maxValue < ${value}
  • └ id_list
  • String []
  • 可选
  • [123,412]
  • 针对value列表
  • └ outer_supplier_id
  • Number
  • 必须
  • 12412
  • 卡券供应者id
  • └ benefit
  • String
  • 可选
  • 利益点
  • 利益点
  • └ promotion_scene
  • Number
  • 可选
  • 2
  • 优惠场景(线下码券业务场景) 3:到访礼 4:佣金优惠
  • └ effective_start_time
  • String
  • 可选
  • 2022-12-06 12:00:00
  • 活动开始时间
  • participate_group
  • ParticipateGroup
  • 必须
  • 卡券圈品范围
  • └ is_common_with_store
  • Boolean
  • 可选
  • true
  • 是否全门店通用
  • └ common_store_id_list
  • Number []
  • 可选
  • [245125123,532311]
  • 通用门店列表
  • participate_struct_list
  • ParticipateStruct []
  • 可选
  • { "common_store_id_list": { "number": [ 1066245126, 1066246123 ] }, "is_common_with_store": true }
  • 圈品结构列表
  • participate_id_list
  • ParticipateIdInfo []
  • 可选
  • [245125123,532311]
  • 圈品ID列表
  • └ type
  • Number
  • 可选
  • 3
  • 区分是集中式还是分散式 2:小区 3:公寓
  • └ community_outer_id
  • String
  • 可选
  • 352331
  • /** * 外部父节点ID * (例:圈品类型为小区时, 填外部小区ID) */
  • └ outer_id
  • String
  • 可选
  • 412312312
  • /** * 外部子节点ID * (例:圈品类型为小区房源时, 填外部小区房源ID, 同时填写外部小区ID) */
  • └ store_id
  • Number
  • 可选
  • 214123
  • 门店ID
  • └ type
  • Number
  • 可选
  • 1
  • 圈品类型
  • └ decrease_money
  • Number
  • 可选
  • 1000
  • 减多少钱 (单位分)
  • └ coupon_category
  • Number
  • 可选
  • 1
  • /** * 卡券分类(活动类型) * 1:店铺券 * 2:商品券 */
  • └ coupon_type
  • Number
  • 必须
  • 2
  • 卡券类型(活动大类)1:线下码券 2:线上折扣券
  • └ name
  • String
  • 可选
  • gz满减券测试
  • 名称
  • coupon_template_rule_content
  • ETCCouponTemplateRuleContentDTO
  • 可选
  • 卡券模板规则
  • └ limit_uid_receive_num
  • Boolean
  • 可选
  • true
  • 是否UID限领数量
  • └ uid_receive_num
  • Number
  • 可选
  • 1
  • 限领数量
  • └ start_fee
  • Number
  • 可选
  • 2000
  • startFee (单位分)
  • └ delivery_scene
  • Number
  • 必须
  • 1
  • 发放场景 1:房源 2:金融服务商品
  • └ supplier_type
  • Number
  • 必须
  • 2
  • 卡券供应者类型 2:品牌店 3:标准店
  • └ outer_adviser_id
  • String
  • 可选
  • 2022102497
  • 外部经纪人id
  • └ commission_fee_rate
  • String
  • 可选
  • 1.5
  • 佣金服务费率 (百分比)

响应参数

名称 类型 示例值 描述
result Result 返回结果
  • └ msg
  • String
  • 成功
  • 返回信息
  • └ code
  • String
  • success
  • 返回码
  • data
  • ETCCouponActivityCreateResp
  • 创建模板返回信息
  • └ activity_id
  • Number
  • 421941201
  • 活动ID
  • fail_participate_group
  • ParticipateGroup
  • 卡券圈品范围
  • └ is_common_with_store
  • Boolean
  • true
  • 是否全门店通用
  • └ common_store_id_list
  • Number []
  • 通用门店列表
  • participate_struct_list
  • ParticipateStruct []
  • 圈品结构列表
  • participate_id_list
  • ParticipateIdInfo []
  • 圈品ID列表
  • └ type
  • Number
  • 3
  • 区分是集中式还是分散式 2:小区 3:公寓
  • └ community_outer_id
  • String
  • 352331
  • /** * 外部父节点ID * (例:圈品类型为小区时, 填外部小区ID) */
  • └ outer_id
  • String
  • 412312312
  • /** * 外部子节点ID * (例:圈品类型为小区房源时, 填外部小区房源ID, 同时填写外部小区ID) */
  • └ store_id
  • Number
  • 214123
  • 门店ID
  • └ type
  • Number
  • 1
  • 圈品类型
  • └ is_success
  • Boolean
  • true
  • 是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest req = new AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest();
AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.ETCCouponActivityCreateReqDTO obj1 = new AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.ETCCouponActivityCreateReqDTO();
obj1.setDiscountRate(99L);
obj1.setPromotionType(3L);
obj1.setUpperLimitAmount(1000L);
obj1.setBizType("rent_home");
obj1.setEffectiveEndTime("2022-12-07 12:00:00");
AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.ETCCouponTemplateConfigContextDTO obj2 = new AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.ETCCouponTemplateConfigContextDTO();
obj2.setSpreadEndTime("2022-12-07 12:00:00");
obj2.setExpireTime("2022-12-08 12:00:00");
obj2.setTimeMode(1L);
obj2.setAccountWhiteList("\"\"");
obj2.setSpreadStartTime("2022-12-06 12:00:00");
obj2.setRentPromotionPriceType(1L);
obj2.setRentPromotionDateType(1L);
obj1.setEtcCouponTemplateConfigContext(obj2);
obj1.setInventory(100L);
List<AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.UseRuleStruct> list4 = new ArrayList<AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.UseRuleStruct>();
AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.UseRuleStruct obj5 = new AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.UseRuleStruct();
list4.add(obj5);
obj5.setType(1L);
AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.UseRule obj7 = new AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.UseRule();
obj7.setMin(100L);
obj7.setMax(1000L);
obj7.setOper("in");
obj7.setIdList("123,412");
list6.setUseRule(obj7);
obj1.setUseRuleStructList(list4);
obj1.setOuterSupplierId(12412L);
obj1.setBenefit("利益点");
obj1.setPromotionScene(2L);
obj1.setEffectiveStartTime("2022-12-06 12:00:00");
AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.ParticipateGroup obj8 = new AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.ParticipateGroup();
obj8.setIsCommonWithStore(true);
obj8.setCommonStoreIdList(new Long[] { 245125123,532311 };
);
List<AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.ParticipateStruct> list10 = new ArrayList<AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.ParticipateStruct>();
AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.ParticipateStruct obj11 = new AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.ParticipateStruct();
list10.add(obj11);
List<AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.ParticipateIdInfo> list14 = new ArrayList<AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.ParticipateIdInfo>();
AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.ParticipateIdInfo obj15 = new AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.ParticipateIdInfo();
list14.add(obj15);
obj15.setType(3L);
obj15.setCommunityOuterId("352331");
obj15.setOuterId("412312312");
list12.setParticipateIdList(list14);
obj11.setStoreId(214123L);
obj11.setType(1L);
obj8.setParticipateStructList(list10);
obj1.setParticipateGroup(obj8);
obj1.setDecreaseMoney(1000L);
obj1.setCouponCategory(1L);
obj1.setCouponType(2L);
obj1.setName("gz满减券测试");
AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.ETCCouponTemplateRuleContentDTO obj16 = new AlibabaAlihouseMarketingMerchantCouponActivityCreateRequest.ETCCouponTemplateRuleContentDTO();
obj16.setLimitUidReceiveNum(true);
obj16.setUidReceiveNum(1L);
obj1.setCouponTemplateRuleContent(obj16);
obj1.setStartFee(2000L);
obj1.setDeliveryScene(1L);
obj1.setSupplierType(2L);
obj1.setOuterAdviserId("2022102497");
obj1.setCommissionFeeRate("1.5");
req.setEtcCouponActivityCreateReq(obj1);
AlibabaAlihouseMarketingMerchantCouponActivityCreateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_alihouse_marketing_merchant_coupon_activity_create_response>
    <result>
        <msg>成功</msg>
        <code>success</code>
        <data>
            <activity_id>421941201</activity_id>
            <fail_participate_group>
                <is_common_with_store>true</is_common_with_store>
                <participate_struct_list>
                    <participate_struct>
                        <participate_id_list>
                            <participate_id_info>
                                <type>3</type>
                                <community_outer_id>352331</community_outer_id>
                                <outer_id>412312312</outer_id>
                            </participate_id_info>
                        </participate_id_list>
                        <store_id>214123</store_id>
                        <type>1</type>
                    </participate_struct>
                </participate_struct_list>
            </fail_participate_group>
        </data>
        <is_success>true</is_success>
    </result>
</alibaba_alihouse_marketing_merchant_coupon_activity_create_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

返回
顶部