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

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

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

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
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工具

FAQ

返回
顶部