## 获取我的优惠券列表(myCouponList) >[info] 场景说明:获取我已成功领取的优惠券列表数据 ### 是否需要获取用户TOKEN `是` ***** ### 请求地址 ``` POST http://api.xxx.com/my/coupon/list ``` ### 公共请求参数 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | appid | string | 必须 | 平台提供的唯一APPID | | version | string | 必须 | 接口版本号,固定填:v3 | | sign\_type | string | 必须 | 签名类型,目前只支持md5 | | timestamp | string | 必须 | 发起时间戳,格式为:yyyy-mm-dd hh::ii::ss | | format | string | 必须 | 返回的数据格式,只支持json | | sign | string | 必须 | 请求参数的签名,请参考:[签名规则](signature.md) | | token | string | 必须 | 用户TOKEN | | params | string | 必须 | 请求参数的集合,除公共参数外,所有请求参数都必须放在这个参数中传递,json\_encode后送入 | 应用请求参数`params`格式 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | page | integer | 可选 | 当前页 | | page\_size | integer | 可选 | 每页读取多少条记录,默认10条 | ### 请求示例 ``` { "appid": "您的APPID", "version": "v3", "sign_type": "md5", "timestamp": "2020-8-10 12:00:00", "format": "json", "sign": "op0987yhjmngt54rtg2wgdfvcder2765", "params": { "page": 1 } } ``` ***** ### 公共返回参数 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | code | integer | 必须 | 0=成功,其它值代表请求失败的错误代码,请参考:[公共错误码](response-code.md) | | message | string | 必须 | 请求成功/失败的描述信息 | | \+ data | array | 必须 | 返回结果,如果没有数据则返回空 | | └ list | list | 必须 | 优惠券列表 | | └ pagination | array | 必须 | 分页信息 | 返回`data->list`参数格式 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | coupon\_id | integer | 必须 | 优惠券ID | | coupon\_sn | string | 必须 | 优惠券编号 | | coupon\_name | string | 必须 | 优惠券名称 | | coupon\_value | decimal | 必须 | 优惠券金额 | | min\_amount | integer | 必须 | 满多个元可用 | | start\_time | string | 必须 | 优惠券开始时间,格式:yyyy-mm-dd hh::ii::ss | | end\_time | string | 必须 | 优惠券结束时间,格式:yyyy-mm-dd hh::ii::ss | | valid | integer | 必须 | 是否有效,1=有效、0=无效(比如过期了) | | store\_id | integer | 必须 | 店铺ID | | store\_name | string | 必须 | 店铺名称 | | store\_logo | string | 必须 | 店铺LOGO | 返回`data->pagination`参数格式 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | page | integer | 必须 | 当前页 | | page\_size | integer | 必须 | 每一页显示的数据量 | | page\_count | integer | 必须 | 总页数 | | total | integer | 必须 | 总记录数 | ### 返回数据示例 ``` { "code": 0, "message": "成功", "data": { "list": [ { "coupon_id": 1, "coupon_sn": "02660090", "coupon_name": "双十一优惠", "coupon_value": 10.00, "min_amount": 100.00, "start_time": "2019-11-11 00:00:00", "end_time": "2019-11-11 23:59:59", "store_id": 2, "store_name": "演示店铺", "store_logo": "http://www.xxx.com/data/files/store_2/other/store_logo.jpg", "valid": 1 } ], "pagination": { "page":1, "page_size":10, "page_count":1, "total":1 } } } ```