文档中心 > API类目 > 五道口营销域

alibaba.wdk.coupon.template.query (优惠券模版查询)

优惠券模版查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
param_coupon_template_query_request CouponTemplateQueryRequest 可选 系统自动生成
  • └ id
  • Number
  • 可选
  • 13213
  • 模板表ID
  • └ source_id
  • Number
  • 可选
  • 12332
  • ump模板ID
  • user_info
  • UserInfo
  • 可选
  • 用户信息
  • └ user_id
  • Number
  • 可选
  • 324
  • 用户id
  • └ source
  • String
  • 可选
  • 34
  • 来源
  • └ user_name
  • String
  • 可选
  • 34
  • 用户名称

响应参数

名称 类型 示例值 描述
result ApiResult 结果
  • └ err_code
  • String
  • 参数异常
  • 错误码
  • └ err_msg
  • String
  • 参数异常
  • 错误信息
  • model
  • CouponTemplateOperateResponse
  • 返回
  • coupon_template
  • CouponTemplate
  • 券模版
  • apply_limit_config
  • CouponTemplateApplyLimitConfig
  • 领取限制
  • └ apply_end_time
  • Date
  • 2019-12-31 23:59:59
  • 优惠券最后能领取时间(超过这个时间,优惠券不能领取)
  • └ apply_start_time
  • Date
  • 2019-12-31 23:59:59
  • 优惠券最早能领取时间(在这时间之前,优惠券不能领取)
  • └ coupon_daily_lmt
  • Number
  • 1
  • 优惠券每日限领数(-1表示不限制)
  • └ coupon_total_lmt
  • Number
  • 1000
  • 优惠券总数(-1表示不限制)
  • └ personal_daily_lmt
  • Number
  • 1
  • 每人每日限领(-1表示不限制)
  • └ personal_lmt
  • Number
  • 1
  • 个人总领取限制数量(-1表示不限制)
  • common_config
  • CouponTemplateCommonConfig
  • 基础信息
  • └ apply_channels
  • String []
  • darunfa
  • 申请渠道
  • └ description
  • String
  • 全场8折
  • 优惠券活动描述
  • └ send_type
  • String
  • anonymous
  • 优惠券发放方式
  • └ status
  • Number
  • 1
  • 模板状态
  • └ title
  • String
  • 超市8折
  • 优惠券名称
  • └ type
  • Number
  • 6
  • 优惠券类型
  • condition_config
  • CouponTemplateConditionConfig
  • 生效条件
  • └ amount
  • Number
  • 100
  • 门槛金额
  • └ amount_at
  • Boolean
  • false
  • 是否生效满元条件
  • └ categories
  • String []
  • 23123
  • 生效类目
  • └ count
  • Number
  • 1
  • 门槛件数
  • └ count_at
  • Boolean
  • false
  • 是否生效满件条件
  • └ max_use_count_per_order
  • Number
  • 12
  • 单笔订单最大可用张数
  • └ only_member_self
  • Boolean
  • false
  • 是否限制本人使用
  • └ range_type
  • Number
  • 1
  • 券的使用范围
  • └ shop_ids
  • String []
  • 23123
  • 生效门店
  • └ terminals
  • Number []
  • 1
  • 生效终端
  • user_crowd_config
  • CouponTemplateUserCrowdConfig
  • 人群信息
  • └ merchant_customize_crowd_name
  • String
  • DRFMem
  • 商家自定义人群
  • └ platform_crowd_name
  • String
  • HEMAX
  • 平台人群
  • └ max_effect_amount
  • Number
  • 10
  • 最大优惠金额
  • └ exclude_item_rules
  • Number []
  • 1
  • 排品规则
  • └ merchant_categories
  • String []
  • [“111",“222”]
  • 生效商家类目
  • discount_config
  • CouponTemplateDiscountConfig
  • 优惠效果
  • └ decrease
  • Boolean
  • false
  • 是否减钱
  • └ decrease_money
  • Number
  • 100
  • 减钱金额
  • └ discount
  • Boolean
  • false
  • 是否打折
  • └ discount_rate
  • Number
  • 10
  • 打折额度
  • └ fix_price
  • Boolean
  • false
  • 是否固定价格
  • └ fix_price_amount
  • Number
  • 100
  • 优惠后的固定价格
  • └ id
  • Number
  • 1
  • 模板表主键
  • investment_config
  • CouponTemplateInvestmentConfig
  • 出资人配置
  • investment_info_list
  • InvestmentInfo []
  • 出资人配置
  • └ investor
  • String
  • caoding
  • 出资人
  • └ investor_ratio
  • Number
  • 2000
  • 出资比例
  • option_config
  • CouponTemplateOptionConfig
  • 其他配置--拓展信息
  • └ devalue
  • Boolean
  • false
  • 抵用券是否可贬值使用
  • └ logo_url
  • String
  • http://taobao.com
  • 优惠券logo url
  • └ out_coupon_template_id
  • String
  • 2312312
  • 外部优惠券模板id
  • └ out_coupon_type
  • String
  • 231
  • 外部优惠券类型
  • └ picture_url
  • String
  • http://taobao.com
  • 券图片
  • └ contract_instance_id
  • Number
  • 1001
  • 合同id
  • └ purchase_id
  • Number
  • 100
  • 采买者id
  • participate_config
  • CouponTemplateParticipateConfig
  • 参与者
  • participate_list
  • LogicGroup []
  • 参与者列表
  • └ logic_group_type
  • Number
  • 1
  • 逻辑分组类型
  • └ number
  • Number
  • 1
  • 参与者分组序号
  • └ wdk_group_name
  • String
  • 换购
  • 五道口参与者名称
  • └ source_id
  • Number
  • 23213
  • ump模板ID
  • time_limit_config
  • CouponTemplateTimeLimitConfig
  • 实例有效时间配置
  • └ end_valid_time
  • Date
  • 2019-12-31 23:59:59
  • 优惠券结束时间
  • └ start_valid_time
  • Date
  • 2019-12-31 23:59:59
  • 优惠券开始时间
  • └ valid_time_type
  • Number
  • 1
  • 优惠券有效时间类型
  • └ validity_period
  • Number
  • 1000
  • 优惠券有效时长
  • └ validity_start_interval
  • Number
  • 7200
  • 优惠券有效开始时长,单位为秒(优惠券领取后X天开始有效)
  • └ validity_end_interval
  • Number
  • 14400
  • 优惠券有效结束时长,单位为秒(优惠券领取后X-Y天有效的Y)
  • └ uuid
  • String
  • 123123
  • 优惠券模版uuid
  • compatible_config
  • CouponTemplateCompatibleConfig
  • 兼容历史逻辑配置
  • └ valid_till_night
  • Number
  • 1
  • 是否要求优惠券在一天的23:59:59失效
  • └ application_type
  • String
  • pointCoupon
  • 优惠券应用类型 pointCoupon:积分券
  • └ success
  • Boolean
  • false
  • 成功标志

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWdkCouponTemplateQueryRequest req = new AlibabaWdkCouponTemplateQueryRequest();
AlibabaWdkCouponTemplateQueryRequest.CouponTemplateQueryRequest obj1 = new AlibabaWdkCouponTemplateQueryRequest.CouponTemplateQueryRequest();
obj1.setId(13213L);
obj1.setSourceId(12332L);
AlibabaWdkCouponTemplateQueryRequest.UserInfo obj2 = new AlibabaWdkCouponTemplateQueryRequest.UserInfo();
obj2.setUserId(324L);
obj2.setSource("34");
obj2.setUserName("34");
obj1.setUserInfo(obj2);
req.setParamCouponTemplateQueryRequest(obj1);
AlibabaWdkCouponTemplateQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_wdk_coupon_template_query_response>
    <result>
        <err_code>参数异常</err_code>
        <err_msg>参数异常</err_msg>
        <model>
            <coupon_template>
                <apply_limit_config>
                    <apply_end_time>2019-12-31 23:59:59</apply_end_time>
                    <apply_start_time>2019-12-31 23:59:59</apply_start_time>
                    <coupon_daily_lmt>1</coupon_daily_lmt>
                    <coupon_total_lmt>1000</coupon_total_lmt>
                    <personal_daily_lmt>1</personal_daily_lmt>
                    <personal_lmt>1</personal_lmt>
                </apply_limit_config>
                <common_config>
                    <apply_channels>
                        <string>darunfa</string>
                    </apply_channels>
                    <description>全场8折</description>
                    <send_type>anonymous</send_type>
                    <status>1</status>
                    <title>超市8折</title>
                    <type>6</type>
                </common_config>
                <condition_config>
                    <amount>100</amount>
                    <amount_at>false</amount_at>
                    <categories>
                        <string>23123</string>
                    </categories>
                    <count>1</count>
                    <count_at>false</count_at>
                    <max_use_count_per_order>12</max_use_count_per_order>
                    <only_member_self>false</only_member_self>
                    <range_type>1</range_type>
                    <shop_ids>
                        <string>23123</string>
                    </shop_ids>
                    <terminals>
                        <number>1</number>
                    </terminals>
                    <user_crowd_config>
                        <merchant_customize_crowd_name>DRFMem</merchant_customize_crowd_name>
                        <platform_crowd_name>HEMAX</platform_crowd_name>
                    </user_crowd_config>
                    <max_effect_amount>10</max_effect_amount>
                    <exclude_item_rules>
                        <number>1</number>
                    </exclude_item_rules>
                    <merchant_categories>
                        <string>[“111&quot;</string>
                        <string>“222”]</string>
                    </merchant_categories>
                </condition_config>
                <discount_config>
                    <decrease>false</decrease>
                    <decrease_money>100</decrease_money>
                    <discount>false</discount>
                    <discount_rate>10</discount_rate>
                    <fix_price>false</fix_price>
                    <fix_price_amount>100</fix_price_amount>
                </discount_config>
                <id>1</id>
                <investment_config>
                    <investment_info_list>
                        <investment_info>
                            <investor>caoding</investor>
                            <investor_ratio>2000</investor_ratio>
                        </investment_info>
                    </investment_info_list>
                </investment_config>
                <option_config>
                    <devalue>false</devalue>
                    <logo_url>http://taobao.com</logo_url>
                    <out_coupon_template_id>2312312</out_coupon_template_id>
                    <out_coupon_type>231</out_coupon_type>
                    <picture_url>http://taobao.com</picture_url>
                    <contract_instance_id>1001</contract_instance_id>
                    <purchase_id>100</purchase_id>
                </option_config>
                <participate_config>
                    <participate_list>
                        <logic_group>
                            <logic_group_type>1</logic_group_type>
                            <number>1</number>
                            <wdk_group_name>换购</wdk_group_name>
                        </logic_group>
                    </participate_list>
                </participate_config>
                <source_id>23213</source_id>
                <time_limit_config>
                    <end_valid_time>2019-12-31 23:59:59</end_valid_time>
                    <start_valid_time>2019-12-31 23:59:59</start_valid_time>
                    <valid_time_type>1</valid_time_type>
                    <validity_period>1000</validity_period>
                    <validity_start_interval>7200</validity_start_interval>
                    <validity_end_interval>14400</validity_end_interval>
                </time_limit_config>
                <uuid>123123</uuid>
                <compatible_config>
                    <valid_till_night>1</valid_till_night>
                    <application_type>pointCoupon</application_type>
                </compatible_config>
            </coupon_template>
        </model>
        <success>false</success>
    </result>
</alibaba_wdk_coupon_template_query_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

返回
顶部