锐鲨开放平台

API 列表

xiaodian.trade.refund.list

免费
需要授权

API功能描述(支持get和post)

退款列表；（此为老版本，建议使用新版本接口： xiaodian.trade.refund.list.v2 ）

公共参数

名称	类型	必选	描述
app_key	Long	是	接入时申请的app_key
method	String	是	接口名称
access_token	String	是	Oauth2.0授权获得的access_token
sign	String	是	对 API 调用参数（除sign外）进行 md5 加密获得。参数的顺序为字母表的顺序
timestamp	Long	是	时间戳，使用Unix时间戳格式
format	String	是	响应格式。默认为json格式，固定
sign_method	String	否	参数的加密方法选择，当前只支持Md5
version	String	否	API协议版本，固定值为：1.0

输入参数

名称	类型	必选	描述
queryStatus	String	是	* query_refund_or_return_all：全部状态 * query_refund_or_return_exclude_cancel：全部状态（不包括已取消订单） * query_refund_or_return_all_for_openapi：全部状态(包含已取消的退款订单) * query_return_goods_requested：买家发起退货，等待卖家同意 * query_return_goods_agreed：卖家同意，等待买家退货 * query_return_goods_shipped：买家发货，等待卖家收货 * query_refund_requested：买家发起退款，等待卖家同意 * query_refund_completed：退款完成 * query_refund_or_return_seller_refused：买家退款或退货或发货被卖家拒绝
refundType	String	是	* query_refund_type_all：全部类型（退款、退货、退到官方）
startDate	String	是	* startDate：必选，2016-06-01 00:00:00
endDate	String	是	* endDate：必选，2016-06-11 00:00:00
page	Number	否	* page：可选，1
pageSize	Number	是	pageSize 最大20
userId	Number	是	userId

返回参数

名称	类型	描述	默认值
refundFullDTOList	Object	"createdStr": 退款创建时间, "expense": 退款金额（分）, "goodsPrice": 商品货款价（分）, "itemId": 商品ID, "skuId": skuID, "skuCode": sku编码, "itemOrderId": 商品订单ID, "nowPrice": 现价（分）, "number": 数量, "orderStatus": 订单状态, "price": 价格（分）, "reason": 退款原因（用户填写）, "refundDescription": 退款描述（用户选择）, "refundId": 退款编号 "refundShipInfo": { "address": "x", "area": "xxx", "city": "xxx", "description": "", "mobile": "158076121212", "name": "刘sxx", "province": "xx省", "shipTime": 0, "zip": "435317", "shipExpressName":"shentong", "shipExpressId":"222122" }, "refundType": 退款类型, "shopOrderId": 店铺订单ID——订单列表和详情页暴露的ID "status": 退款状态, "timeLines": 退款的流程时间线, "updatedStr": 更新时间 status枚举： return_goods_requested * 买家发起退货，等待卖家同意, return_goods_agreed * 卖家同意，等待买家退货 return_goods_shipped * 买家发货，等待卖家收货 refund_requested * 买家发起退款，等待卖家同意 refund_or_return_deal_agreed * 买卖家协商一致，等待资金退款结果 refund_or_return_seller_refused * 买家退款或退货被卖家拒绝 return_goods_seller_declare_not_received * 买家发货后，卖家未收到货 refund_completed * 退款完成 refund_cancelled * 退款取消

请求参数示例

1).
{
  "queryStatus": "",
  "refundType": "",
  "startDate": "",
  "endDate": "",
  "page": "",
  "pageSize": "",
  "userId": ""
}

返回示例

1).
{
    "result": {
        "data": {
            "hasNext": true,
            "refundFullDTOList": [
                {
                    "createdStr": "2016-06-09 16:41:15",
                    "expense": 15320,
                    "goodsPrice": 16320,
                    "itemId": 25971223238,
                    "itemOrderId": 2322512222222222,
                    "nowPrice": 8160,
                    "number": 2,
                    "orderStatus": "ORDER_CLOSED",
                    "price": 13600,
                    "reason": "其他",
                    "refundDescription": "老公不喜欢",
                    "refundId": 62511111231,
                    "refundShipInfo": {
                        "address": "x",
                        "area": "xxx",
                        "city": "xxx",
                        "description": "",
                        "mobile": "158076121212",
                        "name": "刘sxx",
                        "province": "xx省",
                        "shipTime": 0,
                        "zip": "435317",
                        "shipExpressName":"shentong",
                        "shipExpressId":"222122"
                    },
                    "refundType": "return_goods",
                    "shopOrderId": 23215476275678,
                    "status": "refund_completed",
                    "timeLines": [
                        {
                            "actionName": "退款金额明细",
                            "actionType": "REFUND_MONEY_DETAIL",
                            "createdStr": "2016-06-09 16:45:35",
                            "showContent": [
                                "退款现金：153.20元 "
                            ]
                        },
                        {
                            "actionName": "商家确认收货",
                            "actionType": "RETURN_GOODS_SELLER_CONFIRM_RECEIVE",
                            "createdStr": "2016-06-09 16:45:29",
                            "showContent": []
                        },
                        {
                            "actionName": "商家同意退货",
                            "actionType": "RETURN_GOODS_SELLER_AGREE",
                            "createdStr": "2016-06-09 16:45:27",
                            "showContent": [
                                "收件人：xx",
                                "电话：158076123456!",
                                "邮编：123456",
                                "地址：xxx省xx市xx市xxx镇xxxx11栋1x7"
                            ]
                        },
                        {
                            "actionName": "买家申请退货",
                            "actionType": "RETURN_GOODS_BUYER_ADD",
                            "createdStr": "2016-06-09 16:41:15",
                            "showContent": [
                                "退款原因:其他",
                                "退款现金:153.20元",
                                "退款说明:老公不喜欢 "
                            ]
                        }
                    ],
                    "updatedStr": "2016-06-09 16:45:35"
                }
            ]
        }
    },
    "status": {
        "code": "0000000",
        "msg": "调用成功!"
    }
}

异常示例

1).
{  }

常见问题

1).查询结果中的refundType对应哪些类型？
return_goods-退货且退款
refund_money-仅退款

2).查询的入参中refundType对应的值有哪些？
1、query_return_goods - 退货 
2、query_refund_money - 退款 
3、query_refund_type_all - 退货&退款

API测试工具 API Demo下载