coupang
API Documentation
ProductsCategoriesBrandsShipments & OrdersReturnsExchangesPromotions & CouponsLogistics InfoCustomer ServiceSettlementCGF / CGF liteRocket Growth
GET/v2/providers/openapi/apis/api/v6/vendors/{vendorId}/returnRequests/{receiptId}v1

Query one return request

# 01

Summary

Available buyer market: Korean, Taiwan Query one return request using a return application number.

# 02

Details

Available buyer market: Korean, Taiwan

Query one return request using a return application number.

Path

GET

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

Example Endpoint

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v6/vendors/A00012697/returnRequests/363585

Request Parameters

Path Segment Parameter

Name Required Type Description
vendorId O  String
Seller ID
receiptId O  Number
Return receipt number (Cancellation number not supported)
You can check ReceiptId via return request list query API.
ReceiptId must be a number type.

Request Example

 
not require body

Response Message

Name Type Description
code String
Http request status code
Example: 200, 400, 500
message String
When succeed or fail, the result message appears.
data Array
 
  receiptId Number
Return application number
  orderId Number
Order number
  paymentId Number
Payment number
  receiptType String
Cancellation type
RETURN
  receiptStatus String
Cancellation(Return) status
code description
RELEASE_STOP_UNCHECKED Request to stop shipping out
RETURNS_UNCHECKED Return application
VENDOR_WAREHOUSE_CONFIRM Inbound complete
REQUEST_COUPANG_CHECK Request Coupang to check
RETURNS_COMPLETED Return complete
  createdAt String
Time of cancellation(return) application (Requires ISO-8601 Compliance)

YYYY-MM-DDThh:mm:ss.ssssss±hh:mm
  modifiedAt String
Time that cancellation(Return) status changed for the last time (Requires ISO-8601 Compliance)

YYYY-MM-DDThh:mm:ss.ssssss±hh:mm
  requesterName String
Name of the person who requested return
  requesterPhoneNumber String
Tel No of the person who requested return
  requesterRealPhoneNumber String
Actual tel No of the person who requested return
null
  requesterAddress String
Collection address
  requesterAddressDetail String
Detail address of the collection address
  requesterZipCode String
Zip code of collection address
  cancelReasonCategory1 String
Return reason category 1
  cancelReasonCategory2 String
Return reason category 2
  cancelReason String
Detailed reason of cancellation
  cancelCountSum Number
Total cancellation
  returnDeliveryId Number
Return delivery number
  returnDeliveryType String
Type of return
  • Dedicated courier
  • Integrated courier
  • Manual management
If a customer shipped return product himself or when there is no product to collect back it is displayed as "".
  releaseStopStatus String
Status of stop shipping
  • Not processed
  • Processed(Already shipped)
  • Processed(Shipping stopped)
  • Automatically processed(Already shipped)
  • N/A
  enclosePrice Object
Enclosed shipping fee
    currencyCodeString String Three-letter uppercase string (format follows ISO-4217)
    units Number 64-bit integer representing the integer part of the monetary value
    nanos Number 32-bit integer representing the decimal part of the monetary value, in the range of [-999999999, 999999999]
  faultByType String
Fault type
  Value
Coupang's fault COUPANG
Seller's fault  VENDOR
Customer's fault CUSTOMER
Logistics' fault WMS
General GENERAL
 
  preRefund Boolean
Quick refund
  completeConfirmType String
Type of completed checking
  Value
Checked by a vendor VENDOR_CONFIRM
Not checked UNDEFINED
CS checked  CS_CONFIRM
CS checked the loss CS_LOSS_CONFIRM
  completeConfirmDate String
Time of checking completion
yyyy-MM-ddTHH:mm:ss
  returnItems Array
List of return items
    vendorItemPackageId Number
Deal number
*do not use
    vendorItemPackageName String
Deal name
*do not use
    vendorItemId Number
Option ID
*We receive return request by vendorItemId. Option ID must be checked in return application
    vendorItemName String
Option name
    cancelCount Number
Cancellation quantity
*Partial return is viable. Please check the cancellation(return) quantity.
    purchaseCount Number
Order quantity
    shipmentBoxId Number
Original waybill number
    sellerProductId Number
Product number registered by a seller
    sellerProductName String
Product name registered by a seller
    releaseStatus String

Status of product shipping
 

Code Status
Y Shipped
N Not shipped out
S Shipping stopped
A Already shipped
    cancelCompleteUser String
Owner who handles order cancellation
(3P_CANCEL: When an order is cancelled at the stage of 'preparing a product')
  returnDeliveryDtos Array
Return waybill info
There can be multiple return waybill info by receiptId
    deliveryCompanyCode String
Return courier code
    deliveryInvoiceNo String
Return waybill number
Disregard when return waybill number is "" or null.
  reasonCode String
Return reason code
Download VOC reason code at the top of return request list page to check it.
  reasonCodeText String
Description of return reason
  returnShippingCharge Object

Estimated return shipping fee
 

Type Shipping fee paid by
Positive number(+) Paid by a seller
Negative number(-) Paid by a customer
    currencyCodeString String Three-letter uppercase string (format follows ISO-4217)
    units Number 64-bit integer representing the integer part of the monetary value
    nanos Number 32-bit integer representing the decimal part of the monetary value, in the range of [-999999999, 999999999]

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": 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
           }
       }
   ]
}


 

Error Spec

HTTP status code(Error type) Error message Solution
400 (Check request parameter) ReceiptId doesn't belong to the vendorId, or cannot find the Receipt by the given id Check the return application number(receiptId) that you query has been cancelled by a customer. You can query it using API to query application number for return cancellation history. Process not to query cancelled return request number any more.

URL API Name

GET_RETURN_REQUEST_BY_RECEIPT