판매자가 등록한 국내 주소록을 조회합니다.
등록된 국내 주소록을 전체 조회할 수 있으며, 파라미터를 입력하여 특정 국내 주소를 조회할 수 있습니다. 상품 등록 시 이미 등록된 주소로 매핑하여 중복된 배송지ID 메시지가 리턴될 때, 배송지ID 로 조회하여 기존 등록 주소를 확인하는 등 다양한 경우에서 활용할 수 있습니다. 활용 전 기존 주소가 올바르게 등록되어 있는지 확인해 주세요. |
1. 기본 정보
메서드 | URL |
---|---|
GET | /v1/shopping/bizseller/seller-addresses/search
|
2. 요청 (파라미터)
필드명 | 타입 | 필수여부 | 설명 |
---|---|---|---|
id | Long | 선택 | 배송지 ID |
name | String | 선택 | 배송지명 |
page | int | 필수 | 페이지 번호 (기본 값 : 0) |
3. 응답
필드명 | 타입 | 설명 |
---|---|---|
contents | Array<SellerAddressResponse> | 판매자 주소 목록 |
last | Long | 마지막 페이지 여부 |
totalCount | String | 전체 수 |
4. 예제
1) 응답
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"contents": [
{
"id": 100002,
"name": "판매자주소명 C",
"postNo": "00000",
"contact": "031-000-0000",
"addressPost": "경기도 성남시 분당구 대왕판교로 660 유스페이스",
"addressDetail": "A동 7층",
"returnFeeAmount": 2500,
"exchangeFeeAmount": 5000,
"basicReturnAddress": false,
"basicSenderAddress": false,
"sellerId": 0000
},
{
"id": 100001,
"name": "판매자주소명 B",
"postNo": "00000",
"contact": "031-000-0000",
"addressPost": "경기도 성남시 분당구 대왕판교로 660 유스페이스",
"addressDetail": "A동 6층",
"returnFeeAmount": 3000,
"exchangeFeeAmount": 6000,
"basicReturnAddress": false,
"basicSenderAddress": false,
"sellerId": 0000
},
{
"id": 100000,
"name": "판매자주소명 A",
"postNo": "00000",
"contact": "031-000-0000",
"addressPost": "경기도 성남시 분당구 대왕판교로 660 유스페이스",
"addressDetail": "A동 5층",
"returnFeeAmount": 0,
"exchangeFeeAmount": 0,
"basicReturnAddress": false,
"basicSenderAddress": false,
"sellerId": 0000
}
],
"totalCount": 3,
"last": true
}
2) 응답 에러
{"errorMessage":"유효하지 않은 요청입니다.",
"errorCode":-10001,
"errorName":"validation_error",
"errorCategory":"common",
"validation":{"name":["name을(를) 입력해주세요."],
"postNo":["postNo는 필수값입니다.을(를) 입력해주세요."]}}