合作伙伴中心-查询优惠券列表:URI
下载合作伙伴中心用户手册完整版
URI
GET /v1.0/{domain_id}/common/promotion-mgr/coupons
参数说明请参见下表。
参数 |
是否必选 |
取值范围 |
描述 |
|---|---|---|---|
domain_id |
是 |
最大长度：64 |
客户账号ID。 获取方法请参见如何获取客户的customer_id/domain_id。 |
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|---|
coupon_id |
否 |
String |
最大长度：64 |
优惠券ID。 此参数不携带或携带值为空时，不作为筛选条件；携带值为null时，作为筛选条件；不支持携带值为空串。 |
order_id |
否 |
String |
最大长度：64 |
订单ID。 此参数不携带或携带值为空时，不作为筛选条件；携带值为null时，作为筛选条件；不支持携带值为空串。 |
promotion_plan_id |
否 |
String |
最大长度：64 |
促销计划ID。 此参数不携带或携带值为空时，不作为筛选条件；携带值为null时，作为筛选条件；不支持携带值为空串。 |
coupon_type |
否 |
Integer |
[1-3] |
优惠券类型：
此参数不携带或携带值为空或携带值为null时，不作为筛选条件；不支持携带值为空串。 |
status |
否 |
Integer |
[1-4] |
客户优惠券实例状态：
此参数不携带或携带值为空或携带值为null时，不作为筛选条件；不支持携带值为空串。 |
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。 |
page_no |
是 |
Integer |
[1-2147483647] |
当前页。 |
page_size |
是 |
Integer |
[1-100] |
每页数量。 |
coupons_scope |
否 |
Integer |
[1-2] |
优惠券的范围：
此参数不携带或携带值为空或携带值为null时，不作为筛选条件；不支持携带值为空串。 |
bp_id |
否 |
String |
最大长度：64 |
合作伙伴ID。 只有coupons-scope为2的时候，该字段必填，否则该字段不论是否填写都忽略。 当coupons-scope不为2时，此参数不携带或携带值为空或携带值为空串或携带值为null。 |
