xiaodian.promotion.pageQueryShopCouponByTime

  • 免费
  • 无需授权

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

输入参数

名称 类型 必选 描述 示例值
queryCouponReqDTO Object 优惠券请求参数
updateStartTime Number 开始时间(时间戳)开始时间-结束时间不得大于24小时
updateEndTime Number 结束时间(时间戳)
pageNum Number 当前页
pageSize Number 分页数 最大30

返回参数

名称 类型 描述 默认值
status Object 状态
code String
msg String
result Object 数据
data Object 分页参数,总记录数
total Number 分页参数,页大小,默认30
pages Number 分页参数,页号
pageSize Number 分页参数,页总数
list Object[] 结果集
list_object Object
shopCouponRuleParam Object 优惠券使用规则
limitPrice Number 满金额(分)
cutPrice Number 满减券:减金额(分)
discount String 折扣券:折扣,例如:99 - 代表9.9折,折扣范围0<discount<100
promotionLimit String 折扣券:优惠上限(分)
usePreconditions Number[] 使用优惠券的前提条件:空-代表无使用限制;1-代表不可与拼团或限时折扣叠加使用
rangeType Number 优惠券适用范围:1-全店券,2-商品券
campaignId String 优惠券对应的活动Id
created Number 用户领券的时间,时间戳
thirdBizId String 优惠券三方来源Id,若三方发券则为对应的requestId
source Number 买家资源来源
couponId String 买家资源id
couponType Number 优惠券类型:1-减元券,2-折扣券
startTime Number 优惠券有效期:开始时间
buyerUserId Number 锐鲨系统内的用户Id
endTime Number 优惠券有效期:结束时间
extraInfo Object
canGiving Boolean 是否支持转赠
name String 优惠券名字
thirdPartyParam Object 三方特殊参数
thirdCouponId String 三方系统内优惠券Id
status Number 0 未使用 ;1 已使用;2 已过期;
isEnd Boolean 是否结束
pageNum Number 分页参数,页号
success Boolean 是否成功

请求参数示例

1).
{ "queryCouponReqDTO":{ "updateStartTime":1596441363, "updateEndTime":1596517762, "pageNum":1, "pageSize":1 } }

返回示例

1).
{ "status":{ "code":"0000000", "msg":"操作成功" }, "result":{ "data":{ "total":5, "pages":3, "pageSize":2, "list":[ { "shopCouponRuleParam":{ "limitPrice":400, "cutPrice":300 }, "rangeType":1, "campaignId":"15ug", "created":1530691403, "thirdBizId":"", "source":13, "couponId":"1d9g", "couponType":1, "startTime":1530690366, "buyerUserId":157551458, "endTime":1532504769, "extraInfo":{ "canGiving":false, "name":"心璨-0704-1" }, "status":2 }, { "shopCouponRuleParam":{ "limitPrice":500, "cutPrice":400 }, "rangeType":1, "campaignId":"15ui", "created":1531125994, "thirdBizId":"", "source":13, "couponId":"1dac", "couponType":1, "startTime":1530690366, "buyerUserId":157551458, "endTime":1532504769, "extraInfo":{ "canGiving":false, "name":"心璨-0704-1" }, "status":2 } ], "isEnd":true, "pageNum":3 } }, "success":true }

异常示例