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

qimen.alibaba.cco.xspace.catering.memberpoints.list.get (XSpace工作台获取积分列表)

获取餐饮行业客户会员积分

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
foreignId String 必须 e3oddir184931d 商户会员id,会员唯一标识
startDate String 可选 2021-02-21 12:12:12 积分列表搜索开始的日期
endDate String 可选 2021-03-21 12:12:12 积分列表搜索结束的日期
pageNo Number 必须 1 分页码,1开始
pageSize Number 必须 40 每页的数据数量

响应参数

名称 类型 示例值 描述
msgCode Number 200 返回错误码,和http status保持概念相同
errorSubCode String points-server-error 错误子码
errorSubMessage String 积分服务错误 具体错误描述
result Result 业务接口响应结果
  • pointsList
  • PointsItem []
  • 获取积分列表
  • └ channel
  • String
  • ORDER
  • 积分来源渠道
  • └ orderId
  • String
  • 202219931992103949
  • 积分兑换来源订单,如channel不为order,则空
  • └ getDate
  • String
  • 2021-2-13 11:12:13
  • 获取时间
  • └ invalidDate
  • String
  • 2022-3-15 12:12:12
  • 失效时间
  • └ pointsAmount
  • Number
  • 300
  • 获取的积分数量
  • └ pointsUnit
  • String
  • 积分单位,如星星,分,点等
  • └ pointsStatus
  • String
  • INVALID
  • 积分状态
  • └ pointsDetailed
  • String
  • 消费167.2元-小程序下单-中区广场店
  • 积分明细(积分获取明细)
  • └ orderType
  • String
  • 配送订单
  • 订单类型
  • └ orderModelType
  • String
  • 1
  • 订单模型类型【仅区分外卖与自提】枚举值: 外卖为1 自提为2
  • └ pageNo
  • Number
  • 1
  • 分页页码
  • └ pageSize
  • Number
  • 40
  • 分页每页数量
  • └ totalCount
  • Number
  • 329
  • 记录总条数

请求示例

{"foreignId":"e3oddir184931d","endDate":"2021-03-21 12:12:12","pageNo":1,"pageSize":40,"startDate":"2021-02-21 12:12:12"}

响应示例

{
    "msgCode":200,
    "errorSubCode":"points-server-error",
    "errorSubMessage":"积分服务错误",
    "result":{
        "pointsList":[
            {
                    "channel":"ORDER",
                    "orderId":"202219931992103949",
                    "getDate":"2021-2-13 11:12:13",
                    "invalidDate":"2022-3-15 12:12:12",
                    "pointsAmount":300,
                    "pointsUnit":"分",
                    "pointsStatus":"INVALID",
                    "pointsDetailed":"消费167.2元-小程序下单-中区广场店",
                    "orderType":"配送订单",
                    "orderModelType":"1"
            }
        ],
        "pageNo":1,
        "pageSize":40,
        "totalCount":329
    }
}

验签示例

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

错误码解释

错误码 错误描述 解决方案

API工具

FAQ

返回
顶部