# 获取用户优惠券ID列表
# 接口说明
通过此接口可以获取用户优惠券ID列表。
# 注意事项
- 每次请求的页码间隔不能超过10;
- 第一次请求的页码要小于10,或者是最后一页;
- 一页最大200。
# 接口调用请求说明
POST https://api.weixin.qq.com/channels/ec/coupon/get_user_coupon_list?access_token=ACCESS_TOKEN
# 请求参数说明
参数 | 类型 | 是否必填 | 描述 |
---|---|---|---|
openid | string | 是 | 用户openid |
status | number | 否 | 优惠券状态,不填时获取所有优惠券,填时获取特定状态优惠券,枚举值详情请参考status |
page | number | 是 | 页码 |
page_size | number | 是 | 页大小 |
page_ctx | string | 是 | 翻页上下文,第一次请求填空,后续请求值为上次请求的返回 |
# 请求参数示例
{
"openid": "OPENID",
"status": 100,
"page": 1,
"page_size": 20,
"page_ctx": "THE_PAGE_CTX"
}
# 返回参数说明
参数 | 类型 | 描述 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息,errcode为0不返回 |
user_coupon_list[].user_coupon_id | string | 用户优惠券ID |
user_coupon_list[].coupon_id | string | 优惠券ID |
page_ctx | string | 翻页上下文 |
# 返回参数示例
{
"errcode": 0,
"user_coupon_list": [
{
"user_coupon_id": "109694341",
"coupon_id": "12639900"
}
],
"total_num": 1,
"page_ctx": "THE_PAGE_CTX_NEW"
}
# 错误码
错误码 | 错误描述 |
---|---|
公共错误码 | - |
40003 | OpenID不正确 |
10021001 | 优惠券状态不对 |
10021036 | 分页拉优惠券列表,页码与上次请求相差过大 |
10021037 | 优惠券不存在 |
# 枚举值
# status
优惠券状态
枚举字段 | 枚举值 | 描述 |
---|---|---|
COUPON_USER_STATUS_VALID | 100 | 生效中 |
COUPON_USER_STATUS_EXPIRED | 101 | 已过期 |
COUPON_USER_STATUS_USED | 102 | 已使用 |