2.1 판매자주소록 관리 API – ESM Trading API

2.1 판매자주소록 관리 API

판매자주소록 등록 : [POST] https://sa.esmplus.com/item/v1/sellers/address

판매자주소록 수정 : [PUT] https://sa.esmplus.com/item/v1/sellers/address/{addrNo}

판매자주소록 조회 : [GET] https://sa.esmplus.com/item/v1/sellers/address/{addrNo}

판매자주소록 전체조회 : [GET] https://sa.esmplus.com/item/v1/sellers/addresses

Description
배송템플릿 설정을 위한 판매자 정보- 판매자주소록/출하지/묶음배송비정책/발송타입정책 을 차례로 등록합니다
등록한 판매자주소록번호 / 출하지번호 / 묶음배송비정책번호 / 발송타입정책 번호를 상품등록/수정 시 필수값으로 등록되어야 합니다
판매자주소록번호 기준으로 출하지를 설정할 수 있습니다
마스터ID 단위로 1회만 등록하면 마스터ID에 묶인 모든 Seller ID에 사용할 수 있습니다
판매자 주소록 매칭 관계


판매자 배송부과 방식

Request Description
G마켓 ID or 옥션 ID 토큰 모두 사용 가능합니다
항목항목명필수여부TypeDescription
addrNo 판매자주소록번호 YPath수정[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_등록/수정JSON_조회Sample Code_등록/수정
{
  "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://sa.esmplus.com/item/v1/sellers/address/440753

전체조회
[GET] https://sa.esmplus.com/item/v1/sellers/addresses
[GET] https://sa.esmplus.com/item/v1/sellers/addresses?pageSize=1&pageIndex=1000 (1000개 이상인 경우 페이지별 조회시)
{
"addrName": "테스트",
  "representativeName": "(주)테스트",
  "zipCode": "04728",
  "addr1": "서울시 강남구 테헤란로 152",
  "addr2": "GFC 이베이코리아",
  "homeTel": "010-1234-1234",
  "cellPhone": "010-152-1234",
  "locationDescription": "역삼역 2번출구와 연결되어 있습니다",
  "isVisitAndTakeAddr": true,
  "isReturnAddr": true
}

Response Description
항목항목명필수여부TypeDescription
addrNo 판매자주소록번호 Yint 등록/수정 성공 시 내려가는 번호
자동채번된 번호 내려감
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실패 시 내려가는 정보
실패사유
data데이터object실패 시 내려가는 정보
상세사유
JSON_Success_등록/수정JSON_Success_개별조회JSON_Success_전체조회JSON_FailSample Code_Success_등록/수정Sample Code_Success_개별조회Sample Code_Success_전체조회Sample Code_Fail
{
  "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
 ]
}
{
   "ResultCode": 0,
   "Message": "string",
   "Data": {}
}
{
  "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
      }
  ]
}
{
  "ResultCode":1000,
  "Message":"{입력코드} 정보가 조회되지 않습니다",
  "Data":null
}
Error Code
결과코드메시지원인
1000 {입력코드} 정보가 조회되지 않습니다 존재하지 않는 판매자주소번호 호출했을 경우
1000잘못된 카테고리 코드입니다.카테고리 코드를 잘 못 입력한 경우
1000정보가 조회되지 않습니다.등록되지 않은 addrNo를 넣었을 때