144 lines
6.8 KiB
Markdown
144 lines
6.8 KiB
Markdown
open.seller.order.refund.pcursor.list
|
|
需商家授权
|
|
GET
|
|
获取售后单列表
|
|
更新时间: 2024-04-22 16:28:28
|
|
查询商家售后单列表(游标方式)，可根据订单id查询关联的全量售后单列表，handlingway为售后方式，status为售后状态
|
|
系统环境
|
|
环境 域名
|
|
线上环境（推荐） https://openapi.kwaixiaodian.com
|
|
线上环境（备用） https://open.kwaixiaodian.com
|
|
系统参数
|
|
参数名 类型 必须 详情描述
|
|
appkey String 是 平台分配的appId
|
|
timestamp Number 是 发起请求的Unix时间戳，单位为毫秒
|
|
access_token String 是 访问token，所有需用户授权API使用code模式获取，不需要用户授权API使用client_credentials获取，详情参考《授权说明》文档
|
|
version Number 是 请求的API版本号，目前版本为1
|
|
param JSON 是 业务参数，详见下方的请求入参
|
|
method String 是 请求的API英文名，详见各API定义
|
|
sign String 是 API入参的签名结果参数
|
|
signMethod String 是 签名算法，支持HMAC_SHA256和MD5，推荐使用HMAC_SHA256
|
|
请求参数
|
|
参数名 类型 必须 示例值 详情描述
|
|
beginTime Long 是 1543817629000 订单生成的开始时间（单位毫秒），在当前时间的近90天内，不能大于90天，且小于截止时间
|
|
endTime Long 是 1543817629000 订单生成的截止时间（单位毫秒）在当前时间的近90天内，不能大于90天，且大于开始时间，且与开始时间的时间范围不大于1天 (与开始时间的时间范围建议做成随时可配置，该范围可能在活动期间随时变化，比如变成小时级或者分钟级)。
|
|
type Integer 是 8 退款单请求类型，8 等待退款 9 全部退款订单
|
|
pageSize Integer 是 50 每次请求数量，最多一页100条
|
|
currentPage Long 是 1 当前页码
|
|
sort Integer 否 1 排序方式，1时间降序 2时间升序 ，默认降序
|
|
queryType Integer 否 1 查找方式，1按创建时间查找 2按更新时间查找 ，默认创建时间
|
|
negotiateStatus Integer 否 1 协商状态，1待商家处理 2 商家同意 3商家驳回，等待买家修改 默认返回所有数据
|
|
pcursor String 是 1543843735000_1 游标内容，第一次传空串，之后传上一次的pcursor返回值，若返回“nomore”则标识到底
|
|
status Integer 否 10 退款状态，枚举：[10, "买家已经申请退款，等待卖家同意"] [12, "卖家已拒绝，等待买家处理"] [20, "协商纠纷，等待平台处理"] [30, "卖家已经同意退款，等待买家退货"] [40, "买家已经退货，等待卖家确认收货"] [45, "卖家已经发货，等待买家确认收货"] [50, "卖家已经同意退款，等待系统执行退款"] [60, "退款成功"] [70, "退款关闭"]
|
|
option RefundPageOption 否 {} 选项
|
|
orderId Long 否 2412314120000 订单id，可根据订单id查询关联的所有售后单列表
|
|
返回参数
|
|
参数名 类型 示例值 详情描述
|
|
code String 1 主返回码
|
|
msg String success 主返回信息
|
|
sub_code String 1 子返回码
|
|
sub_msg String SUCCESS 子返回信息
|
|
result Integer 1 返回码，1正确，其他返回码表示接口未执行成功
|
|
data MerchantRefundListDataView {} 售后单列表信息
|
|
error_msg String SUCCESS 返回码描述
|
|
错误码
|
|
错误码 错误类型 错误描述 解决方法
|
|
13 参数非法 参数不合法 分页参数不符合‘nomore’ 或 ‘数字_数字’的格式，请检查
|
|
16 系统错误 请求过于频繁 请求过于频繁，请稍后重试
|
|
51 参数非法 pageSize 应为20 pageSize超过了100
|
|
53 参数非法 page number 过大 page number 过大，分页参数为nomore报错
|
|
300002 业务错误 退款单类型错误 退款单类型错误
|
|
300003 业务错误 结束时间必须大于开始时间 结束时间必须大于开始时间
|
|
300005 业务错误 开始时间不能大于90天前 开始时间不能大于90天前
|
|
300019 业务错误 时间范围超限 时间范围超限
|
|
300107 业务错误 状态无效 status参数不在RefundStatusEnum里
|
|
300109 业务错误 退款单请求类型为等待退款时，退款单状态列表中不能包含非等待退款的状态 退款单请求类型为等待退款时，退款单状态列表中不能包含非等待退款的状态
|
|
请求示例
|
|
JAVA
|
|
CURL
|
|
package com.kuaishou.merchant.open.api.sdk.demo;
|
|
import com.kuaishou.merchant.open.api.common.utils.GsonUtils;
|
|
import com.kuaishou.merchant.open.api.request.refund.OpenSellerOrderRefundPcursorListRequest;
|
|
import com.kuaishou.merchant.open.api.response.refund.OpenSellerOrderRefundPcursorListResponse;
|
|
import com.kuaishou.merchant.open.api.client.AccessTokenKsMerchantClient;
|
|
|
|
public class AccessTokenKsMerchantClientDemo {
|
|
|
|
public static void main(String[] args) {
|
|
String url = "https://openapi.kwaixiaodian.com";
|
|
String appKey = "your appKey";
|
|
String signSecret = "your app signSecret";
|
|
String accessToken = "your accessToken";
|
|
|
|
AccessTokenKsMerchantClient client = new AccessTokenKsMerchantClient(url,appKey,signSecret);
|
|
|
|
OpenSellerOrderRefundPcursorListRequest request = new OpenSellerOrderRefundPcursorListRequest();
|
|
request.setAccessToken(accessToken);
|
|
request.setApiMethodVersion(1L);
|
|
|
|
request.setBeginTime(1543817629000);
|
|
request.setEndTime(1543817629000);
|
|
request.setType(8);
|
|
request.setPageSize(50);
|
|
request.setCurrentPage(1);
|
|
request.setSort(1);
|
|
request.setQueryType(1);
|
|
request.setNegotiateStatus(1);
|
|
request.setPcursor("1543843735000_1");
|
|
request.setStatus(10);
|
|
RefundPageOption obj1 = new RefundPageOption();
|
|
obj1.setNeedExchange(false);
|
|
request.setOption(obj1);
|
|
request.setOrderId(2412314120000);
|
|
|
|
OpenSellerOrderRefundPcursorListResponse response = client.execute(request);
|
|
|
|
System.out.println(GsonUtils.toJSON(response));
|
|
}
|
|
}
|
|
|
|
响应示例
|
|
JSON
|
|
{
|
|
"result": 1,
|
|
"data": {
|
|
"currentPage": 1,
|
|
"pageSize": 100,
|
|
"totalPage": 10,
|
|
"totalSize": 100,
|
|
"beginTime": 1597248000000,
|
|
"endTime": 1597276800000,
|
|
"pcursor": "nomore",
|
|
"refundOrderInfoList": [
|
|
{
|
|
"oid": 12020384,
|
|
"refundId": 2016300011212478,
|
|
"handlingWay": 1,
|
|
"negotiateStatus": 1,
|
|
"refundFee": 890,
|
|
"skuId": 92381223,
|
|
"refundReason": 1,
|
|
"status": 10,
|
|
"buyerId": 63523209,
|
|
"refundType": 1298723,
|
|
"sellerId": 92371012,
|
|
"refundDesc": "描述",
|
|
"submitTime": 1543843735000,
|
|
"relItemId": 111,
|
|
"negotiateUpdateTime": 1543843735000,
|
|
"updateTime": 1543843735000,
|
|
"createTime": 1543843735000,
|
|
"relSkuId": 120823876,
|
|
"skuNick": "111",
|
|
"logisticsId": 1234567,
|
|
"endTime": 1543843735000,
|
|
"itemId": 123456,
|
|
"receiptStatus": 1,
|
|
"refundReasonDesc": "拍多、拍错",
|
|
"expireTime": 1543843735000
|
|
}
|
|
]
|
|
},
|
|
"error_msg": "SUCCESS"
|
|
}
|