## 获取单条优惠券信息(couponRead) >[info] 场景说明:查询单条优惠券信息,了解优惠券开始及结束时间、是否支持点击领取、剩余可领取数量等信息 ### 是否需要获取用户TOKEN `否` ***** ### 请求地址 ``` POST http://api.xxx.com/coupon/read ``` ### 公共请求参数 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | 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`格式 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | coupon\_id | integer | 必须 | 优惠券ID | ### 请求示例 ``` { "appid": "您的APPID", "version": "v3", "sign_type": "md5", "timestamp": "2020-8-10 12:00:00", "format": "json", "sign": "op0987yhjmngt54rtg2wgdfvcder2765", "params": { "coupon_id": 2 } } ``` ***** ### 公共返回参数 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | code | integer | 必须 | 0=成功,其它值代表请求失败的错误代码,请参考:[公共错误码](response-code.md) | | message | string | 必须 | 请求成功/失败的描述信息 | | data | array | 必须 | 返回结果,如果没有数据则返回空 | 返回`data`参数格式 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | coupon\_id | integer | 必须 | 优惠券ID | | coupon\_name | string | 必须 | 优惠券名称 | | image | string | 可选 | 优惠券广告图 | | coupon\_value | decimal | 必须 | 优惠券金额 | | min\_amount | integer | 必须 | 满多个元可用 | | total | integer | 必须 | 优惠券总数(领完即止),0代表不限制 | | surplus | integer | 必须 | 剩余优惠券数量 | | start\_time | string | 必须 | 优惠券开始时间,格式:yyyy-mm-dd hh::ii::ss | | end\_time | string | 必须 | 优惠券结束时间,格式:yyyy-mm-dd hh::ii::ss | | if\_issue | integer | 必须 | 是否为已发布的优惠券,1=已发布、0=未发布。只有已发布的优惠券才可自由点击领取 或 卖家定向发放 | | clickrecieve | integer | 必须 | 是否支持点击领取,1=支持、0=不支持。只有支持点击领取的优惠券才可以开放给买家自由领取,反之只能通过店家定向发放 | | store\_id | integer | 必须 | 店铺ID | | store\_name | string | 必须 | 店铺名称 | | store\_logo | string | 必须 | 店铺LOGO | ### 返回数据示例 ``` { "code": 0, "message": "成功", "data": { "coupon_id": 1, "coupon_name": "双十一优惠", "coupon_value": 10.00, "min_amount": 100.00, "image": "", "total": 1000, "surplus": 980, "start_time": "2019-11-11 00:00:00", "end_time": "2019-11-11 23:59:59", "if_issue": 1, "clickreceive": 1, "store_id": 2, "store_name": "演示店铺", "store_logo": "http://www.xxx.com/data/files/store_2/other/store_logo.jpg" } } ```