淘宝开放平台

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

XSPACE餐饮行业服务API

qimen.alibaba.cco.xspace.catering.compensate.coupon.outaccount.operate (XSpace工作台餐饮赔付优惠券出账操作接口)

XSpace工作台餐饮赔付调用优惠券出账接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
idempotentId String 必须 1639713629167004412_181401_0 幂等字段
caseId String 可选 2505013265093214 工单编码
foreignId String 可选 300100000039227009 外部会员ID
bizOrderType String 可选 3 订单类型，枚举：0其他/3Tims
bizOrderId String 可选 1639713629167004412 订单编码
bizCompensateReason String 可选 洒漏赔付 赔付原因
scenarioId String 可选 1 赔付场景，枚举值：1优惠券/2积分/0其他，该接口默认1
couponList CouponCompItem [] 可选
  • 最大列表长度：999
    		•  赔付券列表
    • └ couponAmount
    • Number
    • 可选
    • 1500
    • 券金额(单位为分)，慢必赔无金额
    • └ couponCount
    • Number
    • 可选
    • 5
    • 券数量，慢必赔默认数量1
    • └ couponType
    • String
    • 可选
    • 1
    • 券类型，枚举：1[5元券]/2[10元券]/3[20元券]/0[慢必赔]
    payeeRoleId String 可选 3 收款方角色，枚举值：1平台/2商家/3会员
    payeeId String 可选 300100000039227009 收款方账号
    dutyRoleId String 可选 2 责任方角色，枚举值：1平台/2商家/3会员
    dutyType String 可选 1 责任类型，枚举值：1全责/2半责/3不定责

    响应参数

    名称 类型 示例值 描述
    msgCode Number 200 返回错误码，和http status保持概念相同
    errorSubCode String compensate-service-error 错误子码
    errorSubMessage String 券出账服务异常 具体错误描述
    result Result 接口返回结果
    • └ compensateSuccess
    • Boolean
    • true
    • 是否赔付成功
    • successCouponList
    • CouponCompItem []
    • 赔付成功券列表
    • └ couponType
    • String
    • 1
    • 券类型，枚举：1[5元券]/2[10元券]/3[20元券]/4[慢必赔]
    • └ couponAmount
    • Number
    • 1000
    • 券金额（单位为分）
    • └ couponCount
    • Number
    • 2
    • 券数量，慢必赔默认数量1
    • failedCouponList
    • CouponCompItem []
    • 赔付失败券列表
    • └ couponAmount
    • Number
    • 500
    • 券金额（单位为分）
    • └ couponCount
    • Number
    • 1
    • 券数量，慢必赔默认数量1
    • └ couponType
    • String
    • 1
    • 券类型，枚举：1[5元券]/2[10元券]/3[20元券]/4[慢必赔]

    请求示例

    {"foreignId":"300100000039227009","dutyType":"1","bizOrderId":"1639713629167004412","couponList":[{"couponAmount":1500,"couponType":"1","couponCount":5}],"caseId":"2505013265093214","idempotentId":"1639713629167004412_181401_0","dutyRoleId":"2","payeeRoleId":"3","payeeId":"300100000039227009","bizOrderType":"3","bizCompensateReason":"洒漏赔付","scenarioId":"1"}

    响应示例

    {
    "msgCode":200,
    "errorSubCode":"compensate-service-error",
    "errorSubMessage":"券出账服务异常",
    "result":{
        "compensateSuccess":true,
        "successCouponList":[
            {
                    "couponType":"1",
                    "couponAmount":1000,
                    "couponCount":2
            }
        ],
        "failedCouponList":[
            {
                    "couponAmount":500,
                    "couponCount":1,
                    "couponType":"1"
            }
        ]
    }
}

    验签示例

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

    错误码解释

    错误码 错误描述 解决方案

    API工具

    错误码查询工具 SDK下载

    FAQ

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