판매자가 등록한 해외 주소록 단건을 조회합니다.
파라미터를 입력하여 특정 해외 주소를 단건으로 조회할 수 있습니다. 상품 등록 시 이미 등록된 주소로 매핑하여 중복된 배송지ID 메시지가 리턴될 때, 배송지ID 로 조회하여 기존 등록 주소를 확인하는 등 다양한 경우에서 활용할 수 있습니다. 활용 전 기존 주소가 올바르게 등록되어 있는지 확인해 주세요. |
1. 기본 정보
메서드 | URL |
---|---|
GET | /v1/shopping/bizseller/foreign-seller-addresses |
2. 요청 (파라미터)
필드명 | 타입 | 필수여부 | 설명 |
---|---|---|---|
id | Long | 선택 | 배송지 ID |
3. 응답
필드명 | 타입 | 설명 |
---|---|---|
id | Long | 배송지 ID |
name | String | 배송지명 |
postNumber | String | 우편번호 |
contact | String | 연락처 |
basicAddress | String | 주소 |
detailAddress | String | 추가주소 |
callingCode | String | 연락처 국제전화코드 |
countryIsoCode | String | 국가코드 |
state | String | 행정구역 |
city | String | 도시 |
defaultSendAddress | Boolean | 기본 출고지 |
defaultReturnAddress | Boolean | 기본 반품지 |
4. 예제
1) 요청
curl -X GET https://kapi.kakao.com/v1/shopping/bizseller/foreign-seller-addresses?id=1000 \
-H 'Authorization: KakaoAK ${대행사_ADMIN_KEY}' \
-H 'Target-Authorization: KakaoAK ${판매자_REST_API_KEY}' \
-H 'Content-type: application/json'
2) 응답
HTTP/1.1 200 OK
Content-type: application/json;charset=UTF-8
{
"id": 1000,
"name": "LA출고지",
"postNumber": "12345",
"contact": "1234-1234",
"basicAddress": "3708 S Las Vegas Blvd",
"detailAddress": "7th Floor",
"callingCode": "+1",
"state": "Nevada",
"city": "Las Vegas",
"defaultSendAddress": false,
"defaultReturnAddress": false
}
3) 응답: 주소록에 없는 경우
HTTP/1.1 200 OK
Content-type: application/json;charset=UTF-8
{
"errorMessage": "존재하지 않는 리소스입니다.",
"errorCode": -10004,
"errorName": "not_found_resource",
"errorCategory": "common"
}