/v2/providers/openapi/apis/api/v6/vendors/{vendorId}/returnRequestsv1退货/取消申请列表查询
简介
API 支持的买家用户地区：韩国、台湾 您可 根据 受理日期 查询 退 货 / 取消申请 记录 。 发 送 商品 前， 请务 必通 过 【退 货申请 列表 查询 】 确认 是否有商品受理了 “ 申请停止 发货 ” 。 您可根据 searchType=timeframe 设置以分钟/天为单位进行查询。 查询 在已付款 阶 段被取消的 订单时 ，除 orderId 参数 外， 还须 使用 cancelType=CANCEL 参数 。 请下载以下资料，确认各退货订单的退货原因 (reasonCode ) 。
详细内容
API支持的买家用户地区：韩国、台湾
您可根据受理日期查询退货/取消申请记录。
发送商品前，请务必通过【退货申请列表查询】确认是否有商品受理了“申请停止发货”。
您可根据searchType=timeframe 设置以分钟/天为单位进行查询。
查询在已付款阶段被取消的订单时，除orderId参数外，还须使用cancelType=CANCEL参数。
请下载以下资料，确认各退货订单的退货原因(reasonCode)。
您可将查询周期设置为最长31天。数据量大时，查询可能会出现超时错误，因此我们建议您将周期设置得越短越好。
顾客申请停止发货时（在商品准备阶段受理退货申请时），可在RU（申请停止发货）和UC（申请退货）状态下查看。
路径
GET
/v2/providers/openapi/apis/api/v6/vendors/{vendorId}/returnRequests
示例
请求参数
|
Name |
|
Required |
Type |
Description |
|
vendorId |
O |
|
String |
卖家ID 酷澎提供给卖家的固有代码 ex) A00012345 |
链接查询参数
|
Name |
Required |
Type |
Description |
|||||||||||||
|
searchType |
O |
String |
以分钟为单位查询退货申请列表时，须发送"searchType=timeFrame" 参数。 |
|||||||||||||
|
createdAtFrom |
O |
String |
搜索开始日期(yyyy-MM-dd)。 “searchType=timeFrame”时，输入“yyyy-MM-ddTHH:mm” |
|||||||||||||
|
createdAtTo |
O |
String |
搜索结束日期 (yyyy-MM-dd)。 “searchType=timeFrame”时，输入“yyyy-MM-ddTHH:mm” |
|||||||||||||
|
status |
|
String |
退货状态
“cancelType=CANCEL”时，该参数不可用。 |
|||||||||||||
|
cancelType |
|
String |
|
|||||||||||||
|
|
代码 |
描述 |
|
|||||||||||||
|
|
|
|
|
RETURN |
查询退货订单(默认值) |
To look up a |
||||||||||
|
CANCEL |
查询取消订单 |
|||||||||||||||
|
默认值为RETURN，查询取消订单时须删除status参数。 |
||||||||||||||||
|
nextToken |
|
String |
查询下一页所需的token值 查询第一页时不需要 “searchType=timeFrame”，该参数不可用。 |
|||||||||||||
|
maxPerPage |
|
Number |
每页最多可申请查询的值 默认值 = 50 “searchType=timeFrame”时，该参数不可用。 ”cancelType=CANCEL“时，输出的结果可能少于申请的maxPerPage。 |
|||||||||||||
|
orderId |
|
Number |
订单号 除status外，查询时参数中还须包含orderId。 “searchType=timeFrame”时，该参数不可用。 |
|||||||||||||
请求体
无
返回消息
|
Name |
Type |
Description |
|||||||||||||
|
code |
Number |
Http request status code Example: 200, 400, 500 |
|||||||||||||
|
message |
String |
成功或失败时显示的结果信息 |
|||||||||||||
|
data |
Array |
|
|||||||||||||
|
|
receiptId |
Number |
取消(退货)申请编号 |
||||||||||||
|
|
orderId |
Number |
订单号 |
||||||||||||
|
|
paymentId |
Number |
付款编号 |
||||||||||||
|
|
receiptType |
String |
取消类型 |
||||||||||||
|
|
receiptStatus |
String |
取消(退货)状态
|
||||||||||||
|
|
createdAt |
String |
取消(退货)申请受理时间 yyyy-MM-ddThh:mm:ss |
||||||||||||
|
|
modifiedAt |
String |
取消(退货)状态最终变更时间 yyyy-MM-ddThh:mm:ss |
||||||||||||
|
|
requesterName |
String |
退货申请人姓名 |
||||||||||||
|
|
requesterPhoneNumber |
String |
退货申请人电话号码(安心码) |
||||||||||||
|
|
requesterRealPhoneNumber |
String |
退货申请人真实号码 null |
||||||||||||
|
|
requesterAddress |
String |
退货回收地址 |
||||||||||||
|
|
requesterAddressDetail |
String |
退货回收详细地址 |
||||||||||||
|
|
requesterZipCode |
String |
退货回收地邮政编码 |
||||||||||||
|
|
cancelReasonCategory1 |
String |
退货理由品类1 |
||||||||||||
|
|
cancelReasonCategory2 |
String |
退货理由品类2 |
||||||||||||||||
|
|
cancelReason |
String |
取消理由详情 |
||||||||||||||||
|
|
cancelCountSum |
Number |
取消总数 |
||||||||||||||||
|
|
returnDeliveryId |
Number |
退货配送编号 |
||||||||||||||||
|
|
returnDeliveryType |
String |
回收类型
顾客直接发送退货商品或没有可回收商品时，会显示“ ” |
||||||||||||||||
|
|
releaseStopStatus |
String |
停止发货处理状态
|
||||||||||||||||
|
|
enclosePrice |
Object |
同封配送费 |
||||||||||||||||
|
|
|
currencyCode |
String |
货币码（符合ISO-4217标准），3位大写字母 |
|||||||||||||||
|
|
|
units |
Number |
货币整数部分，64-bit |
|||||||||||||||
|
|
|
nanos |
Number |
货币小数部分，32-bit，取值范围 [-999999999, 999999999] |
|||||||||||||||
|
|
faultByType |
String |
归责类型
|
||||||||||||||||
|
|
preRefund |
Boolean |
是否预付 |
||||||||||||||||
|
|
completeConfirmType |
String |
确认类型
|
||||||||||||||||
|
|
completeConfirmDate |
String |
确认时间 yyyy-MM-ddTHH:mm:ss |
||||||||||||||||
|
|
returnItems |
Array |
退货商品列表 |
||||||||||||||||
|
|
|
vendorItemPackageId |
Number |
Deal编号 |
|||||||||||||||
|
|
|
vendorItemPackageName |
String |
Deal 名称 |
|||||||||||||||
|
|
|
vendorItemId |
Number |
属性ID *以"vendorItemId"为单位受理退货商品。 受理时请务必确认属性ID。 |
|||||||||||||||
|
|
|
vendorItemName |
String |
属性名 |
|||||||||||||||
|
|
|
cancelCount |
Number |
取消数量 *可部分取消商品。请务必确认取消(退货)数量。 |
|||||||||||||||
|
|
|
purchaseCount |
Number |
订单数量 |
|||||||||||||||
|
|
|
shipmentBoxId |
Number |
原始配送编号 |
|||||||||||||||
|
|
|
sellerProductId |
Number |
卖家注册商品编号 |
|||||||||||||||
|
|
|
sellerProductName |
String |
卖家注册商品名 |
|||||||||||||||
|
|
|
releaseStatus |
String |
商品退货状态
|
|||||||||||||||
|
|
|
cancelCompleteUser |
String |
订单取消负责人 (3P_CANCEL: 在商品准备中状态下取消时) |
|||||||||||||||
|
|
returnDeliveryDtos |
Array |
回收运单号信息 每个receiptId可能会出现多个回收运单信息 |
||||||||||||||||
|
|
|
deliveryCompanyCode |
String |
回收物流公司代码 |
|||||||||||||||
|
|
|
deliveryInvoiceNo |
String |
回收运单号 回收运单号数值为“”或null时，则可忽略 |
|||||||||||||||
|
|
reasonCode |
String |
退货原因代码 请下载页面上方的VOC原因代码，确认退货运单号信息 |
||||||||||||||||
|
|
reasonCodeText |
String |
退货原因说明 |
||||||||||||||||
|
|
returnShippingCharge |
Object |
预估退货运费
|
||||||||||||||||
|
|
|
currencyCode |
String |
货币码（符合ISO-4217标准），3位大写字母 |
|||||||||||||||
|
|
|
units |
Number |
货币整数部分，64-bit |
|||||||||||||||
|
|
|
nanos |
Number |
货币小数部分，32-bit，取值范围 [-999999999, 999999999] |
|||||||||||||||
|
|
nextToken |
String |
下次调用所需的Token值 “searchType=timeFrame”时，该参数不可用。 |
||||||||||||||||
返回消息示例
{
"code": 200,
"message": "OK",
"data": [
{
"receiptId": 50229613,
"orderId": 28000008707838,
"paymentId": 28000009486604,
"receiptType": "RETURN",
"receiptStatus": "RETURNS_UNCHECKED",
"createdAt": "2025-01-15T14:17:13.973885-08:00",
"modifiedAt": "2025-01-15T14:17:13.973885-08:00",
"requesterName": "구*숙",
"requesterPhoneNumber": "+1(555)444-1234",
"requesterRealPhoneNumber": null,
"requesterAddress": "서울특별시 송파구 송파대로 570 (신천동)",
"requesterAddressDetail": "Tower 730",
"requesterZipCode": "05510",
"cancelReasonCategory1": "고객변심",
"cancelReasonCategory2": "단순변심(사유없음)",
"cancelReason": "",
"cancelCountSum": 1,
"returnDeliveryId": 20234047,
"returnDeliveryType": "연동택배",
"releaseStopStatus": "처리(이미출고)",
"enclosePrice": {
"currencyCode": "KRW",
"units": 0,
"nanos": 0
},
"faultByType": "CUSTOMER",
"preRefund": false,
"completeConfirmDate": "",
"completeConfirmType": "UNDEFINED",
"returnItems": [
{
"vendorItemPackageId": 0,
"vendorItemPackageName": "스파오(SPAO) (#)시원하고 편안한 캉캉 롱스커트",
"vendorItemId": 3187044096,
"vendorItemName": "스파오(SPAO) (#)시원하고 편안한 캉캉 롱스커트, (19)Black, S",
"purchaseCount": 1,
"cancelCount": 1,
"shipmentBoxId": 123456789012345678,
"sellerProductId": 57623797,
"sellerProductName": "스파오 (#)시원하고 편안한 캉캉 롱스커트,(19)Black S",
"releaseStatus": "S",
"cancelCompleteUser": "l******"
}
],
"returnDeliveryDtos": [
{
"deliveryCompanyCode": "CJGLS",
"deliveryInvoiceNo": "*******"
}
],
"reasonCode": "CHANGEMIND",
"reasonCodeText": "필요 없어짐 (단순 변심)",
"returnShippingCharge": {
"currencyCode": "KRW",
"units": -3000,
"nanos": 0
}
]
nextToken: ""
}错误代码
|
HTTP状态代码（错误类型）
|
错误信息
|
解决方案
|
|
400 (确认请求参数) |
Invalid vendor ID |
请确认您输入的卖家ID(vendorId)是否正确。 |
|
400 (确认请求参数) |
OrderId can't be null , if doesn't pass the parameter status |
请确认是否输入了订单号(orderId)。未输入退货状态(status)数值时，订单号(orderId)为必填项。 |
|
400 (确认请求参数) |
搜索时间段不得大于31天。 |
请确认您输入的搜索时间段是否小于31天。 |
|
400 (确认请求参数) |
搜索结束日期早于搜索开始日期。SearchPeriod=-** |
请确认您设置开始日期(createdAtFrom)和结束日期(createdAtTo)时是否输入了相反数值。 |
|
412 (服务器错误) |
Read timed out |
请缩短搜索时间段后再试。点击相关FAQ! |
接口名称
GET_RETURN_REQUEST_BY_QUERY