文档中心 > API类目 > 天猫好房交易API

tmall.alihouse.trade.coupon.order.common.code.exchange (劵类商品通用的核销操作)

劵类商品通用的核销操作

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
verify_code_request VerifyCodeRequest 必须
  • 默认值:{}
  • 核销操作的请求入参
    • └ coupon_code
    • String
    • 必须
    • ZWDHSR58
    • 核销码
    • └ remark
    • String
    • 必须
    • 核销通过
    • 商家发起核销的备注
    • └ store_id
    • Number
    • 可选
    • 24565
    • 门店id,做鉴权使用
    • └ biz_scenario
    • String
    • 可选
    • eh_marketing
    • 业务场景
    • └ house_order_no
    • String
    • 可选
    • 2022112410120015092224150253
    • 订单编号

    响应参数

    名称 类型 示例值 描述
    result Result 商家调用发起核销接口的返回信息
    • └ msg
    • String
    • 错误码的说明信息
    • 系统繁忙
    • └ code
    • String
    • 200
    • 成功
    • └ is_success
    • Boolean
    • true
    • 系统调用成功
    • data
    • VerifyCodeResponse
    • 商家调用发起核销接口的响应数据信息
    • └ is_biz_success
    • Boolean
    • true
    • 业务调用成功
    • └ house_order_no
    • String
    • 2022101710110012560005150253
    • 统一订单号
    • └ error_msg
    • String
    • 获取锁失败
    • 错误描述信息

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    TmallAlihouseTradeCouponOrderCommonCodeExchangeRequest req = new TmallAlihouseTradeCouponOrderCommonCodeExchangeRequest();
    TmallAlihouseTradeCouponOrderCommonCodeExchangeRequest.VerifyCodeRequest obj1 = new TmallAlihouseTradeCouponOrderCommonCodeExchangeRequest.VerifyCodeRequest();
    obj1.setCouponCode("ZWDHSR58");
    obj1.setRemark("核销通过");
    obj1.setStoreId(24565L);
    obj1.setBizScenario("eh_marketing");
    obj1.setHouseOrderNo("2022112410120015092224150253");
    req.setVerifyCodeRequest(obj1);
    TmallAlihouseTradeCouponOrderCommonCodeExchangeResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <tmall_alihouse_trade_coupon_order_common_code_exchange_response>
        <result>
            <msg>错误码的说明信息</msg>
            <code>200</code>
            <is_success>true</is_success>
            <data>
                <is_biz_success>true</is_biz_success>
                <house_order_no>2022101710110012560005150253</house_order_no>
                <error_msg>获取锁失败</error_msg>
            </data>
        </result>
    </tmall_alihouse_trade_coupon_order_common_code_exchange_response>

    异常示例

    • XML示例
    • JSON示例
    <error_response>
        <code>50</code>
        <msg>Remote service error</msg>
        <sub_code>isv.invalid-parameter</sub_code>
        <sub_msg>非法参数</sub_msg>
    </error_response>

    错误码解释

    错误码 错误描述 解决方案

    API工具

    如何获得此API

    FAQ

    返回
    顶部