지점 서비스별 권역 관리 API

Description

권역 등록 : [POST] https://sa2.esmplus.com/item/v1/exshop/branches/{branchId}/zones/{code} 권역 수정 : [PUT] https://sa2.esmplus.com/item/v1/exshop/branches/{branchId}/zones/{code} 권역 조회 : [GET] https://sa2.esmplus.com/item/v1/exshop/branches/{branchId}/zones/{code} 권역 삭제 : [DELETE] https://sa2.esmplus.com/item/v1/exshop/branches/{branchId}/zones/{code}

당일배송 지원할 지점 서비스별 권역 정보를 관리합니다

 

Request Description

항목	항목명	필수여부	Type	Description
branchId	지점코드	Y	path
code	권역코드	Y	path	권역 코드는 지점별로 유니크하게 관리되어야 함 (권역코드는 1 이상 32767 까지 정수만 등록 가능)
ServiceType > type	서비스형태	Y	string	reserve : 당일배송(예약), dawn : 새벽배송
zipcodes	[ ]우편번호	Y	string	- 우편번호는 지점별 우편번호 관리로 등록된 리스트 내에서만 지점별 설정 가능 - 한 지점의 서비스타입 : 권역 : 우편번호는 1 : 1 : N 관계 - 지점에 우편번호가 원거리와 같은 기존 정보가 설정 된 경우에도, 서비스 및 권역이 설정 된 경우 해당 정보가 우선 함 - 우편번호는 List로 등록

JSON
{
  "serviceType": {
    "type": "string"
  },
  "zipcodes": [
    "string"
  ]
}

 

Response Description

항목	항목명	Type	Description
branchId	지점코드	int	조회 시 내려가는 정보
zone > codes	권역코드	int	조회 시 내려가는 정보
service > type	서비스형태	string	조회 시 내려가는 정보
zipcodes	[ ]우편번호	string	조회 시 내려가는 정보
resultCode	결과코드	int	실패 시 내려가는 정보
message	메시지	string	실패 시 내려가는 정보

 JSON_Success

등록/수정/삭제
{
  "branchId": 0,
  "code": 0
}

조회
{
  "code": 0,
  "branchId": 0,
  "service": {
    "type": "string"
  },
  "zipcodes": [
    "string"
  ]
}

JSON_Fail

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

Sample Code_Success

등록/수정/삭제
{
  "branchId": 16359,
  "code": 5678
}

조회
{
  "code": 5678,
  "branchId": 16359,
  "service": {
    "type": "reserve"
  },
  "zipcodes": [
    "17360"
  ]
}

Sample Code_Fail

{
    "resultCode": 1000,
    "message": "기등록된 서비스 타입이 있습니다 ( ServiceType : reserve )"
}

Error Code

결과코드	메시지	원인
1000	유효하지 않은 지점 입니다. 지점 정보를 확인해주세요	유효하지 않은 branchId로 모든 method 호출 시 발생
1000	유효하지 않은 우편번호 입니다.	우편번호가 지점에 등록되어있지 않은 경우 발생
1000	같은 서비스 타입은 중복되는 우편번호를 사용 할 수 없습니다.	우편번호가 동일 서비스 타입 권역에 이미 등록 되어 있는 경우 발생
1000	기등록된 서비스 타입이 있습니다 ( ServiceType : 등록된 서비스타입)	기 등록된 권역 코드 중복 입력 시
1000	지점에 등록되지 않은 서비스 형태입니다. 지점 서비스 타입을 확인해 주세요.	branchId에 등록되지 않은 서비스형태를 권역 등록/수정 시 사용하는 경우 발생
1000	서비스 형태는 필수로 입력되어야 합니다. 입력데이터를 확인해 주세요.	service > type 미호출, null, 빈 값 연동 시 발생
1000	zone은 32767 까지 가능합니다.	code 등록 시 입력 가능 자릿수를 초과 했을 경우