coupang
API Documentation
ProductsCategoriesBrandsShipments & OrdersReturnsExchangesPromotions & CouponsLogistics InfoCustomer ServiceSettlementCGF / CGF liteRocket Growth
GET/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/returnWithdrawRequestsv1

Query return return withdrawal history by date range

# 01

Summary

Available buyer market: Korean Search for the return withdrawal history per given time window.

# 02

Details

Available buyer market: Korean

Search for the return withdrawal history per given time window.
Data of maximum 7 days can be queried
(note: Start date and end date for search are included in the date range)
 

Path

GET

/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/returnWithdrawRequests

Example Endpoint

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012345/returnWithdrawRequests?sizePerPage=3&pageIndex=1&dateFrom=2018-11-03&dateTo=2018-11-06

Request Parameters

Path Segment Parameter

Name Required Type Description
vendorId O String 
Seller ID

Unique seller id issued by Coupang

e.g. A00012345

Query String Parameter

Name Required Type Description
dateFrom O String
Search start date (yyyy-MM-dd)
dateTo O String 
Search end date (yyyy-MM-dd)
pageIndex   Number
Index value to query the next page
Default value: 1
It it’s the last page, an empty value (“”) will be displayed
sizePerPage   Number
Maximum number of request per page
Default: 10, Max: 100

Request Example

 
not require body

Response Message

Name Type Description
code Number
Http request status code
Example: 200, 400, 500
message String
This message will be displayed at request success or failure.
data Array
 
  cancelId Number
Return receiptID
  orderId Number
Order ID
  vendorId String
Seller ID

Unique seller id issued by Coupang

e.g. A00012345
  refundDeliveryDuty String
Return at which party’s fault
CODE Mean
COM Seller
CUS Customer
COU Coupang
  createdAt String

Time of return withdrawal
yyyy-MM-ddThh:mm:ss
  vendorItemIds Array
Return option ID list
nextPageIndex String
Index value to query the next page
It it’s the last page, an empty value (“”) will be displayed.

Response Example

{
  "code": 200,
  "message": "OK",
  "data": [
    {
      "cancelId": 116607450,
      "orderId": 29000024470847,
      "vendorId": "A00123456",
      "refundDeliveryDuty": "COM",
      "createdAt": "2018-11-06T23:50:39",
      "vendorItemIds": [
        3838728011
      ]
    },
    {
      "cancelId": 116600657,
      "orderId": 7000024098976,
      "vendorId": "A00123456",
      "refundDeliveryDuty": "CUS",
      "createdAt": "2018-11-06T23:03:40",
      "vendorItemIds": [
        3930729129
      ]
    },
    {
      "cancelId": 116590024,
      "orderId": 27000024100568,
      "vendorId": "A00123456",
      "refundDeliveryDuty": "COM",
      "createdAt": "2018-11-06T21:39:57",
      "vendorItemIds": [
        3841979364
      ]
    }
  ],
  "nextPageIndex": "2"
}

Error Spec

HTTP status code (error type) Error message Solution
400 (check request metric) Invalid vendor ID Check if the vendorID value is correct
400 (check request metric) Query date range should be no bigger than 7 days. Check if date range for search is no greater than 7 days.
400 (check request metric) End date should be the same or later date than start date Check if search start date and end date are correct
400 (check request metric) The maximum line items on a page (sizePerPage) should be 100. Check if sizePerPage request is equal or less than 100.
400 (check request metric) pageindex cannot be negative or “0”. Check if pageindex is negative or “0”.
400 (check request metric) Please check the date input format. (yyyy-MM-dd) Make sure if search start date and end date are in the right format.
400 (check request metric) Required String parameter 'dateFrom' is not present Make sure if the search start date is put in.
400 (check request metric) Required String parameter 'dateTo' is not present Make sure if the search end date is put in.

URL API Name

GET_RETURNWITHDRAW_REQUEST