Products Categories Brands Shipments & Orders Returns Exchanges Promotions & Coupons Logistics Info Customer Service Settlement CGF / CGF lite Rocket Growth

Returns

POST/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/returnWithdrawList2609170000

Query return withdrawal history by receiptID

# 01

Summary

# 02

Details

Available buyer market: Korean
Search for the return withdrawal history by using cancel (return) receipt IDs.

Path

POST/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/returnWithdrawList

Example endpoint

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012345/returnWithdrawList

URL API Name

GET_RETURNWITHDRAW_BY_CANCEL_IDS

# 03

Path parameters

Name	Type	Description
vendorId*	string	Seller ID Unique seller id issued by Coupang e.g. A00012345

# 04

Request body

Request parameters

Body parameter

Name	Type	Description
cancelIds*	object[]	List of cancellation (return) receipt IDs to query cancellation history Maximum 50 cancellIds can be queried at once. CancellIds should be number type.

Request exampleapplication/json

{
  "cancelIds": [
    87033689
  ]
}

# 05

Response body

Response message

Name

Type

Description

code

string

Http request status code
Example: 200, 400, 500

message

string

This message will be displayed at request success or failure.

data

object[]

cancelId

data[].cancelId

integer

Cancellation (return) receipt ID

orderId

data[].orderId

integer

Order ID

vendorId

data[].vendorId

string

Seller code

refundDeliveryDuty

data[].refundDeliveryDuty

string

Return at which party’s fault

CODE	Mean
COM	업체
CUS	고객
COU	쿠팡

createdAt

data[].createdAt

string

Time of return (cancel) withdrawal

yyyy-MM-ddThh:mm:ss

vendorItemIds

data[].vendorItemIds

object[]

Return option ID list

Response Example

{
  "code": "200",
  "message": "OK",
  "data": [
    {
      "cancelId": 87033689,
      "orderId": 23000016565020,
      "vendorId": "A00001234",
      "refundDeliveryDuty": "COM",
      "createdAt": "2018-06-05T13:40:56",
      "vendorItemIds": [
        3737624764
      ]
    }
  ]
}

# 06

Error codes

HTTP	Code	Message
400	HTTP_400	Bad Request

Error specification

HTTP	Type	Error message	Solution
500	500 (check request metric)	CReturns getWithdrawnList failed	Please make sure accurate cancelIds (return receipt IDs) were put in. When the value is not properly keyed in, 500 error happens.