Query return locations using the vendor code.
Path
GET
/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/returnShippingCenters
Example Endpoint
https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012345/returnShippingCenters?pageNum=1&pageSize=50
Request Parameters
Path Segment Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| vendorId | O | String |
Seller ID
Unique code issued to Vendor by Coupang ex) A00012345 |
||||
Query String Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| pageNum | Number |
# of pages
1 by default
|
|||||
| pageSize | Number |
# of results per page
10 by default, up to 50
|
|||||
Request Example
not require body
Response Message
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | Number |
Server response code
|
||||||||||||
| message | String |
Server response message
|
||||||||||||
| data | Array |
Data on return location list
|
||||||||||||
| vendorId | String |
Vendor code
|
||||||||||||
| returnCenterCode | String |
Return center code
|
||||||||||||
| shippingPlaceName | String |
Return location name
|
||||||||||||
| 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 |
Return address
|
||||||||||||
| addressType | String |
Address type
JIBUN, JIBUN&ROADNAME
|
||||||||||||
| 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": "SUCCESS",
"data": {
"content": [
{
"vendorId": "A00012345",
"returnCenterCode": "1000557004",
"shippingPlaceName": "32777 R",
"deliverCode": "HANJIN",
"deliverName": "한진택배",
"goodsflowStatus": "승인",
"errorMessage": "",
"createdAt": 1581195908000,
"vendorCreditFee02kg": null,
"vendorCreditFee05kg": 3000,
"vendorCreditFee10kg": 3000,
"vendorCreditFee20kg": 3000,
"vendorCashFee02kg": null,
"vendorCashFee05kg": 3000,
"vendorCashFee10kg": 3000,
"vendorCashFee20kg": 3000,
"consumerCashFee02kg": null,
"consumerCashFee05kg": 3000,
"consumerCashFee10kg": 3000,
"consumerCashFee20kg": 3000,
"returnFee02kg": null,
"returnFee05kg": 3000,
"returnFee10kg": 3000,
"returnFee20kg": 3000,
"usable": true,
"placeAddresses": [
{
"addressType": "JIBUN",
"countryCode": "KR",
"companyContactNumber": "02-111-1111",
"phoneNumber2": "000-0000-0000",
"returnZipCode": "42701",
"returnAddress": "대구시 달서구 성서공단로",
"returnAddressDetail": "235"
}
]
},
{
"vendorId": "A00012345",
"returnCenterCode": "1000557003",
"shippingPlaceName": "32776 R",
"deliverCode": "HANJIN",
"deliverName": "한진택배",
"goodsflowStatus": "승인",
"errorMessage": "",
"createdAt": 1581195906000,
"vendorCreditFee02kg": null,
"vendorCreditFee05kg": 3000,
"vendorCreditFee10kg": 3000,
"vendorCreditFee20kg": 3000,
"vendorCashFee02kg": null,
"vendorCashFee05kg": 3000,
"vendorCashFee10kg": 3000,
"vendorCashFee20kg": 3000,
"consumerCashFee02kg": null,
"consumerCashFee05kg": 3000,
"consumerCashFee10kg": 3000,
"consumerCashFee20kg": 3000,
"returnFee02kg": null,
"returnFee05kg": 3000,
"returnFee10kg": 3000,
"returnFee20kg": 3000,
"usable": true,
"placeAddresses": [
{
"addressType": "JIBUN",
"countryCode": "KR",
"companyContactNumber": "010-9857-****",
"phoneNumber2": "010-9857-****",
"returnZipCode": "28805",
"returnAddress": "충청북도 청주시 서원구 장성동",
"returnAddressDetail": "111"
}
]
},
{
"vendorId": "A00012345",
"returnCenterCode": "1000555466",
"shippingPlaceName": "27487 R",
"deliverCode": "HANJIN",
"deliverName": "한진택배",
"goodsflowStatus": "승인",
"errorMessage": "",
"createdAt": 1580795274000,
"vendorCreditFee02kg": null,
"vendorCreditFee05kg": 3000,
"vendorCreditFee10kg": 3000,
"vendorCreditFee20kg": 3000,
"vendorCashFee02kg": null,
"vendorCashFee05kg": 3000,
"vendorCashFee10kg": 3000,
"vendorCashFee20kg": 3000,
"consumerCashFee02kg": null,
"consumerCashFee05kg": 3000,
"consumerCashFee10kg": 3000,
"consumerCashFee20kg": 3000,
"returnFee02kg": null,
"returnFee05kg": 3000,
"returnFee10kg": 3000,
"returnFee20kg": 3000,
"usable": true,
"placeAddresses": [
{
"addressType": "JIBUN",
"countryCode": "KR",
"companyContactNumber": "02-722-****",
"phoneNumber2": "000-0000-0000",
"returnZipCode": "12615",
"returnAddress": "경기도 여주시 북내면 가정1길",
"returnAddressDetail": "62 (가정리)"
}
]
},
{
"vendorId": "A00012345",
"returnCenterCode": "1000552893",
"shippingPlaceName": "32759 R",
"deliverCode": "HANJIN",
"deliverName": "한진택배",
"goodsflowStatus": "승인",
"errorMessage": "",
"createdAt": 1579813508000,
"vendorCreditFee02kg": null,
"vendorCreditFee05kg": 3000,
"vendorCreditFee10kg": 3000,
"vendorCreditFee20kg": 3000,
"vendorCashFee02kg": null,
"vendorCashFee05kg": 3000,
"vendorCashFee10kg": 3000,
"vendorCashFee20kg": 3000,
"consumerCashFee02kg": null,
"consumerCashFee05kg": 3000,
"consumerCashFee10kg": 3000,
"consumerCashFee20kg": 3000,
"returnFee02kg": null,
"returnFee05kg": 3000,
"returnFee10kg": 3000,
"returnFee20kg": 3000,
"usable": true,
"placeAddresses": [
{
"addressType": "JIBUN",
"countryCode": "KR",
"companyContactNumber": "000-1588-0***",
"phoneNumber2": "000-0000-0000",
"returnZipCode": "07345",
"returnAddress": "서울시 영등포구 63로",
"returnAddressDetail": "50 "
}
]
}
],
"pagination": {
"currentPage": 1,
"totalPages": 749,
"totalElements": 7488,
"countPerPage": 10
}
}
}
Error Spec
| HTTP status code (error type) | Error message | How to resolve |
|---|---|---|
| 400 (check request parameter) | The vendorId in path or requestBody doesn't match the one got from api-gateway. |
Check if the seller ID (VendorId) is correct. |
| 500 (server error) | Read timed out |
Shorten the query period and call API again sometime later. |
URL API Name
GET_SHIPPING_CENTER_BY_VENDOR