1.1 지점관리 API – ESM Trading API

1.1 지점관리 API

지점 등록 : [POST] https://sa.esmplus.com/item/v1/exshop/branches

지점 수정 : [PUT] https://sa.esmplus.com/item/v1/exshop/branches/{branchId}

지점 조회 : [GET] https://sa.esmplus.com/item/v1/exshop/branches

Description
당일배송 지원할 지점 정보를 관리합니다
Request Description
G마켓 ID / 옥션 ID 토큰 모두 사용가능합니다
마스터ID 단위로 통합 등록됩니다
항목항목명필수여부TypeDescription
name지점명Ystring지점명
contact지점연락처Ystring지점 연락처
service > types[ ]서비스형태stringreserve : 당일배송(예약), dawn : 새벽배송
location > longitude지점위치 경도floatlocation 입력 시 필수 연동
location > latitude지점위치 위도floatlocation 입력 시 필수 연동
location > distance배송가능거리intlocation 입력 시 필수 연동
JSON_등록/수정JSON_조회Sample Code_등록/수정
{
  "name": "string",
  "contact": "string",
  "service": {
    "types": [
      "string"
    ]
  },
  "location": {
    "longitude": 0,
    "latitude": 0,
    "distance": 0
  }
}

URL만 호출 / Request Body 없음
GET https://sa.esmplus.com/item/v1/exshop/branches

{
  "name": "eBayTEST",
  "contact": "010-1234-4567",
  "service": {
    "types": [
      "reserve"
    ]
  },
  "location": {
    "longitude": -160,
    "latitude": 50,
    "distance": 30
  }
}

Response Description
항목항목명TypeDescription
branchId지점코드int
name지점명string
contact지점연락처string
service > types[ ]서비스형태string
location > longitude지점위치 경도float
location > latitude지점위치 위도float
location > distance배송가능 거리int
resultCode결과코드int실패 시 내려가는 정보
message 메시지string실패 시 내려가는 정보
data 데이터object실패 시 내려가는 정보
JSON_Success_등록/수정JSON_Success_조회JSON_FailSample Code_Success_등록/수정Sample Code_Success_조회Sample Code_Fail
{
  "branchId": 0
}
[
  {
    "branchId": 0,
    "name": "string",
    "contact": "string",
    "service": {
      "types": [
        "string"
      ]
    },
    "location": {
      "longitude": 0,
      "latitude": 0,
      "distance": 0
    }
  }
]
{
   "ResultCode": 0,
   "Message": "string",
   "Data": {}
}
{
    "branchId": 16208
}
[
  {
      "branchId": 16208,
      "name": "location_1",
      "contact": "010-1234-4567",
      "service": {
         "types": [
            "reserve"
         ]
      },
      "location": {
         "longitude": 180.0,
         "latitude": -90.0,
         "distance": 1
      }
  }
]
{
  "ResultCode":1000,
  "Message":"에러메시지",
  "Data":null
}
Error Code
결과코드메시지원인
1000지점명(name)을 입력하세요.등록/수정 시 지점명이 유효하지 않은 값이거나, 빈 값, null 입력하는 경우 발생
1000지점연락처(contact)를 입력하세요등록/수정 시 지점연락처가 유효하지 않은 값이거나, 빈 값, null 입력하는 경우 발생
1000service > types 입력 정보를 확인하세요지점 서비스형태가 유효하지 않은 값이거나, 빈값, null 입력하는 경우 발생
1000지점위치(location) 입력 시 longtitude, latitude, distance는 필수입니다.등록/수정 시 지점위치 항목 입력하였으나, location 하위값 중 호출하지 않은 값 있을 경우 발생
(location 입력 시 {longtitude, latitude, distance 필수 연동)
1000경도(longtitude) 정보가 유효하지 않습니다. 지점위치 정보를 확인해 주세요등록/수정 시 longtitude, latitude, distance 유효하지 않은 값이거나, 빈값, null 입력하는 경우 발생
(longtitude 유효값 범위 : -180~180)
1000위도(latitude) 정보가 유효하지 않습니다. 지점위치 정보를 확인해 주세요.등록/수정 시 longtitude, latitude, distance 유효하지 않은 값이거나, 빈값, null 입력하는 경우 발생
(latitude 유효값 범위 : -90~90)
1000거리(distance) 정보는 양수(+) 값만 입력 가능합니다. 거리 정보를 확인해 주세요0, (-) 값 입력 시 발생
1000지점에 기등록된 서비스형태의 권역이 존재하여 지점 정보 수정이 불가합니다. 권역 서비스 정보를 확인해주세요지점의 서비스 형태 수정 시 수정하려는 서비스형태에 기등록된 권역의 서비스형태가 존재하지 않는 경우