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

Query one return location

# 01

Summary

Query one return location

# 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

URL API Name

GET_SHIPPING_BY_CENTER_CODE
# 03

Query parameters

NameTypeDescription
returnCenterCodes*string
Return center code
Up to 100 returnCenterCodes can be queried at once
ex) 1000554021,1000554704
# 04

Response body

Response message

NameTypeDescription
codeinteger
Server response code
messagestring
Server response message
dataobject[]
Return location info
vendorId
data[].vendorId
string
Vendor code
returnCenterCode
data[].returnCenterCode
string
Return center code
shippingPlaceName
data[].shippingPlaceName
string
Name of return location
deliverCode
data[].deliverCode
string
Courier code
deliverName
data[].deliverName
string
Courier name
goodsflowStatus
data[].goodsflowStatus
string
Goodsflow status
errorMessage
data[].errorMessage
string
Error message
createAt
data[].createAt
string
Creation date
vendorCreditFee02kg
data[].vendorCreditFee02kg
integer
Credit fee on a product of 2kg (Seller credit)
Must be greater than 0
vendorCreditFee05kg
data[].vendorCreditFee05kg
integer
Credit fee on a product of 5kg (Seller credit)
Must be greater than 0
vendorCreditFee10kg
data[].vendorCreditFee10kg
integer
Credit fee on a product of 10kg (Seller credit)
Must be greater than 0
vendorCreditFee20kg
data[].vendorCreditFee20kg
integer
Credit fee on a product of 20kg (Seller credit)
Must be greater than 0
vendorCashFee02kg
data[].vendorCashFee02kg
integer
Upfront fee on a product of 2kg (Seller cash)
Must be greater than 0
vendorCashFee05kg
data[].vendorCashFee05kg
integer
Upfront fee on a product of 5kg (Seller cash)
Must be greater than 0
vendorCashFee10kg
data[].vendorCashFee10kg
integer
Upfront fee on a product of 10kg (Seller cash)
Must be greater than 0
vendorCashFee20kg
data[].vendorCashFee20kg
integer
Upfront fee on a product of 20kg (Seller cash)
Must be greater than 0
consumerCashFee02kg
data[].consumerCashFee02kg
integer
On-arrival fee on a product of 2kg (Buyer cash)
Must be greater than 0
consumerCashFee05kg
data[].consumerCashFee05kg
integer
On-arrival fee on a product of 5kg (Buyer cash)
Must be greater than 0
consumerCashFee10kg
data[].consumerCashFee10kg
integer
On-arrival fee on a product of 10kg (Buyer cash)
Must be greater than 0
consumerCashFee20kg
data[].consumerCashFee20kg
integer
On-arrival fee on a product of 20kg (Buyer cash)
Must be greater than 0
returnFee02kg
data[].returnFee02kg
integer
Return fee on a product of 2kg
Must be greater than 0
returnFee05kg
data[].returnFee05kg
integer
Return fee on a product of 5kg
Must be greater than 0
returnFee10kg
data[].returnFee10kg
integer
Return fee on a product of 10kg
Must be greater than 0
returnFee20kg
data[].returnFee20kg
integer
Return fee on a product of 20kg
Must be greater than 0
usable
data[].usable
boolean
Usable Y/N
placeAddresses
data[].placeAddresses
object[]
Address of return location
addressType
data[].placeAddresses[].addressType
string
Address type
JIBUN, JIBUN&ROADNAME
CODE Mean
JIBUN Land lot number
ROADNAME Road name
countryCode
data[].placeAddresses[].countryCode
string
Country code, "KR" for domestic location
companyContactNumber
data[].placeAddresses[].companyContactNumber
string
Phone number of return location
phoneNumber2
data[].placeAddresses[].phoneNumber2
string
Secondary phone number
returnZipCode
data[].placeAddresses[].returnZipCode
string
Zip code of return location
returnAddress
data[].placeAddresses[].returnAddress
string
Address of return location
returnAddressDetail
data[].placeAddresses[].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"
        }
      ]
    }
  ]
}
# 05

Error codes

HTTPCodeMessage
400HTTP_400Bad Request

Error specification

HTTPTypeError messageSolution
400400 (check request parameter)

center code should not be empty...

Chekc if the return center code (returnCenterCodes) is empty.

500500 (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!