# 获取优惠券详情 > 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。 接口英文名：getcoupon 通过该接口可获取优惠券详情信息。 [营销管理开发指南](/doc/store/shop/guide/marketing/coupon) ## 1. 调用方式 ### HTTPS 调用 ```bash POST https://api.weixin.qq.com/channels/ec/coupon/get?access_token=ACCESS_TOKEN ``` ### 云调用 - 调用方法：channels.ec.coupon.get - 出入参和 HTTPS 调用相同，调用方式可查看 [云调用](/doc/oplatform/developers/dev/cloudCall.md) 说明文档。 ### 第三方调用 - 本接口支持第三方平台代微信小店商家调用。[第三方服务商调用模式介绍](/doc/store/shop/dev_before/third_party_platforms) - 该接口所属的权限集 id 为：132 - 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代微信小店商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。 ## 2. 请求参数 ### 查询参数 `Query String Parameters` ```json [ { "参数名": "access_token", "类型": "string", "必填": "是", "说明": "接口调用凭证，可使用 [access_token](/doc/store/shop/API/apimgnt/common/api_getaccesstoken)（微信小店商家）、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)（服务商代调用）" } ] ``` ### 请求体 `Request Payload` ```json [ { "参数名": "coupon_id", "类型": "string", "必填": "是", "示例": "123456789", "说明": "优惠券 ID" } ] ``` ## 3. 返回参数 ### 返回体 `Response Payload` ```json [ { "参数名": "errcode", "类型": "number", "示例": "0", "说明": "错误码" }, { "参数名": "errmsg", "类型": "string", "示例": "ok", "说明": "错误信息" }, { "参数名": "coupon", "类型": "object", "示例": "", "说明": "优惠券信息" } ] ``` ### Res.coupon `Object Payload` 优惠券信息 ```json [ { "参数名": "coupon_id", "类型": "string", "说明": "优惠券 ID", "枚举": "-" }, { "参数名": "type", "类型": "number", "说明": "优惠券类型", "枚举": "枚举值" }, { "参数名": "status", "类型": "number", "说明": "优惠券状态", "枚举": "枚举值" }, { "参数名": "create_time", "类型": "number", "说明": "优惠券创建时间（秒级时间戳）", "枚举": "-" }, { "参数名": "update_time", "类型": "number", "说明": "优惠券更新时间（秒级时间戳）", "枚举": "-" }, { "参数名": "coupon_info", "类型": "object", "说明": "优惠券内容信息", "枚举": "-" }, { "参数名": "stock_info", "类型": "object", "说明": "库存信息", "枚举": "-" } ] ``` ### Res.coupon.coupon_info `Object Payload` 优惠券内容信息 ```json [ { "参数名": "name", "类型": "string", "说明": "优惠券名称" }, { "参数名": "promote_info", "类型": "object", "说明": "推广信息" }, { "参数名": "discount_info", "类型": "object", "说明": "优惠信息" }, { "参数名": "receive_info", "类型": "object", "说明": "领取信息" }, { "参数名": "valid_info", "类型": "object", "说明": "有效期信息" }, { "参数名": "ext_info", "类型": "object", "说明": "扩展信息" } ] ``` ### Res.coupon.coupon_info.promote_info `Object Payload` 推广信息 ```json [ { "参数名": "promote_type", "类型": "number", "说明": "推广类型。1=小店内推广，9=会员券，10=会员开卡礼券" } ] ``` ### Res.coupon.coupon_info.discount_info `Object Payload` 优惠信息 ```json [ { "参数名": "discount_condition", "类型": "object", "说明": "优惠门槛" }, { "参数名": "discount_num", "类型": "number", "说明": "折扣数，5000=5折" }, { "参数名": "discount_fee", "类型": "number", "说明": "减免金额，单位为分" } ] ``` ### Res.coupon.coupon_info.discount_info.discount_condition `Object Payload` 优惠门槛 ```json [ { "参数名": "product_cnt", "类型": "number", "说明": "件数门槛" }, { "参数名": "product_price", "类型": "number", "说明": "价格门槛，单位为分" }, { "参数名": "product_ids", "类型": "array", "说明": "指定商品 id 列表" } ] ``` ### Res.coupon.coupon_info.receive_info `Object Payload` 领取信息 ```json [ { "参数名": "start_time", "类型": "number", "说明": "领用开始时间（秒级时间戳）" }, { "参数名": "end_time", "类型": "number", "说明": "领用结束时间（秒级时间戳）" }, { "参数名": "limit_num_one_person", "类型": "number", "说明": "单人限领张数" }, { "参数名": "total_num", "类型": "number", "说明": "领用总数" } ] ``` ### Res.coupon.coupon_info.valid_info `Object Payload` 有效期信息 ```json [ { "参数名": "valid_type", "类型": "number", "说明": "有效期类型。1=指定时间范围，2=生效天数" }, { "参数名": "valid_day_num", "类型": "number", "说明": "有效天数，valid_type=2 时有意义" }, { "参数名": "start_time", "类型": "string", "说明": "有效期开始时间，valid_type=1 时有意义" }, { "参数名": "end_time", "类型": "string", "说明": "有效期结束时间，valid_type=1 时有意义" } ] ``` ### Res.coupon.coupon_info.ext_info `Object Payload` 扩展信息 ```json [ { "参数名": "jump_product_id", "类型": "string", "说明": "领取后跳转的商品 id" }, { "参数名": "notes", "类型": "string", "说明": "备注信息" }, { "参数名": "valid_time", "类型": "number", "说明": "优惠券有效时间（秒级时间戳）" }, { "参数名": "invalid_time", "类型": "number", "说明": "优惠券失效时间（秒级时间戳）" } ] ``` ### Res.coupon.stock_info `Object Payload` 库存信息 ```json [ { "参数名": "issued_num", "类型": "number", "说明": "优惠券剩余量" }, { "参数名": "receive_num", "类型": "number", "说明": "优惠券领用量" }, { "参数名": "used_num", "类型": "number", "说明": "优惠券已用量" } ] ``` ## 4. 枚举信息 ### Res.coupon.type `Enum` 优惠券类型 ```json [ { "枚举值": "1", "描述": "商品条件折券" }, { "枚举值": "2", "描述": "商品满减券" }, { "枚举值": "3", "描述": "商品统一折扣券" }, { "枚举值": "4", "描述": "商品直减券" }, { "枚举值": "101", "描述": "店铺条件折扣券" }, { "枚举值": "102", "描述": "店铺满减券" }, { "枚举值": "103", "描述": "店铺统一折扣券" }, { "枚举值": "104", "描述": "店铺直减券" } ] ``` ### Res.coupon.status `Enum` 优惠券状态 ```json [ { "枚举值": "1", "描述": "编辑中" }, { "枚举值": "2", "描述": "已生效" }, { "枚举值": "3", "描述": "已过期" }, { "枚举值": "4", "描述": "已作废" }, { "枚举值": "5", "描述": "已删除" } ] ``` ## 5. 注意事项 本接口无特殊注意事项 ## 6. 代码示例 请求示例 ```json { "coupon_id": "123456789" } ``` 返回示例 ```json { "errcode": 0, "errmsg": "ok", "coupon": { "coupon_id": "123456789", "type": 103, "status": 2, "create_time": 1594885385, "update_time": 1594886327, "coupon_info": { "name": "全店9.9折券", "promote_info": { "promote_type": 1 }, "discount_info": { "discount_num": 9900 }, "receive_info": { "start_time": 1673110742, "end_time": 1673196742, "limit_num_one_person": 1, "total_num": 100 }, "valid_info": { "valid_type": 1, "start_time": 1594828800, "end_time": 1595433600 } }, "stock_info": { "issued_num": 95, "receive_num": 3, "used_num": 2 } } } ``` ## 7. 错误码 以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/store/shop/dev_before/commErrCode)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。 ```json [ { "错误码": "10021037", "错误描述": "优惠券不存在" } ] ``` ## 8. 适用范围 本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明，均不可调用。