coupang
API 文件
商品 API品類 API運輸 / 訂單 API退貨 API換貨 API物流資訊客服 / 諮詢
GET/v2/providers/openapi/apis/api/v6/vendors/{vendorId}/returnRequests/{receiptId}2609170000

單件退貨查詢

# 01

簡介

單件退貨查詢

# 02

詳細內容

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

請求引數

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

X-MARKET: TW

路徑引數

名稱 是否必須 資料型別 描述
vendorId O String 賣家ID
receiptId O Number 退貨受理編號 (不支持取消編號 ) 您可透過退貨申請陣列查詢API檢視ReceiptId 。 ReceiptId必須為number型別。

請求體例子

無

返回訊息

名稱 型別 描述
code String Http響應狀態碼 例子: 200, 400, 500
message String 成功或失敗時顯示的結果資訊
data Array
receiptId Number 退貨申請編號
orderId Number 訂單號
paymentId Number 付款編號
receiptType String 取消型別 RETURN
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
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]

返回訊息例子

{
"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

路徑

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
# 03

Path 參數

NameTypeDescription
vendorId*string
賣家ID
receiptId*number
退貨受理編號 (不支持取消編號 )

您可透過退貨申請陣列查詢API檢視ReceiptId 。

ReceiptId必須為number型別。
vendorId*string
賣家ID
receiptId*number
退貨受理編號 (不支持取消編號 )

您可透過退貨申請陣列查詢API檢視ReceiptId 。

ReceiptId必須為number型別。
# 04

回應內容

回應訊息

NameTypeDescription
codestring
Http響應狀態碼

例子: 200, 400, 500
messagestring
成功或失敗時顯示的結果資訊
dataobject[]
receiptId
data[].receiptId
integer
退貨申請編號
orderId
data[].orderId
integer
訂單號
paymentId
data[].paymentId
integer
付款編號
receiptType
data[].receiptType
string
取消型別

RETURN
receiptStatus
data[].receiptStatus
string
退貨狀態
程式碼 描述
RELEASE_STOP_UNCHECKED 申請停止發貨
RETURNS_UNCHECKED 接收退貨申請
VENDOR_WAREHOUSE_CONFIRM 已入庫
REQUEST_COUPANG_CHECK 申請酷澎介入
RETURNS_COMPLETED 已退貨

Response Example

{
  "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": 123456789012345680,
          "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
      }
    }
  ]
}
# 05

錯誤碼

HTTP代碼訊息
400HTTP_400Bad Request

錯誤說明

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

ReceiptId doesn't belong to the vendorId, or cannot find the Receipt by the given id

請確認您查詢的退貨受理編號(receiptId)是否已被顧客撤回。您可透過退貨撤回記錄受理編號查詢API 確認撤回詳情。已撤回的退貨受理編號將無法再被查詢到。