淘宝开放平台

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

XSPACE餐饮行业服务API

qimen.alibaba.cco.xspace.catering.coupon.assetslist.get (XSpace工作台获取用户券资产列表)

获取餐饮行业客户会员券资产列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
foreignId String 必须 e3oddir184931d 商户会员id，会员唯一标识
couponType String 可选 XXX 满减券，优惠券等枚举类型
pageNo Number 必须 1 分页码，1开始
pageSize Number 必须 40 每页的数据数量
startDate String 可选 2021-12-12 12:12:!2 检索开始日期
endDate String 可选 2021-12-13 12:12:12 检索结束日期
couponId String 可选 184931234 优惠券id
couponName String 可选 满4-1 优惠券名称
couponStatus String 可选 可使用 券状态，tims枚举为: 可使用、已过期、已使用、已转赠
status String 可选 1 券作废状态：（1-正常；0-作废）

响应参数

名称 类型 示例值 描述
msgCode Number 200 返回错误码，和http status保持概念相同
errorSubCode String coupon-server-error 错误子码
errorSubMessage String 优惠券服务错误 具体错误描述
result Result 业务接口响应结果
  • couponAssetsList
  • CouponAssetsItem []
  • 优惠券资产列表
  • └ couponId
  • String
  • 20201399391
  • 优惠券id
  • └ couponName
  • String
  • 满4-1
  • 优惠券名称
  • └ couponType
  • String
  • COUPON
  • 优惠券枚举类型，满减，免费兑换，折扣券等
  • └ getCouponDate
  • String
  • 2021-2-13 12:12:12
  • 购买时间
  • └ getCouponPrice
  • Number
  • 2000
  • 购买优惠券价格（总价）
  • └ isAllChannel
  • Boolean
  • false
  • 是否全渠道使用
  • └ useWithOtherCoupon
  • Boolean
  • true
  • 是否可以和其他券一起使用
  • └ validStartDate
  • String
  • 2021-2-13 12:12:12
  • 有效期开始时间【券的有效期】
  • └ validEndDate
  • String
  • 2021-2-14 12:12:12
  • 有效期结束时间【券的有效期】
  • └ validUseStartDate
  • String
  • 2021-2-12 12:12:12
  • 可用开始时间【券的日常使用限制时间】
  • └ validUseEndDate
  • String
  • 2021-2-13 12:12:12
  • 可用结束时间【券的日常使用限制时间】
  • └ orderId
  • String
  • 2020192929102931
  • 订单编号（若券为购买方式获取 对应的订单号）
  • └ isDonate
  • Boolean
  • false
  • 是否赠送
  • └ donateDate
  • String
  • 2021-2-13 12:12:12
  • 获赠时间
  • └ donateMemberId
  • String
  • kd913ka10do1
  • 转赠会员id
  • └ getCouponChannel
  • String
  • APP
  • 获取券的渠道
  • └ useCouponChannel
  • String
  • APP,ALIPAY
  • 可使用券的渠道
  • └ useRules
  • String
  • 本券XXXX只能XXX不能XXX
  • 使用规则
  • └ voided
  • Boolean
  • false
  • 是否已经作废
  • └ used
  • Boolean
  • false
  • 是否已经使用
  • └ deferred
  • Boolean
  • false
  • 是否已经延期
  • └ refunded
  • Boolean
  • false
  • 是否已经是退款中
  • └ canDelay
  • Boolean
  • true
  • 是否能延期
  • └ donateReceiveMemberId
  • String
  • kd913ka10do2
  • 接收人会员ID
  • └ status
  • String
  • 1
  • 券作废状态：（1-正常；0-作废）
  • └ couponStatus
  • String
  • 1
  • 券状态，tims枚举为: 可使用、已过期、已使用、已转赠
  • └ pageNo
  • Number
  • 1
  • 分页码
  • └ pageSize
  • Number
  • 40
  • 每页数量
  • └ totalCount
  • Number
  • 300
  • 总数

请求示例

{"foreignId":"e3oddir184931d","couponName":"满4-1","endDate":"2021-12-13 12:12:12","couponType":"XXX","pageNo":1,"couponStatus":"可使用","pageSize":40,"couponId":"184931234","startDate":"2021-12-12 12:12:!2","status":"1"}

响应示例

{
    "msgCode":200,
    "errorSubCode":"coupon-server-error",
    "errorSubMessage":"优惠券服务错误",
    "result":{
        "couponAssetsList":[
            {
                    "couponId":"20201399391",
                    "couponName":"满4-1",
                    "couponType":"COUPON",
                    "getCouponDate":"2021-2-13 12:12:12",
                    "getCouponPrice":2000,
                    "isAllChannel":false,
                    "useWithOtherCoupon":true,
                    "validStartDate":"2021-2-13 12:12:12",
                    "validEndDate":"2021-2-14 12:12:12",
                    "validUseStartDate":"2021-2-12 12:12:12",
                    "validUseEndDate":"2021-2-13 12:12:12",
                    "orderId":"2020192929102931",
                    "isDonate":false,
                    "donateDate":"2021-2-13 12:12:12",
                    "donateMemberId":"kd913ka10do1",
                    "getCouponChannel":"APP",
                    "useCouponChannel":"APP,ALIPAY",
                    "useRules":"本券XXXX只能XXX不能XXX",
                    "voided":false,
                    "used":false,
                    "deferred":false,
                    "refunded":false,
                    "canDelay":true,
                    "donateReceiveMemberId":"kd913ka10do2",
                    "status":"1",
                    "couponStatus":"1"
            }
        ],
        "pageNo":1,
        "pageSize":40,
        "totalCount":300
    }
}

验签示例

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

错误码解释

错误码 错误描述 解决方案

API工具

错误码查询工具 SDK下载

FAQ

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