해외 주소록 등록 – Kakao Shopping Open API

판매자 주소록에 해외 주소를 신규 등록합니다.

등록된 해외 주소는 '톡스토어 해외배송 상품' 등록 시 출고지 및 반품/교환지 정보로 활용할 수 있습니다.
(해외배송 상품은 권한이 있는 판매자만 가능합니다.)
단, 동일한 주소는 중복 등록할 수 없으며, 에러 메시지가 리턴됩니다.
이 경우 에러 메시지 내 중복된 배송지ID 가 리턴되므로 기존에 등록된 주소를 활용해 주세요.

1. 기본 정보

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

판매자 주소록 API 호출 시 판매 채널 정보를 따로 설정하지 않아도 됩니다.
등록된 배송지는 톡스토어 및 선물하기 상품 등록 시 공통으로 사용할 수 있습니다.

2. 요청 (파라미터)

1) 본문

필드명	타입	필수여부	설명
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. 응답

필드명	타입	설명
id	Long	배송지 ID

4. 예제

1) 요청

curl -X POST 'https://kapi.kakao.com/v1/shopping/bizseller/foreign-seller-addresses/register' \
-H 'Authorization: KakaoAK ${대행사_ADMIN_KEY}' \ 
-H 'Target-Authorization: KakaoAK ${판매자_REST_API_KEY}' \ 
-H 'Content-type: application/json'
-d '{
    "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-type: application/json;charset=UTF-8
{
    "id": 1000
}

3) 응답: 제약사항 위반

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

이 섹션의 문서