淘宝开放平台 - 文档中心

请求地址：

环境	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输入参数签名结果，签名算法介绍请点击这里。

名称	类型	是否必须	示例值	更多限制	描述
orderId	String	必须	2022918831918282912		自取订单id
foreignId	String	必须	L1i29fooe194ad		商家会员id

名称	类型	示例值	描述
result	Result		接口返回结果
orderInfo OrderInfo 订单信息 └ orderId String 20223939182819283912 订单id └ diningType String TAKEAWAY 用餐类型（堂食/外带等） └ systemOrderId String 123567 系统订单号 └ systemSerialId String 2022393918 系统流水号 └ thirdOrderId String 2029834 第三方订单号 └ thirdSerialId String 20 第三方流水号 └ customerRemark String 备注一下客户备注 └ merchantRemark String 商家备注商家备注 └ platformType String tims平台平台配送类型 └ isPlatform String 是是否平台配送 └ pickupId String 12 取餐号 └ warningMessage String 订单异常订单异常原因--部分退新增 └ totalRefundAmount String 1000 订单可退总额--部分退新增 └ totalPackageAmount String 1000 订单可退包装费总额--部分退新增 └ totalOfflineAmount String 1000 线下支付可退总额--部分退新增 └ totalDeliveryAmount String 1000 订单可退配送费总额--部分退新增 └ storeNo String 10021 门店id--部分退新增 └ refundAmount String 1000 订单可退金额--部分退新增 └ canInvoiceAmount String 1000 订单支持开票金额--部分退新增 └ orderType String 2 订单类型 └ orderStatus String 1 订单状态（含履约） └ price Number 3000 应付金额 └ realPrice Number 2000 实付金额 └ discountPrice Number 2500 优惠金额 └ merchPrice Number 1500 商品金额 └ payId String 20223939381839193 支付单号 └ payDetail String {'a': 1, 'b': 2} 支付明细，包含现金，优惠券等 └ payChannel String ALIPAY 支付渠道 discountItemList DiscountItem [] 订单优惠项列表 └ itemName String 满5-1 优惠项名称 └ itemPrice Number 1000 优惠金额 └ orderChannel String ALIPAY-MINIAPP 订单渠道 └ isBookingOrder Boolean false 是否预约单 └ cancelStatus Boolean false 是否取消订单 └ cancelSide String CUSTOMER 取消方 └ nickname String 张三用户昵称 └ cancelReason String 不想要了取消理由 └ expectMakingTime String 2021-02-11 12:00:11 预计制作时间 └ customerPickTime String 2021-02-11 12:05:11 客户自取时间 └ expectFinishTime String 2021-02-11 12:01:11 预计完成时间 └ orderScore Number 12 订单积分 timeline Timeline [] 订单时间轴 └ statusTime String 2021-02-11 12:50:11 时间轴时间 └ status String 1 时间轴状态 └ memberPhone String 139xxxxxxxx 会员手机号 └ memberLevel String 大咖会员等级 └ orderCreateDate String 2021-12-31 14:00:00 订单创建时间【下单时间】 └ orderModelType String 1 订单模型类型【仅区分外卖与自提】枚举值: 外卖为1 自提为2 storeInfo StoreInfo 门店信息 └ storeId String 2039932 门店id └ storeType String Level-1 门店类型 └ storeName String 阿里巴巴A区店门店名称 └ storePhone String 0571-8xxxxxxxx 门店电话 └ storeManPhone String 133xxxxxxxx 门店负责人电话 merchInfoList MerchInfo [] 商品信息列表 └ merchId String 84738813 商品id └ merchName String 拿铁商品名称 └ merchPhoto String https://xxx.com/merch.png 商品图片链接 └ merchSpecs String 大杯商品规格 └ merchPrice Number 2300 商品原价，单位分 └ merchDiscountPrice Number 2100 商品优惠价，单位分 └ merchCount Number 3 商品数量 └ perCouponPrice Number 20 优惠券分摊价格 merchAttrList MerchAttr [] 商品属性列表 └ name String 加奶x2 商品属性名称（包含具体种类和数量） └ price Number 100 商品属性价格，单位分 └ extraData String {'a': 1, 'b': 2} 其他扩展属性 comboInfoList ComboInfoItem [] 套餐信息列表 └ comboId String 394819 套餐id └ comboPrice Number 5000 套餐原价，单位分 └ comboDiscountPrice Number 3000 套餐折扣价，单位分 merchInfoList MerchInfoItem [] 套餐内商品列表 └ merchId String 9184919922 商品id └ merchName String 拿铁商品名称 └ merchPhoto String https://xxx.com/merch.png 商品图片链接 └ merchSpecs String 大杯商品规格 └ merchPrice Number 2300 商品原价，单位分 └ merchDiscountPrice Number 2100 商品优惠价，单位分 └ merchCount Number 3 商品数量 └ perCouponPrice Number 20 优惠券分摊价格 merchAttrList MerchAttrItem [] 商品属性列表 └ name String 加奶x2 商品属性名称（包含具体种类和数量） └ price Number 100 商品属性价格，单位分 └ extraData String {'a': 1, 'b': 2} 其他扩展属性 invoiceInfo InvoiceInfo 发票信息 └ isInvoice Boolean true 是否开票 └ invoiceTime String 2021-02-22 12:45:11 开票时间 └ invoiceType String ONLINE 开票形式，自主开票、客服人工开票 └ invoiceStatus String VAILD 发票状态（冲红冲蓝） └ invoicePrice Number 4000 开票金额 └ invoiceLink String https://xxx.com/invoice.png 发票链接 couponList CouponInfo [] couponInfo 券信息 └ paymentOtherCode String 3001177900009396268 券ID └ paymentCategoryName String 代金券券类型 └ paymentDesc String Tims咖啡20元代金券券名称
msgCode	Number	200	返回错误码，和http status保持概念相同
errorSubCode	String	order-service-error	错误子码
errorSubMessage	String	订单服务异常	具体错误描述

{"foreignId":"L1i29fooe194ad","orderId":"2022918831918282912"}

{
    "result":{
        "orderInfo":{
            "orderId":"20223939182819283912",
            "diningType":"TAKEAWAY",
            "systemOrderId":"123567",
            "systemSerialId":"2022393918",
            "thirdOrderId":"2029834",
            "thirdSerialId":"20",
            "customerRemark":"备注一下",
            "merchantRemark":"商家备注",
            "platformType":"tims平台",
            "isPlatform":"是",
            "pickupId":"12",
            "warningMessage":"订单异常",
            "totalRefundAmount":"1000",
            "totalPackageAmount":"1000",
            "totalOfflineAmount":"1000",
            "totalDeliveryAmount":"1000",
            "storeNo":"10021",
            "refundAmount":"1000",
            "canInvoiceAmount":"1000",
            "orderType":"2",
            "orderStatus":"1",
            "price":3000,
            "realPrice":2000,
            "discountPrice":2500,
            "merchPrice":1500,
            "payId":"20223939381839193",
            "payDetail":"{'a': 1, 'b': 2}",
            "payChannel":"ALIPAY",
            "discountItemList":[
                {
                        "itemName":"满5-1",
                        "itemPrice":1000
                }
            ],
            "orderChannel":"ALIPAY-MINIAPP",
            "isBookingOrder":false,
            "cancelStatus":false,
            "cancelSide":"CUSTOMER",
            "nickname":"张三",
            "cancelReason":"不想要了",
            "expectMakingTime":"2021-02-11 12:00:11",
            "customerPickTime":"2021-02-11 12:05:11",
            "expectFinishTime":"2021-02-11 12:01:11",
            "orderScore":12,
            "timeline":[
                {
                        "statusTime":"2021-02-11 12:50:11",
                        "status":"1"
                }
            ],
            "memberPhone":"139xxxxxxxx",
            "memberLevel":"大咖",
            "orderCreateDate":"2021-12-31 14:00:00",
            "orderModelType":"1"
        },
        "storeInfo":{
            "storeId":"2039932",
            "storeType":"Level-1",
            "storeName":"阿里巴巴A区店",
            "storePhone":"0571-8xxxxxxxx",
            "storeManPhone":"133xxxxxxxx"
        },
        "merchInfoList":[
            {
                    "merchId":"84738813",
                    "merchName":"拿铁",
                    "merchPhoto":"https:\/\/xxx.com\/merch.png",
                    "merchSpecs":"大杯",
                    "merchPrice":2300,
                    "merchDiscountPrice":2100,
                    "merchCount":3,
                    "perCouponPrice":20,
                    "merchAttrList":[
                        {
                                "name":"加奶x2",
                                "price":100,
                                "extraData":"{'a': 1, 'b': 2}"
                        }
                    ]
            }
        ],
        "comboInfoList":[
            {
                    "comboId":"394819",
                    "comboPrice":5000,
                    "comboDiscountPrice":3000,
                    "merchInfoList":[
                        {
                                "merchId":"9184919922",
                                "merchName":"拿铁",
                                "merchPhoto":"https:\/\/xxx.com\/merch.png",
                                "merchSpecs":"大杯",
                                "merchPrice":2300,
                                "merchDiscountPrice":2100,
                                "merchCount":3,
                                "perCouponPrice":20,
                                "merchAttrList":[
                                    {
                                            "name":"加奶x2",
                                            "price":100,
                                            "extraData":"{'a': 1, 'b': 2}"
                                    }
                                ]
                        }
                    ]
            }
        ],
        "invoiceInfo":{
            "isInvoice":true,
            "invoiceTime":"2021-02-22 12:45:11",
            "invoiceType":"ONLINE",
            "invoiceStatus":"VAILD",
            "invoicePrice":4000,
            "invoiceLink":"https:\/\/xxx.com\/invoice.png"
        },
        "couponList":[
            {
                    "paymentOtherCode":"3001177900009396268",
                    "paymentCategoryName":"代金券",
                    "paymentDesc":"Tims咖啡20元代金券"
            }
        ]
    },
    "msgCode":200,
    "errorSubCode":"order-service-error",
    "errorSubMessage":"订单服务异常"
}

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

错误码	错误描述	解决方案
isp.http-read-timeout

错误码查询工具 SDK下载

开放平台

XSPACE餐饮行业服务API

qimen.alibaba.cco.xspace.catering.pickuporder.detail.get (XSpace工作台获取餐饮自取订单详情)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ