淘宝开放平台

登录
文档中心 > API类目 > XSPACE餐饮行业服务API

XSPACE餐饮行业服务API

qimen.alibaba.cco.xspace.catering.coupon.historylist.get (XSpace工作台获取用户券历史列表)

获取餐饮行业客户会员券历史列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
foreignId String 必须 e3oddir184931d 商户会员id，会员唯一标识
couponType String 可选 XXX 满减券，优惠券等枚举类型
pageNo Number 必须 1 分页码，1开始
pageSize Number 必须 40 每页的数据数量
startDate String 可选 2021-12-11 12:12:12 检索开始日期
endDate String 可选 2021-12-12 12:12:12 检索结束日期

响应参数

名称 类型 示例值 描述
result Result 业务接口响应结果
  • couponHistoryList
  • CouponHistoryItem []
  • 历史券列表
  • └ couponId
  • String
  • 20201399391
  • 券id
  • └ couponName
  • String
  • 满4-1
  • 券名
  • └ couponType
  • String
  • COUPON
  • 券类型
  • └ couponPrice
  • Number
  • 2000
  • 券面额
  • └ writeoffOrderID
  • String
  • 2020192929102931
  • 核销订单id
  • └ writeoffChannel
  • String
  • APP
  • 核销渠道
  • └ writeoffDate
  • String
  • 2021-2-13 12:12:12
  • 核销日期
  • └ pageNo
  • Number
  • 1
  • 分页码
  • └ pageSize
  • Number
  • 40
  • 每页数量
  • └ totalCount
  • Number
  • 300
  • 总数
msgCode Number 200 返回错误码，和http status保持概念相同
errorSubCode String coupon-server-error 错误子码
errorSubMessage String 优惠券服务错误 具体错误描述

请求示例

{"foreignId":"e3oddir184931d","endDate":"2021-12-12 12:12:12","couponType":"XXX","pageNo":1,"pageSize":40,"startDate":"2021-12-11 12:12:12"}

响应示例

{
    "result":{
        "couponHistoryList":[
            {
                    "couponId":"20201399391",
                    "couponName":"满4-1",
                    "couponType":"COUPON",
                    "couponPrice":2000,
                    "writeoffOrderID":"2020192929102931",
                    "writeoffChannel":"APP",
                    "writeoffDate":"2021-2-13 12:12:12"
            }
        ],
        "pageNo":1,
        "pageSize":40,
        "totalCount":300
    },
    "msgCode":200,
    "errorSubCode":"coupon-server-error",
    "errorSubMessage":"优惠券服务错误"
}

验签示例

{"errorSubCode":"sign-check-failure","errorSubMessage":"Illegal request","msgCode":"不等于200"}

错误码解释

错误码 错误描述 解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问
返回
顶部