지점관리 API

Description

등록 : [POST] https://sa2.esmplus.com/item/v1/exshop/branches 수정 : [PUT] https://sa2.esmplus.com/item/v1/exshop/branches/{branchId} 조회 : [GET] https://sa2.esmplus.com/item/v1/exshop/branches

당일배송 배송 지점 관리 API 입니다. 지점별 서비스 가능한 형태 등록 하여 관리 가능 합니다.

 

Request Description

항목	항목명	필수여부	Type	Description
name	지점명	Y	string	지점명
contact	지점연락처	Y	string	지점 연락처
service > types	[ ]서비스형태		string	reserve : 당일배송, dawn : 새벽배송
location > longitude	지점위치 경도		float	location 입력 시 필수 연동
location > latitude	지점위치 위도		float	location 입력 시 필수 연동
location > distance	배송가능거리		int	location 입력 시 필수 연동

JSON
{
  "name": "string",
  "contact": "string",
  "service": {
    "types": [
      "string"
    ]
  },
  "location": {
    "longitude": 0,
    "latitude": 0,
    "distance": 0
  }
}

 

Response Description

항목	항목명	Type	Description
branchId	지점코드	int
name	지점명	string
contact	지점연락처	string
service > types	[ ]서비스형태	string
location > longitude	지점위치 경도	float
location > latitude	지점위치 위도	float
location > distance	배송가능 거리	int
resultCode	결과코드	int	실패 시 내려가는 정보
message	메시지	string	실패 시 내려가는 정보

 JSON_Success

{
  "branchId": 0
}

JSON_Fail

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

Sample Code_Success

등록/수정
{
    "branchId": 16208
}

조회
[
  {
      "branchId": 16208,
      "name": "location_1",
      "contact": "010-1234-4567",
      "service": {
         "types": [
            "reserve"
         ]
      },
      "location": {
         "longitude": 180.0,
         "latitude": -90.0,
         "distance": 1
      }
  }
]

Sample Code_Fail

{
    "resultCode": 1000,
    "message": "유효하지 않은 지점 입니다.(해당 지점은 존재하지 않습니다)"
}

Error Code

결과코드	메시지	원인
1000	지점명(name)을 입력하세요.	등록/수정 시 지점명이 유효하지 않은 값이거나, 빈 값, null 입력하는 경우 발생
1000	지점연락처(contact)를 입력하세요	등록/수정 시 지점연락처가 유효하지 않은 값이거나, 빈 값, null 입력하는 경우 발생
3000	service > types 입력 정보를 확인하세요	지점 서비스형태가 유효하지 않은 값이거나, 빈값, null 입력하는 경우 발생
3000	지점위치(location) 입력 시 longtitude, latitude, distance는 필수입니다.	등록/수정 시 지점위치 항목 입력하였으나, location 하위값 중 호출하지 않은 값 있을 경우 발생 (location 입력 시 {longtitude, latitude, distance 필수 연동)
3000	경도(longtitude) 정보가 유효하지 않습니다. 지점위치 정보를 확인해 주세요	등록/수정 시 longtitude, latitude, distance 유효하지 않은 값이거나, 빈값, null 입력하는 경우 발생 (longtitude 유효값 범위 : -180~180)
3000	위도(latitude) 정보가 유효하지 않습니다. 지점위치 정보를 확인해 주세요.	등록/수정 시 longtitude, latitude, distance 유효하지 않은 값이거나, 빈값, null 입력하는 경우 발생 (latitude 유효값 범위 : -90~90)
3000	거리(distance) 정보는 양수(+) 값만 입력 가능합니다. 거리 정보를 확인해 주세요	0, (-) 값 입력 시 발생
3000	지점에 기등록된 서비스형태의 권역이 존재하여 지점 정보 수정이 불가합니다. 권역 서비스 정보를 확인해주세요	지점의 서비스 형태 수정 시 수정하려는 서비스형태에 기등록된 권역의 서비스형태가 존재하지 않는 경우