API支持的买家用户地区:韩国、台湾
通过退货受理编号查询单件退货情况。
路径
GET
/v2/providers/openapi/apis/api/v6/vendors/{vendorId}/returnRequests/{receiptId}
示例
https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v6/vendors/A00012697/returnRequests/363585
请求参数
| 名称 | 必须 | 数据类型 | 描述 |
| vendorId | O | String | 卖家ID |
| receiptId | O | Number |
退货受理编号(不支持取消编号) 您可通过退货申请列表查询API查看ReceiptId 。 ReceiptId必须为number类型。 |
请求体
无
返回消息
| 名称 | 数据类型 | 描述 | |||||||||||||
| code | String |
Http request status code Example: 200, 400, 500 |
|||||||||||||
| message | String | 成功或失败时显示的结果信息 | |||||||||||||
| data | Array | ||||||||||||||
| receiptId | Number | 退货申请编号 | |||||||||||||
| orderId | Number | 订单号 | |||||||||||||
| paymentId | Number | 付款编号 | |||||||||||||
| receiptType | String |
取消类型 RETURN
|
|||||||||||||
| receiptStatus | String |
退货状态
|
|||||||||||||
| createdAt | String |
取消(退货)受理时间 (符合ISO-8601標準) 格式: YYYY-MM-DDThh:mm:ss.ssssss±hh:mm |
||||||||||||||
| modifiedAt | String |
取消(退货)状态最终变更时间 (符合ISO-8601標準) 格式: YYYY-MM-DDThh:mm:ss.ssssss±hh:mm |
||||||||||||||
| 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] | ||||||||||||||
返回消息示例
{
"code": "200",
"message": "OK",
"data": [
{
"receiptId": 365937,
"orderId": 500004398,
"paymentId": 700003957,
"receiptType": "반품",
"receiptStatus": "RELEASE_STOP_UNCHECKED",
"createdAt": "025-01-15T14:17:13.973885-08:00",
"modifiedAt": "025-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": 40453,
"returnDeliveryType": "연동택배",
"releaseStopStatus": "미처리",
"enclosePrice": {
"currencyCode": "KRW",
"units": 0,
"nanos": 0
},
"faultByType": "CUSTOMER",
"preRefund": false,
"completeConfirmDate": "",
"completeConfirmType": "미확인",
"returnItems": [
{
"vendorItemPackageId": 0,
"vendorItemPackageName": "객지/한씨연대기/삼포 가는 길/섬섬옥수/몰개월의 새",
"vendorItemId": 3000001893,
"vendorItemName": "객지/한씨연대기/삼포 가는 길/섬섬옥수/몰개월의 새 1",
"purchaseCount": 1,
"cancelCount": 1,
"shipmentBoxId": 123456789012345678,
"sellerProductId": 130,
"sellerProductName": "객지/한씨연대기/삼포 가는 길/섬섬옥수/몰개월의 새 1",
"releaseStatus": "S",
"cancelCompleteUser": "l******"
}
],
"returnDeliveryDtos": [
{
"deliveryCompanyCode": "DIRECT",
"deliveryInvoiceNo": "201807261200"
},
{
"deliveryCompanyCode": "DIRECT",
"deliveryInvoiceNo": "201807261200"
}
],
"reasonCode": "CHANGEMIND",
"reasonCodeText": "필요 없어짐 (단순 변심)",
"returnShippingCharge": {
"currencyCode": "KRW",
"units": -3000,
"nanos": 0
}
}
]
}
错误代码
| HTTP状态代码(错误类型) | 错误信息 | 解决方案 |
| 400 (确认请求参数) | ReceiptId doesn't belong to the vendorId, or cannot find the Receipt by the given id | 请确认您查询的退货受理编号(receiptId)是否已被顾客撤回。您可通过退货撤回记录受理编号查询API 确认撤回详情。已撤回的退货受理编号将无法再被查询到。 |
接口名称
GET_RETURN_REQUEST_BY_RECEIPT