API 列表

xiaodian.promotion.getShopCouponById

  • 免费
  • 无需授权

API功能描述(支持get和post)

查询指定优惠券详情

公共参数

名称 类型 必选 描述
app_key Long 是 接入时申请的app_key
method String 是 接口名称
access_token String 是 Oauth2.0授权获得的access_token
sign String 是 对 API 调用参数（除sign外）进行 md5 加密获得。参数的顺序为字母表的顺序
timestamp Long 是 时间戳，使用Unix时间戳格式
format String 是 响应格式。默认为json格式，固定
sign_method String 否 参数的加密方法选择，当前只支持Md5
version String 否 API协议版本，固定值为：1.0

输入参数

名称 类型 必选 描述 示例值
getCouponReqDTO Object 是 优惠券请求参数
couponId String 是 用户拥有的优惠券唯一Id

返回参数

名称 类型 描述 默认值
result Object 结果
data Object 数据
couponId String 用户拥有的优惠券唯一Id
created Number 用户领券的时间，时间戳
campaignId String 优惠券对应的活动Id
buyerUserId Number 锐鲨系统内的用户Id
memberId String 三方用户Id
status String 优惠券状态：0-未使用，1-已使用，2-已过期，4-赠送中，5-已赠送
startTime Number 优惠券有效期：开始时间
endTime Number 优惠券有效期：结束时间
rangeType Number 优惠券适用范围：1-全店券，2-商品券
couponType Number 优惠券类型：1-满元券，2-满折券
shopCouponRuleParam Object 优惠券使用规则
limitPrice Number 满金额(分)
cutPrice Number 满减券：减金额(分)
discount Number 折扣券：折扣，例如：99 - 代表9.9折，折扣范围0<discount<100
promotionLimit Number 折扣券：优惠上限(分)
usePreconditions Number[] 使用优惠券的前提条件:空-代表无使用限制;1-代表不可与拼团或限时折扣叠加使用
exclusiveRange Boolean 是否排除指定商品不可用-True 排除指定商品不可用
extraInfo Object 优惠券其他信息
name String 优惠券名称
canGiving Boolean 优惠券是否支持转赠
thirdPartyParam Object 三方特殊参数
thirdCouponId String 三方系统内优惠券Id
thirdBizId String 优惠券三方来源Id，若三方发券则为对应的requestId
status Object 状态
code String 状态码
msg String 信息

请求参数示例

1).
{
    "getCouponReqDTO":{
        "couponId":"13emys"
    }
}

返回示例

1).
{
	"status": {
		"code": "0000000",
		"msg": "操作成功"
	},
	"result": {
		"data": {
			"shopCouponRuleParam": {
				"limitPrice": 22200,
				"cutPrice": 1200
			},
			"rangeType": 1,
			"campaignId": "11r8y",
			"created": 1587612169,
			"thirdBizId": "",
			"source": 52,
			"couponId": "13emys",
			"couponType": 1,
			"startTime": 1587533615,
			"buyerUserId": 1514517401,
			"endTime": 1587706417,
			"extraInfo": {
				"canGiving": false,
				"name": "拾迹の小店"
			},
			"memberId": "S20042033M8AV",
			"status": 2
		}
	},
	"success": true
}

异常示例

API测试工具