GET
/v2/providers/openapi/apis/api/v5/vendors/{vendorId}/returnShippingCenters2609170000Query a list of return locations
# 01
Summary
Query a list of return locations
# 02
Details
Available buyer market: Korea Taiwan
Query return locations using the vendor code.
Path
GET/v2/providers/openapi/apis/api/v5/vendors/{vendorId}/returnShippingCenters
Example endpoint
https://api-gateway.coupang.com/v5/providers/openapi/apis/api/v5/vendors/A00012345/returnShippingCenters?pageNum=1&pageSize=50URL API Name
GET_SHIPPING_CENTER_BY_VENDOR
# 03
Path parameters
| Name | Type | Description |
|---|---|---|
| vendorId* | string | Seller ID Unique code issued to Vendor by Coupang ex) A00012345 |
# 04
Query parameters
| Name | Type | Description |
|---|---|---|
| pageNum | number | of pages1 by default |
| pageSize | number | of results per page10 by default, up to 50 |
# 05
Response body
Response message
| Name | Type | Description |
|---|---|---|
| code | integer | Server response code
|
| message | string | Server response message
|
| data | object | Data on return location list
|
| content data.content | object[] | |
| vendorId data.content[].vendorId | string | |
| returnCenterCode data.content[].returnCenterCode | string | |
| shippingPlaceName data.content[].shippingPlaceName | string | |
| deliverCode data.content[].deliverCode | string | |
| deliverName data.content[].deliverName | string | |
| goodsflowStatus data.content[].goodsflowStatus | string | |
| errorMessage data.content[].errorMessage | string | |
| createdAt data.content[].createdAt | integer | |
| vendorCreditFee02kg data.content[].vendorCreditFee02kg | string | |
| vendorCreditFee05kg data.content[].vendorCreditFee05kg | integer | |
| vendorCreditFee10kg data.content[].vendorCreditFee10kg | integer | |
| vendorCreditFee20kg data.content[].vendorCreditFee20kg | integer | |
| vendorCashFee02kg data.content[].vendorCashFee02kg | string | |
| vendorCashFee05kg data.content[].vendorCashFee05kg | integer | |
| vendorCashFee10kg data.content[].vendorCashFee10kg | integer | |
| vendorCashFee20kg data.content[].vendorCashFee20kg | integer | |
| consumerCashFee02kg data.content[].consumerCashFee02kg | string | |
| consumerCashFee05kg data.content[].consumerCashFee05kg | integer | |
| consumerCashFee10kg data.content[].consumerCashFee10kg | integer | |
| consumerCashFee20kg data.content[].consumerCashFee20kg | integer | |
| returnFee02kg data.content[].returnFee02kg | string | |
| returnFee05kg data.content[].returnFee05kg | integer | |
| returnFee10kg data.content[].returnFee10kg | integer | |
| returnFee20kg data.content[].returnFee20kg | integer | |
| usable data.content[].usable | boolean | |
| placeAddresses data.content[].placeAddresses | object[] | |
| addressType data.content[].placeAddresses[].addressType | string | |
| countryCode data.content[].placeAddresses[].countryCode | string | |
| companyContactNumber data.content[].placeAddresses[].companyContactNumber | string | |
| phoneNumber2 data.content[].placeAddresses[].phoneNumber2 | string | |
| returnZipCode data.content[].placeAddresses[].returnZipCode | string | |
| returnAddress data.content[].placeAddresses[].returnAddress | string | |
| returnAddressDetail data.content[].placeAddresses[].returnAddressDetail | string | |
| pagination data.pagination | object | |
| currentPage data.pagination.currentPage | integer | |
| totalPages data.pagination.totalPages | integer | |
| totalElements data.pagination.totalElements | integer | |
| countPerPage data.pagination.countPerPage | integer |
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
}
}
}# 06
Error codes
| HTTP | Code | Message |
|---|---|---|
| 400 | HTTP_400 | Bad Request |
Error specification
| HTTP | Type | Error message | Solution |
|---|---|---|---|
| 400 | 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 | 500 (server error) | Read timed out | Shorten the query period and call API again sometime later. |