开发指南
API
官网
API 2.0
API 2.0 > 2.5 优惠券 > 2.5.3 根据核销码获取券详情

2.5.3 根据核销码获取券详情

开启令牌和权限后可调用。签名方式请查看开发指南
场景描述： 包括券基本信息和券规则信息
零售

请求地址

请求方式 版本信息 请求地址
POST V2 http://openapi.zvcms.com/api/v2

公共参数

参数 参数类型 是否必填 默认值 描述
OpenId string 是 密钥Id
GrantCode string 是 授权code
Token string 是 签名，参考《数字签名sign》
Timestamp string 是 当前时间戳
Nonce string 是 随机正整数
Action string 是 coupon.off-coupon 接口方法
Params array 是 业务参数

请求参数

参数 参数类型 是否必填 默认值 描述
code string 是 核销码（20191202089026199489）

响应参数

参数 参数类型 描述
id int 用户优惠券id
user_id int 用户id
coupon_id string 优惠券id
start_at int 开始时间
end_at int 结束时间
status int 状态 0-未使用 1-已使用 2：锁定
type_id int 类型0-领取 1-满减/送 2 会员卡赠送
verify_code int 核销码【对应请求参数code】
verify_code_barcode string 条形码
verify_code_qrcode string 二维码
verifier_name string 核销人
created_at int 领取时间
is_lock int ：放，2:锁
coupon array
 ├id int 优惠券id
 ├title string 优惠券名称
 ├amount string 优惠券金额/折扣
 ├coupon_type int 优惠形式 0-指定金额 1-折扣券
 ├min_amount_use int 最低使用金额， 0 -不限制
 ├goods_range_type int 可使用的商品\r\n0-所有商品 \r\n1-指定分类可用 \r\n2-指定商品可用 \r\n3-指定商品不可用
 ├expire_type int 有效期类型0-固定日期 1-领到券当日开始N天内生效 2-领到券次日开始N天内生效
 ├desc string 使用说明
 ├shop_range_type int 适用门店0-所有门店 1-指定门店可用 2-指定门店不可用
 ├total Int 优惠券总数量 0-不限制
 ├number Int 已领取的数量
 ├used Int 已使用的数量
 ├number_of_user int 每人限领多少张 0-不限制
 ├start_at int 开始时间
 ├end_at int 结束时间
 ├expire_days int N天内生效的N
 ├status int 状态，是否可用 0不可用 1 可用
 ├created_at int 创建时间1571993584
 ├updated_at int 更新时间
 ├show_page int 是否显示在商品详情页
 ├is_view int 是否显示：1是0否
 ├is_share int 是否共享：0否1是
 ├user_receive_type int 用户获取方式，1：领取，2：兑换（兑换码）
 ├use_scene int 使用场景 0 全部 1 线上 2 线下
 ├apply_stores array
  ├0 array
   ├id int 门店id
   ├name string 门店名称
   ├address string 门店地址地址
   ├work_status string 门店状态
   ├sn string 门店编码
 ├expire_date string 券时间段
 ├expire_date_text string 券时间段
 ├expire_date_text2 string 券时间段
 ├use_scene_text string 适用场景文本表示（线上，线下，通用）
 ├use_format string 满多少元可用文本表示
 ├good_ids array 适用商品
 ├shop_ids array 适用门店
 ├apply_goods array
  ├0 array
   ├tag_name string 该优惠券指定的使用的商品编码
   ├name string 该优惠券指定的使用的商品名称
use_scene int 使用场景 0 全部 1 线上 2 线下
activity_id int 活动id
poly_status int poly_status 1

请求示例

{
    "OpenId": "6dc05b4ac175cf316d226252b05cf685",
    "GrantCode": "782c281f62",
    "Timestamp": "1547186244",
    "Nonce": "658965",
    "Token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "Action": "coupon.off-coupon",
    "Params": {
        "code": "20191031966176899187"
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": {
        "id": "20074550",
        "user_id": "100001138",
        "coupon_id": "20001497",
        "start_at": "1572537600",
        "end_at": "1572537600",
        "status": "0",
        "type_id": "0",
        "verify_code": "20191031966176899187",
        "verify_code_barcode": "",
        "verify_code_qrcode": "",
        "verifier_name": "",
        "created_at": "1572481817",
        "is_lock": "1",
        "coupon": {
            "id": "20001497",
            "title": "测试优惠券111",
            "amount": "10",
            "coupon_type": "0",
            "min_amount_use": "20",
            "goods_range_type": "2",
            "expire_type": "2",
            "desc": "使用说明测试",
            "shop_range_type": "1",
            "total": "20",
            "number": "20",
            "used": "0",
            "number_of_user": "1",
            "start_at": "",
            "end_at": "",
            "expire_days": "20",
            "status": "1",
            "created_at": "1571993584",
            "updated_at": "1571993584",
            "show_page": "0",
            "is_view": "1",
            "is_share": "1",
            "user_receive_type": "1",
            "use_scene": "1",
            "apply_stores": [
                {
                    "id": "283",
                    "name": "测试中，勿动1",
                    "address": "创新产业园c1栋222",
                    "work_status": "未知",
                    "sn": "SN151046"
                }
            ],
            "expire_date": "领券次日开始20天内有效",
            "expire_date_text": "领券次日开始20天内有效",
            "expire_date_text2": "领券次日开始20天内有效",
            "use_scene_text": "线上",
            "use_format": "满20使用",
            "good_ids": "29423,29424",
            "shop_ids": "283,302",
            "apply_goods": [
                {
                    "tag_name": "12345678",
                    "name": "笑儿泡菜"
                }
            ]
        },
        "use_scene": "1",
        "activity_id": "0",
        "poly_status": "1"
    }
}

异常示例

{
    "status": true,
    "code": "异常编码，根据不同的业务返回编码",
    "message": "异常说明：查询的信息不存在"
}

错误码

{
    "status": false,
    "code": "系统错误编码：详见全局返回编码",
    "message": "系统错误说明"
}

免费升级

营销功能、插件持续每月更新开发升级

免费专业培训

每月建站、微信营销、电商等互联网增值培训

7×24小时服务支持

400电话、QQ、微信、在线等多渠道售后支持

 

安徽智迈科技股份有限公司 版权所有 Copyright 2009-2018 皖公网安备 34019202000074号 增值电信业务经营许可证：皖B2-20170075