淘宝开放平台

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

XSPACE餐饮行业服务API

qimen.alibaba.cco.xspace.catering.deliveryorder.list.get (XSpace工作台获取餐饮外卖订单列表)

XP工作台获取外卖订单列表

公共参数

请求参数

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

响应参数

名称 类型 示例值 描述
result Result 业务接口响应结果
  • deliveryOrderList
  • DeliveryOrderItem []
  • 外卖订单列表
  • └ orderId
  • String
  • 202233914856177381
  • 订单id
  • └ createDate
  • String
  • 2021-02-11 12:00:20
  • 订单创建时间
  • └ consigneeName
  • String
  • 张三
  • 收货人名字
  • └ consigneePhone
  • String
  • 133xxxxxxxx
  • 收货人手机号
  • └ payedFee
  • Number
  • 3000
  • 订单实付金额，单位分
  • └ orderStatus
  • String
  • 1
  • 订单状态，枚举类型
  • └ storeName
  • String
  • 阿里巴巴A区店
  • 门店名称
  • └ consigneeAddress
  • String
  • xx市xx区xx小区xx号101室
  • 收货地址
  • └ storeOperationTypeDesc
  • String
  • 类型
  • 门店经营类型--部分退新增
  • └ storeNo
  • String
  • 10211
  • 门店ID--部分退新增
  • └ pickNo
  • String
  • 10211
  • 取餐号--部分退新增
  • └ cityName
  • String
  • 北京
  • 城市--部分退新增
  • └ pageNo
  • Number
  • 1
  • 分页码
  • └ pageSize
  • Number
  • 40
  • 每页的数据数量
  • └ totalCount
  • Number
  • 380
  • 订单数据总量
msgCode Number 200 返回错误码，和http status保持概念相同
errorSubCode String order-service-error 错误子码
errorSubMessage String 订单服务异常 具体错误描述

请求示例

{"foreignId":"e3oddir184931d","takeMealNo":"2003","orderId":"20219933183771379391","endDate":"2021-03-21 12:12:12","pageNo":1,"orderStatuses":"0","pageSize":40,"orderChannels":"1","startDate":"2021-02-21 12:12:12"}

响应示例

{
    "result":{
        "deliveryOrderList":[
            {
                    "orderId":"202233914856177381",
                    "createDate":"2021-02-11 12:00:20",
                    "consigneeName":"张三",
                    "consigneePhone":"133xxxxxxxx",
                    "payedFee":3000,
                    "orderStatus":"1",
                    "storeName":"阿里巴巴A区店",
                    "consigneeAddress":"xx市xx区xx小区xx号101室",
                    "storeOperationTypeDesc":"类型",
                    "storeNo":"10211",
                    "pickNo":"10211",
                    "cityName":"北京"
            }
        ],
        "pageNo":1,
        "pageSize":40,
        "totalCount":380
    },
    "msgCode":200,
    "errorSubCode":"order-service-error",
    "errorSubMessage":"订单服务异常"
}

验签示例

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

错误码解释

错误码 错误描述 解决方案

API工具

错误码查询工具 SDK下载

FAQ

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