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

qimen.alibaba.cco.xspace.catering.coupon.writeofflist.get (XSpace工作台获取用户券核销记录列表)

获取餐饮行业客户会员券核销记录列表

公共参数

请求地址：

环境	HTTP请求地址
正式环境	http://qimen.api.taobao.com/router/qm
测试环境	http://qimen.api.taobao.com/router/qmtest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
customerId	String	是	WMS颁发给用户的ID
sign_method	String	是	签名的摘要算法，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。

请求参数

名称	类型	是否必须	示例值	描述
foreignId	String	必须	e3oddir184931d	商户会员id，会员唯一标识
pageNo	Number	必须	1	分页码，1开始
pageSize	Number	必须	40	每页的数据数量
startDate	String	可选	2021-12-15 01:00:00	检索的开始时间
endDate	String	可选	2021-12-16 01:00:00	检索的结束时间

响应参数

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

请求示例

{"foreignId":"e3oddir184931d","endDate":"2021-12-16 01:00:00","pageNo":1,"pageSize":40,"startDate":"2021-12-15 01:00:00"}

响应示例

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

验签示例

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

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部

开放平台

XSPACE餐饮行业服务API

qimen.alibaba.cco.xspace.catering.coupon.writeofflist.get (XSpace工作台获取用户券核销记录列表)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ