이 섹션의 문서

해외 주소록 목록 조회

판매자가 등록한 해외 주소록 목록을 조회합니다.

파라미터를 입력하여 특정 해외 주소를 목록으로 조회할 수 있습니다.
상품 등록 시 이미 등록된 주소로 매핑하여 중복된 배송지ID 메시지가 리턴될 때,
배송지ID 로 조회하여 기존 등록 주소를 확인하는 등 다양한 경우에서 활용할 수 있습니다.
활용 전 기존 주소가 올바르게 등록되어 있는지 확인해 주세요.

 

1. 기본 정보

메서드 URL
GET /v1/shopping/bizseller/foreign-seller-addresses/search

 

2. 요청 (파라미터)

필드명 타입 필수여부 설명
name Long 선택 배송지 ID
page Integer 선택 페이지 번호 (기본 값: 0)
pageSize Integer 선택 페이지 사이즈 (기본 값: 10, 최대 값: 100)

 

3. 응답

1) 본문

필드명 타입 설명
contents Array<SellerAddress> 배송지 목록
last Boolean 마지막 페이지 여부
totalCount Long 전체 수

2) SellerAddress

필드명 타입 설명
id Long 배송지 ID
name String 배송지명
postNumber String 우편번호
basicAddress String 주소
detailAddress String 추가주소
contact 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/search?name=LA배송지&page=0&pageSize=10
  -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
{
  "contents": [
    {
      "id": 140597,
      "name": "LA배송지",
      "postNumber": "13494",
      "contact": "555-1234",
      "basicAddress": "3708 S11 Las Vegas Blvd",
      "detailAddress": "5th Floor",
      "callingCode": "+1",
      "countryIsoCode": "US",
      "state": "Nevada",
      "city": "Las Vegas",
      "defaultSendAddress": true,
      "defaultReturnAddress": true
    },
    {
      "id": 140596,
      "name": "LA배송지",
      "postNumber": "13494",
      "contact": "555-2345",
      "basicAddress": "3708 S Las Vegas Blvd",
      "detailAddress": "7th Floor",
      "callingCode": "+1",
      "countryIsoCode": "US",
      "state": "Nevada",
      "city": "Las Vegas",
      "defaultSendAddress": false,
      "defaultReturnAddress": false
    }
  ],
  "totalCount": 2,
  "last": true
}

3) 응답: 제약사항 위반

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
    "errorMessage": "유효하지 않은 요청입니다.",
    "errorCode": -10001,
    "errorName": "validation_error",
    "errorCategory": "common",
    "validation": {
        "pageSize": [
            "최대 100건 조회할 수 있습니다."
        ]
    }
}

관련 문서