taobao.fenxiao.yph.refunds.get (一盘货商家批量查询退款单信息)

一盘货商家批量查询退款单信息

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
refund_type_list Number 可选 [20] 退款单类型,10-未发货退款;20-已发货退货;30-已发货仅退款;40-拒收
trade_types Number 可选 [5] 交易模式(分销方式):1-代销;2-经销;5-寄售;6-平台寄售
page_size Number 必须 50 每页条数,必填,不可超过50条
page_num Number 可选 1 页号,不填则默认为1
refund_status_list Number 可选 [10] 退款单状态,10-已撤回;20-等待卖家同意;30-卖家拒绝退款,等待买家修改;40-等待买家退货;50-买家退货,等待卖家确认收货;60-卖家拒绝收货;90-等待系统打款;100-退款成功;200-退款关闭
modified_begin_time Date 必须 2000-01-01 00:00:00 退款单最后修改时间,查询最后修改时间在modify_begin_time到modify_end_time时间间隔内的所有退款单,时间间隔不能超过30天,格式 yyyy-MM-dd HH:mm:ss
channel_codes Number 必须 [302] 渠道市场编码,可批量指定。 当不指定时,按照配置的分销市场生效 渠道编码枚举:1-供销平台(淘宝);2-供销平台(天猫);3-供销平台(天猫超市);5-供销平台(淘乡甜);110001-供销平台(全球购);110007-淘分销;200002-消费电子市场;302-猫超一盘货;506-虾选一盘货;27-优品一盘货
modified_end_time Date 必须 2000-01-01 00:00:00 退款单最后修改时间,查询最后修改时间在modify_begin_time到modify_end_time时间间隔内的所有退款单,时间间隔不能超过30天,格式 yyyy-MM-dd HH:mm:ss
purchase_order_id Number 可选 1234234234 分销采购单id
sub_order_id Number 可选 4532534534 分销采购单子单id
user_role_type Number 可选 2 当前查询用户的角色 当不指定时,默认为供应商 供应商:2,分销商:1
query_b2c_refund Boolean 可选 true 是否查询前台消费者退款

响应参数

名称 类型 示例值 描述
refund_detail_list RefundDetailList [] null 退款单详情列表
  • └ refund_fee
  • Number
  • 0
  • 退款金额,单位:分
  • └ gmt_modified
  • Date
  • 2000-01-01 00:00:00
  • 退款单最后修改时间,格式 yyyy-MM-dd HH:mm:ss
  • └ refund_status
  • Number
  • 50
  • 退款单状态,10-已撤回;20-等待卖家同意;30-卖家拒绝退款,等待买家修改;40-等待买家退货;50-买家退货,等待卖家确认收货;60-卖家拒绝收货;90-等待系统打款;100-退款成功;200-退款关闭
  • └ refund_desc
  • String
  • 收单系统自动创建
  • 退款说明
  • └ return_goods
  • Boolean
  • true
  • 是否退货
  • └ refund_fee_yuan
  • String
  • 0.00
  • 退款金额,单位:元
  • └ sub_order_id
  • Number
  • 46148182683334
  • 发生退款的分销子采购单id
  • buyer_refund
  • BuyerRefund
  • null
  • 买家退款单信息
  • └ gmt_modified
  • Date
  • 2000-01-01 00:00:00
  • 买家退款状态最后修改时间,格式 yyyy-MM-dd HH:mm:ss
  • └ buyer_nick
  • String
  • wuliqiang1314
  • 消费者昵称,未来不会透出,请用open_buyer_id
  • └ refund_reason
  • String
  • 卖家发错货
  • 退款原因描述
  • └ goods_status_desc
  • String
  • 买家已退货
  • 货物状态描述
  • └ need_return_goods
  • Boolean
  • true
  • 是否需要退货
  • └ refund_desc
  • String
  • 退款说明
  • 退款说明
  • └ sub_order_id
  • Number
  • 46148182683334
  • 分销子采购单id
  • └ biz_order_id
  • Number
  • 1738195059791261700
  • 消费者子订单id
  • └ return_fee
  • Number
  • 7920
  • 申请退款的金额,单位:分
  • └ to_seller_fee
  • Number
  • 0
  • 支付给分销商的金额,单位:分
  • └ refund_create_time
  • Date
  • 2000-01-01 00:00:00
  • 退款创建时间
  • └ refund_id
  • Number
  • 110601615767267420
  • 退款id
  • └ return_goods_quantity
  • Number
  • 2323
  • 消费者退货数量
  • └ open_buyer_id
  • String
  • AHHJ-454545DHJ
  • 消费者买家id加密key
  • └ pay_sup_fee_yuan
  • String
  • 0.00
  • 支付给供应商的金额,单位:元
  • └ purchase_order_id
  • Number
  • 46148182683334
  • 分销采购单id
  • └ pay_sup_fee
  • Number
  • 0
  • 支付给供应商的金额,单位:分
  • └ refund_create_time
  • Date
  • 2000-01-01 00:00:00
  • 退款创建时间
  • └ refund_type
  • Number
  • 20
  • 退款单类型,10-未发货退款;20-已发货退货;30-已发货仅退款;40-拒收
  • └ refund_status_code
  • String
  • RF_STATUS_WAIT_SELLER_CONFIRM_GOODS
  • 退款单状态code,RF_STATUS_NO_REFUND-已撤回;RF_STATUS_WAIT_SELLER_AGREE-等待卖家同意;RF_STATUS_SELLER_REFUSE-卖家拒绝退款,等待买家修改;RF_STATUS_WAIT_BUYER_RETURN_GOODS-等待买家退货;RF_STATUS_WAIT_SELLER_CONFIRM_GOODS-买家退货,等待卖家确认收货;RF_STATUS_SELLER_REFUSE_RETURN_GOODS-卖家拒绝收货;RF_STATUS_WAIT_SYSTEM_TRANSFER-等待系统打款;RF_STATUS_SUCCESS-退款成功;RF_STATUS_CLOSED-退款关闭
  • └ refund_id
  • Number
  • 1234532672
  • 退款单id
  • return_logistics
  • RefundLogistics []
  • 退货的物流信息
  • └ company_code
  • String
  • SF
  • 退货物流公司编码,如顺丰、韵达等
  • └ company_name
  • String
  • 顺丰
  • 退货物流公司名称,如顺丰
  • └ mail_no
  • String
  • 2323234
  • 退货物流运单号
  • refund_items
  • RefundItem []
  • 退款明细项,记录退款涉及的订单
  • └ refund_item_id
  • Number
  • 23232323
  • 退款明细ID,针对一笔退款每一个品就映射为一个明细,每一个明细有一个全局唯一的ID
  • └ sub_order_id
  • Number
  • 232323
  • 分销子订单号
  • └ refund_quantity
  • Number
  • 22
  • 退货数量
total_count Number 4 退款单查询总条数
opt_time Date 2000-01-01 00:00:00 操作时间
result_code String SYSTEM_EXCEPTION 返回结果错误码
remark String 系统错误 返回结果错误信息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
FenxiaoYphRefundsGetRequest req = new FenxiaoYphRefundsGetRequest();
req.setRefundTypeList([20]L);
req.setTradeTypes([5]L);
req.setPageSize(50L);
req.setPageNum(1L);
req.setRefundStatusList([10]L);
req.setModifiedBeginTime(StringUtils.parseDateTime("2000-01-01 00:00:00"));
req.setChannelCodes([302]L);
req.setModifiedEndTime(StringUtils.parseDateTime("2000-01-01 00:00:00"));
req.setPurchaseOrderId(1234234234L);
req.setSubOrderId(4532534534L);
req.setUserRoleType(2L);
req.setQueryB2cRefund(true);
FenxiaoYphRefundsGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<fenxiao_yph_refunds_get_response>
    <refund_detail_list>
        <refund_detail_list>
            <refund_fee>0</refund_fee>
            <gmt_modified>2000-01-01 00:00:00</gmt_modified>
            <refund_status>50</refund_status>
            <refund_desc>收单系统自动创建</refund_desc>
            <return_goods>true</return_goods>
            <refund_fee_yuan>0.00</refund_fee_yuan>
            <sub_order_id>46148182683334</sub_order_id>
            <buyer_refund>
                <gmt_modified>2000-01-01 00:00:00</gmt_modified>
                <buyer_nick>wuliqiang1314</buyer_nick>
                <refund_reason>卖家发错货</refund_reason>
                <goods_status_desc>买家已退货</goods_status_desc>
                <need_return_goods>true</need_return_goods>
                <refund_desc>退款说明</refund_desc>
                <sub_order_id>46148182683334</sub_order_id>
                <biz_order_id>1738195059791261700</biz_order_id>
                <return_fee>7920</return_fee>
                <to_seller_fee>0</to_seller_fee>
                <refund_create_time>2000-01-01 00:00:00</refund_create_time>
                <refund_id>110601615767267420</refund_id>
                <return_goods_quantity>2323</return_goods_quantity>
                <open_buyer_id>AHHJ-454545DHJ</open_buyer_id>
            </buyer_refund>
            <pay_sup_fee_yuan>0.00</pay_sup_fee_yuan>
            <purchase_order_id>46148182683334</purchase_order_id>
            <pay_sup_fee>0</pay_sup_fee>
            <refund_create_time>2000-01-01 00:00:00</refund_create_time>
            <refund_type>20</refund_type>
            <refund_status_code>RF_STATUS_WAIT_SELLER_CONFIRM_GOODS</refund_status_code>
            <refund_id>1234532672</refund_id>
            <return_logistics>
                <refund_logistics>
                    <company_code>SF</company_code>
                    <company_name>顺丰</company_name>
                    <mail_no>2323234</mail_no>
                </refund_logistics>
            </return_logistics>
            <refund_items>
                <refund_item>
                    <refund_item_id>23232323</refund_item_id>
                    <sub_order_id>232323</sub_order_id>
                    <refund_quantity>22</refund_quantity>
                </refund_item>
            </refund_items>
        </refund_detail_list>
    </refund_detail_list>
    <total_count>4</total_count>
    <opt_time>2000-01-01 00:00:00</opt_time>
    <result_code>SYSTEM_EXCEPTION</result_code>
    <remark>系统错误</remark>
</fenxiao_yph_refunds_get_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

返回
顶部