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

qimen.alibaba.cco.xspace.catering.partialrefund.canrefund.get (获取tims主订单是否可整单退或部分退)

获取tims主订单是否可整单退或部分退

公共参数

请求地址：

环境	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	必须	102102021		主订单Id

响应参数

名称	类型	示例值	描述
result	Result		是否可退结果
└ canPartialRefund Boolean true 是否可以部分退 └ refundCode String xxxx 场景code └ canRefund Boolean true 是否可以整单退 └ refundMessage String 可进行整单退场景信息 └ platform String 无退款平台 └ hasPartialRefund Boolean false 是否进行过部分退款 └ availablePackage Boolean false 券包是否完整（true完整）（false)不完整）
msgCode	String	200	返回错误码，和http status保持概念相同
errorMessage	String	无	错误信息
errorSubCode	String	10001	子错误码
errorSubMessage	String	无	子错误信息

请求示例

{"orderId":"102102021"}

响应示例

{
    "result":{
        "canPartialRefund":true,
        "refundCode":"xxxx",
        "canRefund":true,
        "refundMessage":"可进行整单退",
        "platform":"无",
        "hasPartialRefund":false,
        "availablePackage":false
    },
    "msgCode":"200",
    "errorMessage":"无",
    "errorSubCode":"10001",
    "errorSubMessage":"无"
}

验签示例

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

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部

开放平台

XSPACE餐饮行业服务API

qimen.alibaba.cco.xspace.catering.partialrefund.canrefund.get (获取tims主订单是否可整单退或部分退)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ