이 섹션의 문서

해외 주소록 수정

판매자 주소록에 등록된 해외 주소를 수정합니다.

먼저 ‘해외 주소록 단건 조회 API’를 통해 등록된 주소지 정보를 조회한 후, 필요한 내용을 수정하여 전송해 주세요.
단, 동일한 주소는 중복 등록할 수 없으며, 에러 메시지가 리턴됩니다.
이 경우 에러 메시지 내 중복된 배송지ID 가 리턴되므로 기존에 등록된 주소를 활용해 주세요.

 

1. 기본 정보

메서드 URL
POST /v1/shopping/bizseller/foreign-seller-addresses/modify

 

2. 요청 (파라미터)

필드명 타입 필수여부 설명
id Long 필수 배송지 ID
name String 필수 배송지명 (50자 이내)
postNumber String 필수 우편번호
basicAddress String 비필수 기본주소 (500자 이내)
detailAddress String 필수 추가주소 (100자 이내)
contact String 필수 연락처 (14자 이내)
callingCode String 필수  연락처 국제전화코드
countryIsoCode String 필수 국가코드
state String 필수 행정구역 (40자 이내)
city String 필수 도시 (40자 이내)
defaultSendAddress Boolean 비필수 기본 출고지 (기본 값: false)
defaultReturnAddress Boolean 비필수 기본 반품지 (기본 값: false)

 

3. 예제

1) 요청

curl -X PUT 'https://kapi.kakao.com/v1/shopping/bizseller/foreign-seller-addresses/modify' \
-H 'Authorization: KakaoAK ${대행사_ADMIN_KEY}' \ 
-H 'Target-Authorization: KakaoAK ${판매자_REST_API_KEY}' \ 
-H 'Content-type: application/json'
-d '{
    "id": 1000,
    "addressName": "기본출고",
    "postNumber": "13494",
    "basicAddress": "3708 S Las Vegas Blvd",
    "detailAddress": "5th Floor 11",
    "contact": "1234-1234",
    "callingCode": "+1",
    "state": "Nevada",
    "city": "Las Vegas",
    "countryIsoCode": "US",
    "defaultSendAddress": false,
    "defaultReturnAddress": false
}'

2) 응답

HTTP/1.1 200 OK
Content-Length: 0
Content-type: application/json;charset=UTF-8

3) 응답: 제약사항 위반

HTTP/1.1 200 OK
Content-type: application/json;charset=UTF-8
{
    "errorMessage": "유효하지 않은 요청입니다.",
    "errorCode": -10001,
    "errorName": "validation_error",
    "errorCategory": "common",
    "validation": {
        "basicAddress": [
            "이미 등록된 주소입니다. (배송지 ID: 603252)"
        ],
        "city": [
            "이미 등록된 주소입니다. (배송지 ID: 603252)"
        ],
        "detailAddress": [
            "이미 등록된 주소입니다. (배송지 ID: 603252)"
        ],
        "state": [
            "이미 등록된 주소입니다. (배송지 ID: 603252)"
        ]
    }
}

관련 문서