Update a return location.
The return location code (returnCenterCode) is needed to update the return location.
The return location code (returnCenterCode) is needed to update the return location.
Path
PUT
/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/returnShippingCenters/{returnCenterCode}
Example Endpoint
https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012345/returnShippingCenters/1100044653
Request Parameters
Path Segment Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| vendorId | O | String |
Seller ID
Unique code issued to Vendor by Coupang
ex) A00012345 |
||||
| returnCenterCode | O | Number |
Return location code
|
||||
Body Parameter
| Name | Required | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| vendorId | O | String |
Seller ID
Unique code issued to Vendor by Coupang
ex) A00012345 |
||||||||||||
| returnCenterCode | O | Number |
Return location code
|
||||||||||||
| userId | O | String |
User ID(Coupang WING ID)
|
||||||||||||
| shippingPlaceName | String |
Name of return location
If "null," the name of return location stays the same.
|
|||||||||||||
| usable | boolean |
Usable Y/N
|
|||||||||||||
| placeAddresses | O | Array |
Address of return location
|
||||||||||||
| addressType | String |
Address type
JIBUN, JIBUN&ROADNAME
|
|||||||||||||
| companyContactNumber | String |
Phone number, e.g.: xx-yyy-zzzz,
|
|||||||||||||
| phoneNumber2 | String |
Secondary phone number (format: Same as Phone Number 1)
|
|||||||||||||
| returnZipCode | String |
Zip code: Numeric, min. 5 digits and max. 6 digits
|
|||||||||||||
| returnAddress | String |
Address, max. length of 150
|
|||||||||||||
| returnAddressDetail | String |
Detailed address, max. length of 200
|
|||||||||||||
| goodsflowInfoDto | Object |
Info about Goodflow shipment integration
|
|||||||||||||
| vendorCreditFee05kg | Number |
Credit fee on a product of 5kg (Seller credit)
Must be greater than 0
As it's not used anywhere else, enter the return shipping fee used for Product Creation API
Subject: vendorCreditFee05kg~returnFee20kg
|
|||||||||||||
| 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 |
|||||||||||||
| 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 |
|||||||||||||
| 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 |
|||||||||||||
| 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 |
|||||||||||||
Request Example
{
"userId":"testId",
"vendorId":"A00012345",
"returnCenterCode":"1000558900",
"shippingPlaceName":"반품지 -20200214-2modi",
"usable":"true",
"goodsflowInfoOpenApiDto":{
"vendorCreditFee05kg":"2500",
"vendorCreditFee10kg":"2500",
"vendorCreditFee20kg":"2500",
"vendorCashFee05kg":"2500",
"vendorCashFee10kg":"2500",
"vendorCashFee20kg":"2500",
"consumerCashFee05kg":"2500",
"consumerCashFee10kg":"2500",
"consumerCashFee20kg":"2500",
"returnFee05kg":"2500",
"returnFee10kg":"2500",
"returnFee20kg":"2500"
},
"placeAddresses": [{
"addressType":"JIBUN",
"companyContactNumber":"070-****-8008",
"phoneNumber2":"010-****-7993",
"returnZipCode":"110794",
"returnAddress":"서울특별시 종로구 인사동5길 25 (인사동)",
"returnAddressDetail":"하나로빌딩"
}]
}Response Message
| Name | Type | Description | ||||
|---|---|---|---|---|---|---|
| code | Number |
Server response code
|
||||
| message | String |
Server response message
|
||||
| data | Array |
Result of updating return location
|
||||
| resultCode | String |
Result code
SUCCESS or FAIL
|
||||
| resultMessage | String |
Result message
|
||||
Response Example
{
"code": 200,
"message": "SUCCESS",
"data": {
"resultCode": "SUCCESS",
"resultMessage": "Modify successfully"
}
}Error Spec
| HTTP status code (error type) | Error message | How to resolve |
|---|---|---|
| 400 (check request parameter) | params are not allowed null... |
Check if the seller ID (vendorId), return location code (returnCenterCode) and user ID (userId) are null. |
| 400 (check request parameter) | The address name is already registered (Duplicate address code: 1000*******) |
Check if a return location with the same name (shippingPlaceName) is already registered. Do not double-register one return location. |
| 400 (Request parameter check) | Please input the correct phone number format including numbers and '-' (min 9, max 13) | Check if companyContactNumber or phoneNumber2 value was entered in the right format. It should be 9 ~ 13 digits including '-'. |
URL API Name
UPDATE_SHIPPING_CENTER_BY_RETURN_CENTER_CODE