客户运营能力-查询优惠券列表:URI
下载客户运营能力用户手册完整版
URI
GET /v2/promotions/benefits/coupons
参数说明请参见下表。
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|---|
coupon_id |
否 |
String |
最大长度：64 |
优惠券ID。 此参数不携带或携带值为空时，不作为筛选条件。 |
order_id |
否 |
String |
最大长度：64 |
订单ID。 此参数不携带或携带值为空时，不作为筛选条件。 |
promotion_plan_id |
否 |
String |
最大长度：64 |
促销计划ID。 此参数不携带或携带值为空时，不作为筛选条件。 |
coupon_type |
否 |
Integer |
[1-4] |
优惠券类型：
此参数不携带或携带值为空或携带值为null时，不作为筛选条件；不支持携带值为空串。 |
status |
否 |
Integer |
[1-4] |
客户优惠券实例状态：
此参数不携带或携带值为空时，不作为筛选条件。 说明：
已过期优惠券，只返回12个月以内的数据。 |
active_start_time |
否 |
String |
最大长度：64 |
激活时间。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。其中，HH范围是0～23，mm和ss范围是0～59。 此参数不携带或携带值为空时，不作为筛选条件；不支持携带值为空串或携带值为null。 |
active_end_time |
否 |
String |
最大长度：64 |
结束时间。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。其中，HH范围是0～23，mm和ss范围是0～59。 此参数不携带或携带值为空时，不作为筛选条件；不支持携带值为空串或携带值为null。 |
offset |
否 |
Integer |
[0-最大整数] |
偏移量，从0开始。默认值为0。 此参数需与limit联合使用，不支持单独使用。 说明：
offset用于分页处理，如不涉及分页，请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1，则返回满足条件的第二个数据至最后一个数据。 示例1，满足查询条件的结果共10条数据，limit取值为10，offset取值为1，则返回的数据为2~10，第一条数据不返回。 示例2，查询总数20条，期望每页返回10条数据，则获取第一页数据，入参offset填写0，limit填写10；获取第二页数据，入参offset填写10，limit填写10。 |
limit |
否 |
Integer |
[1-100] |
查询的优惠券数量，默认值为10。 |
source_id |
否 |
String |
最大长度：255 |
发券来源，如果是合作伙伴发送的券，此处为伙伴ID。 如果需要查询某个伙伴发放的券，可以在此处输入该伙伴ID。 此参数不携带或携带值为空或携带值为空串时，不作为筛选条件；携带值为空串时，作为筛选条件。 |
