You can update a shipping location.
You need outboundShippingPlaceCode and remoteInfoId to update a shipping location
You can acquire outboundShippingPlaceCode and remoteInfoId using 'Query a shipping location' API.
※ After the domestic or overseas classification set at the time of registration of the shipping address is determined, it is not possible to change from domestic to overseas or from overseas to domestic. If you want to change the division between domestic and overseas, please register a new shipping address.
Path
PUT
/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/outboundShippingCenters/{outboundShippingPlaceCode}
Example Endpoint
https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012345/outboundShippingCenters/123456
Request Parameters
Path Segment Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| vendorId | O | String |
Seller ID
Unique code issued to seller by Coupang
Ex) A00012345 |
||||
| outboundShippingPlaceCode | O | Number |
Shipping location code you want to update
|
||||
Body Parameter
| Name | Required | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| vendorId | O | String |
Seller ID
Unique code issued to seller by Coupang
Ex) A00012345 |
||||||||||||
| userId | O | String |
User ID (Coupang WING ID)
|
||||||||||||
| outboundShippingPlaceCode | Number |
Shipping location code
If the value is "null", name of shipping location doesn't change.
|
|||||||||||||
| shippingPlaceName | String |
Shipping location name
|
|||||||||||||
| usable | Boolean |
Whether it is usable
|
|||||||||||||
| global | Boolean |
Domestic or overseas
|
|||||||||||||
| placeAddresses | O | Array |
Address of shipping location출고지 주소
|
||||||||||||
| addressType | String |
Address type
|
|||||||||||||
| countryCode | String |
Country code, input "KR" for domestic address, Valid length: 2
|
|||||||||||||
| companyContactNumber | String |
Phone number, e.g. : xx-yyy-zzzz,
|
|||||||||||||
| phoneNumber2 | String |
Alternate phone number
(Format: Same as the phone number) |
|||||||||||||
| returnZipCode | String |
Zipcode: number, 5~6 digits
|
|||||||||||||
| returnAddress | String |
Address, up to 150 characters
|
|||||||||||||
| returnAddressDetail | String |
Detailed address, up to 200 characters
|
|||||||||||||
| remoteInfos | Array |
Additional shipping fee for remote areas
|
|||||||||||||
| remoteInfoId | Number |
You don't have to fill in this field to create new shipping information. You must fill in this field to update/delete the shipping information.
You can get the value of this field through query API.
|
|||||||||||||
| deliveryCode | String |
Courier code
You can register multiple couriers, but duplicate registration is impossible.
|
|||||||||||||
| jeju | Number |
Shipping fee for Jeju Island (won)
You can enter KRW 0 or between KRW 1,000 - 8,000 (down to the unit of KRW 100); Excluding payment on delivery.
Exception EPOST courier: You can enter KRW 0 or between KRW 100 - 400 (down to the unit of KRW 100); Excluding payment on delivery.
|
|||||||||||||
| notJeju | Number |
Shipping fee for areas other than Jeju Island (won)
Same as Jeju Island
|
|||||||||||||
| usable | Boolean |
Whether it is usable
You don't need to fill in this field to create new shipping information. Set it as "true" to update and as "false" to delete.
|
|||||||||||||
Request Example
{
"vendorId": "A00012345",
"userId": "Test11",
"outboundShippingPlaceCode": 123456,
"shippingPlaceName": "테스트 출고지 코드",
"placeAddresses": [
{
"addressType": "ROADNAME",
"countryCode": "KR",
"companyContactNumber": "02-1111-1111",
"phoneNumber2": "",
"returnZipCode": "05510",
"returnAddress": "서울특별시 송파구 송파대로 570 (신천동)",
"returnAddressDetail": "테스트 주소 101동 101호"
},
{
"addressType": "JIBUN",
"countryCode": "KR",
"companyContactNumber": "02-1111-1111",
"phoneNumber2": "",
"returnZipCode": "05510",
"returnAddress": "서울특별시 송파구 신천동 7-30",
"returnAddressDetail": "테스트 주소 101동 101호"
}
],
"remoteInfos": [
{
"remoteInfoId": 176476,
"deliveryCode": "DONGBU",
"jeju": 0,
"notJeju": 0,
"usable": true
}
],
"usable": true
}Response Message
| Name | Type | Description | ||||
|---|---|---|---|---|---|---|
| code | Number |
server response status code
|
||||
| message | String |
detail info
|
||||
| data | Object |
|
||||
| resultCode | String |
code
|
||||
| resultMessage | String |
message
|
||||
Response Example
{
"code": "200",
"message": "SUCCESS",
"data": {
"resultCode": "SUCCESS",
"resultMessage": "Modify successfully"
}
}Error Spec
| HTTP status code (type of error) | Error message | Solution |
|---|---|---|
| 400 (Request parameter check) | You can enter KRW 0 or between KRW 100 - 400 |
In the case of EPOST courier, make sure that you enter KRW 0 or between KRW 100 - 400 |
| 400 (Request parameter check) | Post code can't be empty |
Check if returnZipCode value was entered. |
| 400 (Duplicate entry) |
[Duplicate shipping location] The same address has been registered (Duplicate location code: 2026xxxx) |
Check if the same returnAddress value was entered. |
| 400 (Duplicate entry) | [Duplicate shipping location] Duplicated request. name:xxxxx | Check if the same returnAddress value was entered. |
| 400 (Request parameter check) | Shipping fee should be 0, or a number from 1,000 to 20,000 won. |
Check if the right range of value was entered for jeju, notJeju value. Enter 0 or a number from 1,000 to 20,000 won as the shipping fee for remote areas. |
| 400 (Request parameter check) | The format of postal code is invalid, it can only be number | Check if characters not numbers were entered for returnZipCode value. |
| 400 (Request parameter check) | params are not allowed null... | Check if null value was entered. |
| 400 (Request parameter check) | params's vendorId not equals gateway's vendorId! | Check if wrong vendorID was entered. |
| 400 (Request parameter check) | The max length of the shipping place name is 50, please input the correct length name |
Check if more than 50 characters were entered for shippingPlaceName value. |
| 400 (Request parameter check) | The address detail info can't be null(placeAddress) | Check if returnAddress value was entered. |
| 400 (Request parameter check) | Must input the default phone number(phoneNumber1) | Check if phoneNumber1 value was entered. |
| 400 (Request parameter check) | Must input the default address(address1) | Check if returnAddress value was entered. |
| 400 (Request parameter check) | The length of country code is 2, please input correct length country code | Check if the right countryCode value was entered. |
| 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 '-'. |
| 400 (Request parameter check) | The format of postal code is invalid, it can only be number, min length is 5 and max length is 6 | Check if the right returnZipCode value was entered. It should be only numbers and 5~6 digits. |
URL API Name
UPDATE_OUTBOUND_SHIPPING_PLACECODE