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

taobao.pc.refund.list (企业购逆向退款单列表)

企业购逆向退款单列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
refund_list_req RefundListReq 可选 逆向纠纷单列表请求
  • └ dispute_id_list
  • String []
  • 可选
  • Top,Pub
  • 纠纷单列表
  • └ out_biz_id_list
  • String []
  • 可选
  • Top,Pub
  • 外部业务处理编号列表
  • └ ego_biz_order_id_list
  • String []
  • 可选
  • Top,Pub
  • 企业购子单号列表
  • └ dispute_type
  • Number
  • 可选
  • 10
  • 交易纠纷类型 1售中退款,2售后退款,3售中维权,4售后维权
  • └ dispute_status
  • Number
  • 可选
  • 10
  • 纠纷单状态 1-买家已经申请退款->等待卖家同意 2-卖家已经同意退款->等待买家退货 3-买家已经退货->等待卖家确认收货 4-退款关闭 5-退款成功6-卖家拒绝退款 7-等待买家确认重新邮寄的货物 8-等待卖家确认退货地址
  • └ goods_status
  • Number
  • 可选
  • 10
  • 4-未发货,6-已发货,1-未收到货2-已收到货,3-已寄回,5-卖家确认收货
  • └ biz_claim_type
  • Number
  • 可选
  • 10
  • 业务诉求类型 1-仅退款 3-退货退款
  • └ create_time_start
  • String
  • 可选
  • xxxxx
  • 创建纠纷单起始时间, 格式为yyyy-MM-dd HH:mm:ss
  • └ create_time_end
  • String
  • 可选
  • xxxxx
  • 创建纠纷单截止时间, 格式为yyyy-MM-dd HH:mm:ss
  • └ end_time_start
  • String
  • 可选
  • xxxxx
  • 纠纷单完结起始时间, 格式为yyyy-MM-dd HH:mm:ss
  • └ end_time_end
  • String
  • 可选
  • xxxxx
  • 纠纷单完结截止时间, 格式为yyyy-MM-dd HH:mm:ss
  • └ buyer_id
  • Number
  • 必须
  • 10000001
  • 买家ID
page_query_param PageQueryParam 可选 分页查询参数
  • └ page_size
  • Number
  • 必须
  • 20
  • 分页大小,区间[1,20]
  • └ current_page
  • Number
  • 必须
  • 1
  • 当前页,从1开始
  • └ cursor
  • String
  • 可选
  • 12345
  • 游标,开启了游标模式,查询下一页的时候需要传入,第一次查询可以不传
  • └ cursor_mode
  • Boolean
  • 可选
  • false
  • 是否开启游标模式
  • └ with_total
  • Boolean
  • 可选
  • true
  • 是否需要返回总数

响应参数

名称 类型 示例值 描述
page_result RefundListResp pageResult
  • └ success
  • Boolean
  • true
  • 操作是否成功
  • └ error_code
  • String
  • 200
  • 结果码
  • └ error_msg
  • String
  • 参数错误
  • 结果描述
  • refund_list_resp_page_data
  • RefundListResp
  • 分页结果
  • └ current_page
  • Number
  • 1
  • 当前页码
  • └ page_size
  • Number
  • 20
  • 每页大小
  • └ total_count
  • Number
  • 100
  • 总数量
  • └ cursor_mode
  • Boolean
  • false
  • 是否游标模式
  • └ cursor
  • String
  • 12345
  • 游标
  • refund_list_resp_list
  • RefundListResp []
  • 数据集合
  • refund_list
  • RefundListItem []
  • 退款列表
  • └ dispute_id
  • String
  • xxxxx
  • 企业购退款单ID
  • └ ego_biz_order_id
  • String
  • xxxxx
  • 关联的企业购子订单ID
  • └ tb_dispute_id
  • String
  • xxxxx
  • 淘宝订单ID
  • └ out_biz_id
  • String
  • xxxxx
  • 关联的外部业务处理编号
  • └ biz_claim_type
  • Number
  • 10
  • 申请的服务类型
  • └ dispute_status
  • Number
  • 10
  • 纠纷单状态
  • └ auction_title
  • String
  • xxxxx
  • 商品名称
  • └ auction_id
  • Number
  • 3
  • 商品ID
  • └ auction_url
  • String
  • xxxxx
  • auctionUrl
  • └ sku_id
  • Number
  • 3
  • SKU ID
  • └ refund_fee
  • Number
  • 3
  • 退款金额(单位:分)
  • └ gmt_create
  • String
  • xxxxx
  • 交易纠纷创建时间

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
PcRefundListRequest req = new PcRefundListRequest();
PcRefundListRequest.RefundListReq obj1 = new PcRefundListRequest.RefundListReq();
obj1.setDisputeIdList("Top,Pub");
obj1.setOutBizIdList("Top,Pub");
obj1.setEgoBizOrderIdList("Top,Pub");
obj1.setDisputeType(10L);
obj1.setDisputeStatus(10L);
obj1.setGoodsStatus(10L);
obj1.setBizClaimType(10L);
obj1.setCreateTimeStart("xxxxx");
obj1.setCreateTimeEnd("xxxxx");
obj1.setEndTimeStart("xxxxx");
obj1.setEndTimeEnd("xxxxx");
obj1.setBuyerId(10000001L);
req.setRefundListReq(obj1);
PcRefundListRequest.PageQueryParam obj2 = new PcRefundListRequest.PageQueryParam();
obj2.setPageSize(20L);
obj2.setCurrentPage(1L);
obj2.setCursor("12345");
obj2.setCursorMode(false);
obj2.setWithTotal(true);
req.setPageQueryParam(obj2);
PcRefundListResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<pc_refund_list_response>
    <page_result>
        <success>true</success>
        <error_code>200</error_code>
        <error_msg>参数错误</error_msg>
        <refund_list_resp_page_data>
            <current_page>1</current_page>
            <page_size>20</page_size>
            <total_count>100</total_count>
            <cursor_mode>false</cursor_mode>
            <cursor>12345</cursor>
            <refund_list_resp_list>
                <refund_list_resp>
                    <refund_list>
                        <refund_list_item>
                            <dispute_id>xxxxx</dispute_id>
                            <ego_biz_order_id>xxxxx</ego_biz_order_id>
                            <tb_dispute_id>xxxxx</tb_dispute_id>
                            <out_biz_id>xxxxx</out_biz_id>
                            <biz_claim_type>10</biz_claim_type>
                            <dispute_status>10</dispute_status>
                            <auction_title>xxxxx</auction_title>
                            <auction_id>3</auction_id>
                            <auction_url>xxxxx</auction_url>
                            <sku_id>3</sku_id>
                            <refund_fee>3</refund_fee>
                            <gmt_create>xxxxx</gmt_create>
                        </refund_list_item>
                    </refund_list>
                </refund_list_resp>
            </refund_list_resp_list>
        </refund_list_resp_page_data>
    </page_result>
</pc_refund_list_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

返回
顶部