지점별 우편번호관리 API

Description

등록 : [POST] https://sa2.esmplus.com/item/v1/exshop/branches/{branchId}/zipcodes 수정 : [PUT] https://sa2.esmplus.com/item/v1/exshop/branches/{branchId}/zipcodes/{zipcode} 삭제 : [DELETE] https://sa2.esmplus.com/item/v1/exshop/branches/{branchId}/zipcodes/{zipcode} 조회 : [GET] https://sa2.esmplus.com/item/v1/exshop/branches/{branchId}/zipcodes 우편번호 기준 지점 조회 : [GET] https://sa2.esmplus.com/item/v1/exshop/zipcode/{zipcode}/branches

지점별 배송가능한 지역별 5자리 우편번호를 모두 등록합니다. 원거리배송을 지원하는 우편번호를 확인하여 연동합니다.

Request Description

항목	항목명	필수여부	Type	Description
branchId	지점코드	Y	path
zipcode	우편번호	Y	string	- 5자리 우편번호 등록 - 우편번호 유효성 체크하며 존재하는 우편번호만 등록 가능
longDistance	원거리여부	Y	boolean	- 우편번호 원거리 배송 관리 여부 설정 - true : 원거리 지역 - false : 일반

{
  "zipcode": "string",
  "longDistance": true
}

 

Response Description

항목	항목명	Type	Description
zipcode	우편번호	string	조회 시 내려가는 정보
longDistance	원거리여부	boolean	조회 시 내려가는 정보
resultCode	결과코드	int	실패 시 내려가는 정보
message	메시지	string	실패 시 내려가는 정보

 JSON_Success

{
  "zipcode": "string"
}

JSON_Fail

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

Sample Code_Success

등록/수정/삭제
{
  "zipcode": "17360"
}

조회
[
  {
    "zipcode": "17360",
    "longDistance": true
  }
]

Sample Code_Fail

{
    "resultCode": 1000,
    "message": "우편번호 등록에 실패하였습니다. 기존에 등록된 우편번호 입니다."
}

 

Error Code

결과코드	메시지	원인
1000	zipcode 정보 수정에 실패하였습니다. 해당 우편 번호가 존재하지 않거나, 시스템 오류입니다.	지점에 존재하지 않는 우편번호 수정/삭제 시 발생
1000	유효하지 않은 지점 입니다.(해당 지점은 존재하지 않습니다)	유효하지 않은 branchId 사용한 모든 method 호출 시 발생
3000	권역설정이 되어있는 우편번호입니다.	삭제하고자 하는 우편번호가 권역에 설정되어 있는경우 (권역 수정 후 삭제 가능)
1000	우편번호 등록에 실패하였습니다. 기존에 등록된 우편번호 입니다.	등록하고자 하는 우편번호가 지점에 기등록 되어 있는 경우 발생
3000	zipcode 정보 수정에 실패하였습니다. 해당 우편 번호가 존재하지 않거나, 시스템 오류입니다.	지점에 존재하지 않는 우편번호 삭제 시 발생