coupang
GET/v2/providers/openapi/apis/api/v6/vendors/{vendorId}/returnRequests2609170000

查詢退貨/取消訂單記錄

# 01

簡介

查詢退貨/取消訂單記錄

# 02

詳細內容

API 適用的买方用户區域:韓國、台灣

您可根據受理日期查詢退貨/取消申請記錄。

傳送商品前,請務必透過【退貨申請陣列查詢】確認是否有商品受理了“申請停止發貨”。

您可根據searchType=timeframe 設定以分鐘/天為單位進行查詢。

查詢在已付款階段被取消的訂單時,除orderId引數外,還須使用cancelType=CANCEL引數。

請下載以下資料,確認各退貨訂單的退貨原因(reasonCode)。

[下載] 換貨/退貨/取消原因程式碼

您可將查詢週期設定為最長31天。資料量大時,查詢可能會出現超時錯誤,因此我們建議您將週期設定得越短越好。

顧客申請停止發貨時(在商品準備階段受理退貨申請時),可在RU(申請停止發貨)和UC(申請退貨)狀態下檢視。

路徑

GET

/v2/providers/openapi/apis/api/v6/vendors/{vendorId}/returnRequests

例子

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v6/vendors/vendorid/returnRequests?createdAtFrom=2025-07-24&createdAtTo=2025-07-24&cancelType=CANCEL

請求 header 除 Authorization 和 X-Requested-By 之外需要額外添加:

X-MARKET: TW

路徑引數

名稱 是否必須 型別 描述
vendorId O String 賣家ID 酷澎提供給賣家的固有程式碼 ex) A00012345

查詢引數

名稱 是否必須 型別 描述
searchType O String 以分鐘為單位查詢退貨申請陣列時,鬚髮送"searchType=timeFrame" 引數。
createdAtFrom O String 搜尋開始日期(yyyy-MM-dd) (符合ISO-8601標準)例:2025-05-24“searchType=timeFrame”時,輸入“YYYY-MM-DDThh:mm” 例:2025-05-24T00:01
createdAtTo O String 搜尋開始日期(yyyy-MM-dd) (符合ISO-8601標準)例:2025-05-24“searchType=timeFrame”時,輸入“YYYY-MM-DDThh:mm” 例:2025-05-24T23:59
status String 退貨狀態 程式碼 描述 RU 申請停止發貨 UC 受理退貨申請 CC 已退貨 PR 申請酷澎介入 “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”時,該引數不可用。

請求體例子

返回訊息

名稱 型別 描述
code Number Http request status code Example: 200, 400, 500
message String 成功或失敗時顯示的結果資訊
data Array
receiptId Number 取消(退貨)申請編號
orderId Number 訂單號
paymentId Number 付款編號
receiptType String 取消型別 RETURN or CANCEL
receiptStatus String 取消(退貨)狀態 程式碼 描述 RELEASE_STOP_UNCHECKED 申請停止發貨 RETURNS_UNCHECKED 受理退貨申請 VENDOR_WAREHOUSE_CONFIRM 已入庫 REQUEST_COUPANG_CHECK 申請酷澎介入 RETURNS_COMPLETED 已退貨
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 退貨申請人電話號碼(安心碼) (格式需符合E.164標準)
requesterRealPhoneNumber String 退貨申請人真實號碼 (格式需符合E.164標準)
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 歸責型別 責任值含義 取消 酷澎過失 COUPANG 合作方 (賣家) 過失 VENDOR 顧客過失 CUSTOMER 物流過失 WMS 一般 GENERAL
preRefund Boolean 是否預付
completeConfirmType String 確認型別 確認值含義 取消 合作方確認 VENDOR_CONFIRM 未確認 UNDEFINED CS代理確認 CS_CONFIRM CS確認損失 CS_LOSS_CONFIRM 未完成確認的訂單標示為UNDEFINED 依職權取消的訂單標示為 CS_CONFIRM
completeConfirmDate String 確認時間 (符合ISO-8601標準) 格式: YYYY-MM-DDThh:mm:ss.ssssss±hh:mm
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 商品退货状态 代碼 狀態 Y 已發貨 N 未發貨 S 停止發貨 A 已發過貨
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

路徑

GET/v2/providers/openapi/apis/api/v6/vendors/{vendorId}/returnRequests

範例端點

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v6/vendors/vendorid/returnRequests?createdAtFrom=2025-07-24&createdAtTo=2025-07-24&cancelType=CANCEL
# 03

Path 參數

NameTypeDescription
vendorId*string
賣家ID

酷澎提供給賣家的固有程式碼

ex) A00012345
# 04

Query 參數

NameTypeDescription
searchType*string
以分鐘為單位查詢退貨申請陣列時,鬚髮送"searchType=timeFrame" 引數。
createdAtFrom*string
搜尋開始日期(yyyy-MM-dd) (符合ISO-8601標準)
例:2025-05-24
“searchType=timeFrame”時,輸入“YYYY-MM-DDThh:mm”
例:2025-05-24T00:01
createdAtTo*string
搜尋開始日期(yyyy-MM-dd) (符合ISO-8601標準)
例:2025-05-24
“searchType=timeFrame”時,輸入“YYYY-MM-DDThh:mm”
例:2025-05-24T23:59
statusstring
退貨狀態
程式碼 描述
RU 申請停止發貨
UC 受理退貨申請
CC 已退貨
PR 申請酷澎介入
“cancelType=CANCEL”時,該引數不可用。
cancelTypestring
nextTokenstring
查詢下一頁所需的token值

查詢第一頁時不需要

“searchType=timeFrame”,該引數不可用。
maxPerPagenumber
每頁最長可申請查詢的值

預設值 = 50

“searchType=timeFrame”時,該引數不可用。

”cancelType=CANCEL“時,輸出的結果可能少於申請的maxPerPage。
orderIdnumber
訂單號

除status外,查詢時引數中還須包含orderId。

“searchType=timeFrame”時,該引數不可用。
# 05

回應內容

回應訊息

NameTypeDescription
codenumber
Http request status code

Example: 200, 400, 500
messagestring
成功或失敗時顯示的結果資訊
dataobject[]
receiptId
data[].receiptId
number
取消(退貨)申請編號
orderId
data[].orderId
number
訂單號
paymentId
data[].paymentId
number
付款編號
receiptType
data[].receiptType
string
取消型別
RETURN or CANCEL
receiptStatus
data[].receiptStatus
string
取消(退貨)狀態
程式碼 描述
RELEASE_STOP_UNCHECKED 申請停止發貨
RETURNS_UNCHECKED 受理退貨申請
VENDOR_WAREHOUSE_CONFIRM 已入庫
REQUEST_COUPANG_CHECK 申請酷澎介入
RETURNS_COMPLETED 已退貨
createdAt
data[].createdAt
string
取消(退貨)申請受理時間 (符合ISO-8601標準)

格式: YYYY-MM-DDThh:mm:ss.ssssss±hh:mm
modifiedAt
data[].modifiedAt
string
取消(退貨)狀態最終變更時間 (符合ISO-8601標準)

格式: YYYY-MM-DDThh:mm:ss.ssssss±hh:mm
requesterName
data[].requesterName
string
退貨申請人姓名
requesterPhoneNumber
data[].requesterPhoneNumber
string
退貨申請人電話號碼(安心碼) (格式需符合E.164標準)
requesterRealPhoneNumber
data[].requesterRealPhoneNumber
string
退貨申請人真實號碼 (格式需符合E.164標準)
requesterAddress
data[].requesterAddress
string
退貨回收地址
requesterAddressDetail
data[].requesterAddressDetail
string
退貨回收詳細地址
requesterZipCode
data[].requesterZipCode
string
退貨回收地郵政編碼
cancelReasonCategory1
data[].cancelReasonCategory1
string
退貨理由品類1

Response Example

{
 "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: ""
}
# 06

錯誤碼

HTTP代碼訊息
400HTTP_400Bad Request

錯誤說明

HTTP類型錯誤訊息解決方案
400400 (確認請求引數)

Invalid vendor ID

請確認您輸入的賣家ID(vendorId)是否正確。

400400 (確認請求引數)

OrderId can't be null , if doesn't pass the parameter status

請確認是否輸入了訂單號(orderId)。未輸入退貨狀態(status)數值時,訂單號(orderId)為必填項。

400400 (確認請求引數)

搜尋時間段不得大於31天。

請確認您輸入的搜尋時間段是否小於31天。

400400 (確認請求引數)

搜尋結束日期早於搜尋開始日期。SearchPeriod=-**

請確認您設定開始日期(createdAtFrom)和結束日期(createdAtTo)時是否輸入了相反數值。

412412 (伺服器錯誤)

Read timed out

請縮短搜索時間斷後再試。點選相關FAQ!