文档中心 > API类目 > 采购宝API

taobao.pc.refund.render.query (企业购逆向查询渲染)

企业购逆向查询渲染。调用场景:在用户已经提交退款申请后需要修改退款申请时,请求这个接口可以获得用户上次填写的相关内容(如退款理由、退款凭证)展示给用户

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
refund_apply_order_req RefundApplyOrderReq 可选 逆向申请页渲染请求
  • └ biz_order_id
  • String
  • 必须
  • 10000001
  • 订单号
  • └ biz_claim_type
  • Number
  • 必须
  • 1
  • 逆向业务诉求类型 1-仅退款,3-退货退款
  • └ dispute_id
  • String
  • 必须
  • 10000001
  • 逆向订单号
  • └ goods_status
  • Number
  • 可选
  • 1
  • 货物状态 4-未发货,6-已发货,1-未收到货,2-已收到货,3-已寄回,5-卖家确认收货
  • └ apply_refund_text_id
  • Number
  • 可选
  • 100501
  • 用户选择的退款原因文案id
  • └ buyer_id
  • Number
  • 必须
  • 10000001
  • 买家ID

响应参数

名称 类型 示例值 描述
result Result result
  • └ success
  • Boolean
  • true
  • 操作是否成功
  • └ error_code
  • String
  • 200
  • 结果码
  • └ error_msg
  • String
  • 参数错误
  • 结果描述
  • refund_apply_order_resp
  • RefundApplyOrderResp
  • 结果
  • └ biz_order_id
  • String
  • xxxxx
  • 订单ID
  • refund_item_v_o
  • RefundItemVo
  • 退款商品信息
  • └ item_id
  • Number
  • 3
  • 商品ID
  • └ item_name
  • String
  • xxxxx
  • 商品名称
  • └ item_pic
  • String
  • xxxxx
  • 商品图片
  • └ sku_id
  • Number
  • 3
  • skuId
  • └ sku_title
  • String
  • xxxxx
  • sku名称
  • └ total_fee
  • Number
  • 3
  • 商品总价
  • └ buy_amount
  • Number
  • 10
  • 商品数量
  • └ item_price
  • Number
  • 3
  • 商品价格
  • └ selected_biz_claim_type
  • Number
  • 10
  • 选中的交易纠纷退款要求 1-仅退款,3-退货退款
  • └ selected_goods_status
  • Number
  • 1
  • 货品状态 4-未发货,6-已发货,1-未收到货,2-已收到货,3-已寄回,5-卖家确认收货
  • └ selected_buyer_apply_text_id
  • Number
  • 3
  • 选中的申请原因文案id
  • └ selected_dispute_desc
  • String
  • xxxxx
  • 已填写的售后描述
  • claims
  • BizClaimTypeWrapperVo []
  • 交易纠纷退款要求
  • └ biz_claim_type
  • Number
  • 10
  • 当前订单可操作的业务场景列表, 1:仅退款, 3: 退货退款
  • └ expire_time
  • String
  • xxxxx
  • 失效时间
  • └ tips
  • String
  • xxxxx
  • 提示文案
  • └ text
  • String
  • xxxxx
  • 文案
  • └ reverse_type_desc
  • String
  • xxxxx
  • 文案补充描述
  • └ max_refund_fee
  • Number
  • 3
  • 允许最大申请可退款金额
  • └ must_proof
  • Boolean
  • false
  • 是否必须上传凭证
  • proof_examples
  • ProofExampleVo []
  • 凭证示例列表
  • └ img_url
  • String
  • xxxxx
  • 图片Url
  • └ desc
  • String
  • xxxxx
  • 图片描述
  • └ goods_status
  • String []
  • 10,20
  • 货物状态 4-未发货,6-已发货,1-未收到货,2-已收到货,3-已寄回,5-卖家确认收货
  • refund_text_wrapper_v_o_list
  • RefundTextWrapperVo []
  • 可发起的退款原因列表
  • └ text_id
  • Number
  • 3
  • 退款原因文案ID
  • └ tips
  • String
  • xxxxx
  • 退款原因文案个性化提示
  • └ name
  • String
  • xxxxx
  • 退款原因文案名称
  • dispute_desc_v_o
  • DisputeDescVo
  • 退款说明信息
  • └ place_holder
  • String
  • xxxxx
  • 退款说明的默认展示文案
  • └ required
  • Boolean
  • false
  • 是否是必填文案

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
PcRefundRenderQueryRequest req = new PcRefundRenderQueryRequest();
PcRefundRenderQueryRequest.RefundApplyOrderReq obj1 = new PcRefundRenderQueryRequest.RefundApplyOrderReq();
obj1.setBizOrderId("10000001");
obj1.setBizClaimType(1L);
obj1.setDisputeId("10000001");
obj1.setGoodsStatus(1L);
obj1.setApplyRefundTextId(100501L);
obj1.setBuyerId(10000001L);
req.setRefundApplyOrderReq(obj1);
PcRefundRenderQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<pc_refund_render_query_response>
    <result>
        <success>true</success>
        <error_code>200</error_code>
        <error_msg>参数错误</error_msg>
        <refund_apply_order_resp>
            <biz_order_id>xxxxx</biz_order_id>
            <refund_item_v_o>
                <item_id>3</item_id>
                <item_name>xxxxx</item_name>
                <item_pic>xxxxx</item_pic>
                <sku_id>3</sku_id>
                <sku_title>xxxxx</sku_title>
                <total_fee>3</total_fee>
                <buy_amount>10</buy_amount>
                <item_price>3</item_price>
            </refund_item_v_o>
            <selected_biz_claim_type>10</selected_biz_claim_type>
            <selected_goods_status>1</selected_goods_status>
            <selected_buyer_apply_text_id>3</selected_buyer_apply_text_id>
            <selected_dispute_desc>xxxxx</selected_dispute_desc>
            <claims>
                <biz_claim_type_wrapper_vo>
                    <biz_claim_type>10</biz_claim_type>
                    <expire_time>xxxxx</expire_time>
                    <tips>xxxxx</tips>
                    <text>xxxxx</text>
                    <reverse_type_desc>xxxxx</reverse_type_desc>
                </biz_claim_type_wrapper_vo>
            </claims>
            <max_refund_fee>3</max_refund_fee>
            <must_proof>false</must_proof>
            <proof_examples>
                <proof_example_vo>
                    <img_url>xxxxx</img_url>
                    <desc>xxxxx</desc>
                </proof_example_vo>
            </proof_examples>
            <goods_status>
                <string>10</string>
                <string>20</string>
            </goods_status>
            <refund_text_wrapper_v_o_list>
                <refund_text_wrapper_vo>
                    <text_id>3</text_id>
                    <tips>xxxxx</tips>
                    <name>xxxxx</name>
                </refund_text_wrapper_vo>
            </refund_text_wrapper_v_o_list>
            <dispute_desc_v_o>
                <place_holder>xxxxx</place_holder>
                <required>false</required>
            </dispute_desc_v_o>
        </refund_apply_order_resp>
    </result>
</pc_refund_render_query_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

返回
顶部