coupang
GET/v2/providers/openapi/apis/api/v3/return/shipping-places/center-codev1

Query one return location

# 01

Summary

Available buyer market: Korea, Taiwan Query a return location using the return center code (returncenterCode).

# 02

Details

Available buyer market: Korea, Taiwan
Query a return location using the return center code (returncenterCode).
 

Path

GET

/v2/providers/openapi/apis/api/v3/return/shipping-places/center-code

Example Endpoint

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v3/return/shipping-places/center-code?returnCenterCodes=1000000051,1000006047

Request Parameters

Query String Parameter

Name Required Type Description
returnCenterCodes O String
Return center code
Up to 100 returnCenterCodes can be queried at once
ex) 1000554021,1000554704

Request Example

 
not require body

Response Message

 
Name Type Description
code Number
Server response code
message String
Server response message
data Array
Return location info
  vendorId String
Vendor code
  returnCenterCode String
Return center code
  shippingPlaceName String
Name of return location
  deliverCode String
Courier code
  deliverName String
Courier name
  goodsflowStatus String
Goodsflow status
  errorMessage String
Error message
  createAt String
Creation date
  vendorCreditFee02kg Number
Credit fee on a product of 2kg (Seller credit)
Must be greater than 0
  vendorCreditFee05kg Number
Credit fee on a product of 5kg (Seller credit)
Must be greater than 0 
  vendorCreditFee10kg Number
Credit fee on a product of 10kg (Seller credit)
Must be greater than 0 
  vendorCreditFee20kg Number
Credit fee on a product of 20kg (Seller credit)
Must be greater than 0 
  vendorCashFee02kg Number
Upfront fee on a product of 2kg (Seller cash)
Must be greater than 0
  vendorCashFee05kg Number
Upfront fee on a product of 5kg (Seller cash)
Must be greater than 0 
  vendorCashFee10kg Number
Upfront fee on a product of 10kg (Seller cash)
Must be greater than 0 
  vendorCashFee20kg Number
Upfront fee on a product of 20kg (Seller cash)
Must be greater than 0 
  consumerCashFee02kg Number
On-arrival fee on a product of 2kg (Buyer cash)
Must be greater than 0 
  consumerCashFee05kg Number
On-arrival fee on a product of 5kg (Buyer cash)
Must be greater than 0 
  consumerCashFee10kg Number
On-arrival fee on a product of 10kg (Buyer cash)
Must be greater than 0 
  consumerCashFee20kg Number
On-arrival fee on a product of 20kg (Buyer cash)
Must be greater than 0 
  returnFee02kg Number
Return fee on a product of 2kg
Must be greater than 0 
  returnFee05kg Number
Return fee on a product of 5kg
Must be greater than 0 
  returnFee10kg Number
Return fee on a product of 10kg
Must be greater than 0 
  returnFee20kg Number
Return fee on a product of 20kg
Must be greater than 0 
  usable boolean
Usable Y/N
  placeAddresses Array
Address of return location
    addressType String
Address type 
JIBUN, JIBUN&ROADNAME
CODE Mean
JIBUN Land lot number
ROADNAME Road name
    countryCode String
Country code, "KR" for domestic location
    companyContactNumber String
Phone number of return location
    phoneNumber2 String
Secondary phone number
    returnZipCode String
Zip code of return location
    returnAddress String
Address of return location
    returnAddressDetail String
Detailed address of return location

Response Example

{
  "code": 200,
  "message": "OK",
  "data": [
    {
      "vendorId": "A00123456",
      "returnCenterCode": "1000552675",
      "shippingPlaceName": "32757 R",
      "deliverCode": "HANJIN",
      "deliverName": "한진택배",
      "goodsflowStatus": "승인",
      "errorMessage": "",
      "createdAt": 1579727107000,
      "vendorCreditFee02kg": 3000,
      "vendorCreditFee05kg": 3000,
      "vendorCreditFee10kg": 3000,
      "vendorCreditFee20kg": 3000,
      "vendorCashFee02kg": 3000,
      "vendorCashFee05kg": 3000,
      "vendorCashFee10kg": 3000,
      "vendorCashFee20kg": 3000,
      "consumerCashFee02kg": 3000,
      "consumerCashFee05kg": 3000,
      "consumerCashFee10kg": 3000,
      "consumerCashFee20kg": 3000,
      "returnFee02kg": 3000,
      "returnFee05kg": 3000,
      "returnFee10kg": 3000,
      "returnFee20kg": 3000,
      "usable": true,
      "placeAddresses": [
        {
          "addressType": "JIBUN",
          "countryCode": "KR",
          "companyContactNumber": "051-261-6120",
          "phoneNumber2": "000-0000-0000",
          "returnZipCode": "49525",
          "returnAddress": "부산시 사하구 다대로",
          "returnAddressDetail": "613"
        }
      ]
    }
  ]
}

Error Spec

HTTP status code (error type) Error message How to resolve
400 (check request parameter) center code should not be empty... Chekc if the return center code (returnCenterCodes) is empty.
500 (server error) Read timed out

An error has occurred for the return location query. Call the API again sometime later or edit the entry.

Click on related FAQ!

URL API Name

GET_SHIPPING_BY_CENTER_CODE