판매자주소록 관리 API

Description

등록 : [POST] https://sa2.esmplus.com/item/v1/sellers/address 수정 : [PUT] https://sa2.esmplus.com/item/v1/sellers/address/{addrNo} 조회 : [GET] https://sa2.esmplus.com/item/v1/sellers/address/{addrNo} 전체 조회 : [GET] https://sa2.esmplus.com/item/v1/sellers/addresses

출하지, 반품/교환 배송지 설정에 필요한 판매자 주소록 관리 API 입니다. 등록시 마스터 ID 하위 모든 사이트 판매자 ID 에서 사용할 수 있습니다. 배송템플릿 설정 위해서는 주소록, 출하지, 배송비 정책, 발송 정책을 차례로 등록합니다. 등록한 주소록, 출하지, 배송비 정책, 발송 정책는 상품등록/수정시 필수값으로 등록되어야 합니다.

Request Description

항목	항목명	필수여부	Type	Description
addrNo	판매자주소록번호	Y	Path	수정[PUT] / 조회[GET]일 경우만 필수 등록시 response로 자동채번된 번호
addrName	주소명	Y	string	판매자가 관리하려는 주소명 입력
representativeName	판매자명	Y	string	고객에게 반품수취인으로 노출되는 판매자명
zipCode	우편번호	Y	string	우편번호 5자리/6자리 등록 가능 (단, 5자리 우편번호로 입력 권장) 우편번호 6자리 등록 시, 하이픈 제거하고 입력
addr1	주소1	Y	string	우편번호 기준 주소
addr2	주소2	Y	string	주소 상세
homeTel	일반전화번호	Y	string	하이픈 구분 입력 필요
cellPhone	휴대폰번호	Y	string	하이픈 구분 입력 필요
locationDescription	위치설명		string	방문수령의 상품일 경우 자세하게 기재 필요
isVisitAndTakeAddr	기본방문수령지여부	Y	boolean
isReturnAddr	기본반품배송지주소여부	Y	boolean

JSON
{
  "addrName": "string",
  "representativeName": "string",
  "zipCode": "string",
  "addr1": "string",
  "addr2": "string",
  "homeTel": "string",
  "cellPhone": "string",
  "locationDescription": "string",
  "isVisitAndTakeAddr": true,
  "isReturnAddr": true
}

조회
URL만 호출 / Request Body 없음
[GET] https://sa2.esmplus.com/item/v1/sellers/address/440753

전체조회
[GET] https://sa2.esmplus.com/item/v1/sellers/addresses

1000개 이상인 경우 페이지별 조회시
[GET] https://sa2.esmplus.com/item/v1/sellers/addresses?pageSize=100&pageIndex=1

Response Description

항목	항목명	필수여부	Type	Description
addrNo	판매자주소록번호		int	등록/수정 성공 시 내려가는 번호
addrName	주소명		string	조회 시 내려가는 정보
representativeName	판매자명		string	조회 시 내려가는 정보
zipCode	우편번호		string	조회 시 내려가는 정보
addr1	주소1		string	조회 시 내려가는 정보
addr2	주소2		string	조회 시 내려가는 정보
homeTel	일반전화번호		string	조회 시 내려가는 정보
cellPhone	휴대폰번호		string	조회 시 내려가는 정보
locationDescription	위치설명		string	조회 시 내려가는 정보
isVisitAndTakeAddr	기본방문수령지여부		boolean	조회 시 내려가는 정보
isReturnAddr	기본반품배송지주소여부		boolean	조회 시 내려가는 정보
totalCount	전체조회 개수		string	전체조회 시 내려가는 정보
pageSize	페이지Size		string	전체조회 시 내려가는 정보
pageIndex	페이지번호		string	전체조회 시 내려가는 정보
sellerAddressBookList[]				전체조회 시 내려가는 정보 위 판매자 주소록 정보가 해당 root로 배열로 내려감
resultCode	결과코드		int	실패 시 내려가는 정보 실패코드
message	메시지		string	실패 시 내려가는 정보 실패사유

JSON_Success

등록/수정
{
  "addrNo": 0
}

개별조회
{
  "addrNo": 0,
  "addrName": "string",
  "representativeName": "string",
  "zipCode": "string",
  "addr1": "string",
  "addr2": "string",
  "homeTel": "string",
  "cellPhone": "string",
  "locationDescription": "string",
  "isVisitAndTakeAddr": true,
  "isReturnAddr": true
}

전체조회
{
   "totalCount":0,
   "pageSize":0,
   "pageIndex":0,
   "sellerAddressBookList":
   [  
  "addrNo": 0,
  "addrName": "string",
  "representativeName": "string",
  "zipCode": "string",
  "addr1": "string",
  "addr2": "string",
  "homeTel": "string",
  "cellPhone": "string",
  "locationDescription": "string",
  "isVisitAndTakeAddr": true,
  "isReturnAddr": true
 ]
}

JSON_Fail

{
   "resultCode": int,
   "message": "string"
}

Sample Code_Success

등록/수정
{
  "addrNo":440753
}

개별조회
{
   "addrNo":440753,
   "addrName":"테스트",
   "representativeName":"(주)테스트",
   "zipCode":"04728",
   "addr1":"서울시 강남구 테헤란로 152",
   "addr2":"GFC 지마켓",
   "homeTel":"010-1234-1111",
   "cellPhone":"010-152-1111",
   "locationDescription":"역삼역 2번출구와 연결되어 있습니다",
   "isVisitAndTakeAddr":true,
   "isReturnAddr":true
}

전체조회
{
   "totalCount":2,
   "pageSize":1000,
   "pageIndex":1,
   "sellerAddressBookList":
   [
    {
       "addrNo":34565,
       "addrName":"테스트",
       "representativeName":"테스트",
       "zipCode":"136132",
       "addr1":"서울 성북구 하월곡동2",
       "addr2":"강남파이낸스센터2",
       "homeTel":"02-123-4562",
       "cellPhone":"010-1234-5672",
       "locationDescription":null,
       "isVisitAndTakeAddr":false,
       "isReturnAddr":false
     },
     {
       "addrNo":34566,
       "addrName":"test1",
       "representativeName":"test1",
       "zipCode":"136130",
       "addr1":"서울 성북구 하월곡동",
       "addr2":"강남파이낸스센터",
       "homeTel":"02-123-4567",
       "cellPhone":"010-1234-5678",
       "locationDescription":null,
       "isVisitAndTakeAddr":false,
       "isReturnAddr":false
      }
  ]
}

Sample Code_Fail

{
  "resultCode":1000,
  "message":"{입력코드} 정보가 조회되지 않습니다"
}

Error Code

결과코드	메시지	원인
1000	{입력코드} 정보가 조회되지 않습니다	존재하지 않는 판매자주소번호 호출했을 경우
1000	잘못된 카테고리 코드입니다.	카테고리 코드를 잘 못 입력한 경우
1000	정보가 조회되지 않습니다.	등록되지 않은 addrNo를 넣었을 때