출하지관리 API

Description

등록 : [POST] https://sa2.esmplus.com/item/v1/shipping/places 수정 : [PUT] https://sa2.esmplus.com/item/v1/shipping/places/{placeNo} 개별 조회 : [GET] https://sa2.esmplus.com/item/v1/shipping/places/{placeNo} 전체 조회 : [GET] https://sa2.esmplus.com/item/v1/shipping/places?pageSize={pageSize}&pageIndex={pageIndex} 주소별 조회 : [GET] https://sa2.esmplus.com/item/v1/shipping/places?addrNo={addrNo}

등록한 주소록으로 출하지를 관리하는 API 입니다. 등록된 출하지는 마스터 ID 하위 모든 사이트 판매자 ID 에서 사용할 수 있으며 출하지별 묶음배송비정책을 설정할 수 있습니다. 배송템플릿 설정 위해서는 주소록, 출하지, 배송비 정책, 발송 정책을 차례로 등록합니다. 등록한 주소록, 출하지, 배송비 정책, 발송 정책는 상품등록/수정시 필수값으로 등록되어야 합니다.

Request Description

항목	항목명	필수여부	Type	Description
placeNo	출하지번호	Y	Path	- 수정[PUT] / 조회[GET]일 경우만 필수 - 등록시 response로 자동채번된 번호
pageSize	페이지 사이즈		Path	- 전체 조회시 사용 가능
pageIndex	페이지 인덱스		Path	- 전체 조회시 사용 가능 - 최대 500 까지 입력 가능
placeName	출하지명	Y	string
addrNo	판매자주소번호	Y	int
isSetAdditionalShippingFee	추가배송비 설정여부	Y	boolean	제주도, 도서 및 기타산간지방 추가배송비 설정 여부 true : 설정 false : 미설정
backwoodsAdditionalShippingFee	도서 및 기타 산간지방 추가배송비		number	- 금액 입력 - 판매자가 해당 지역 우편번호 설정은 불가
jejuAdditionalShippingFee	제주도 및 부속도서 추가배송비		number	- 금액 입력 - 판매자가 해당 지역 우편번호 설정은 불가
isDefaultShippingPlace	기본출하지 여부	Y	boolean	기본출하지 여부 설정 true : 설정 false : 미설정
imposeType	묶음계산방식		int	1 : 최소 부과 (기본) (배송비 중 가장 작은 값으로 부과, 등록/수정시 항목 미입력 경우 해당 값으로 입력됨) 2 : 최대 부과 (배송비 중 가장 큰 값으로 부과)

JSON
등록/수정
{
  "placeName": "string",
  "addrNo": 0,
  "isSetAdditionalShippingFee": true,
  "backwoodsAdditionalShippingFee": 0,
  "jejuAdditionalShippingFee": 0,
  "isDefaultShippingPlace": true,
  "imposeType": 1
}

조회
[GET] https://sa2.esmplus.com/item/v1/shipping/places/176129

전체조회
[GET] https://sa2.esmplus.com/item/v1/shipping/places (500건만 조회)
[GET] https://sa2.esmplus.com/item/v1/shipping/places?pageSize=500&pageIndex=1 (페이지별)

주소별 조회
[GET] https://sa2.esmplus.com/item/v1/shipping/places?addrNo={addrNo}

Response Description

항목	항목명	Type	Description
resultCode	결과코드	int	실패 시 내려가는 정보
message	메시지	string	실패 시 내려가는 정보
shippingPlaces > placeNo	출하지번호	int	성공/조회시 내려가는 정보
shippingPlaces > placeName	출하지명	string	조회시 내려가는 정보
shippingPlaces > addrNo	판매자주소번호	int	조회시 내려가는 정보
shippingPlaces > isSetAdditionalShippingFee	추가배송비 설정여부	boolean	조회시 내려가는 정보
shippingPlaces > backwoodsAdditionalShippingFee	제주도 및 부속도서 추가배송비	number	조회시 내려가는 정보
shippingPlaces > jejuAdditionalShippingFee	도서 및 기타 산간지방 추가배송비	number	조회시 내려가는 정보
shippingPlaces > isDefaultShippingPlace	기본출하지 여부	boolean	조회시 내려가는 정보
shippingPlaces > imposeType (별도 안내 예정)	묶음계산방식	int	조회시 내려가는 정보

 JSON_Success

등록/수정
{
  "placeNo": 0
}

조회
{
  "shippingPlaces": [
    {
      "placeNo": 0,
      "placeName": "string",
      "addrNo": 0,
      "isSetAdditionalShippingFee": true,
      "backwoodsAdditionalShippingFee": 0,
      "jejuAdditionalShippingFee": 0,
      "isDefaultShippingPlace": true,
      "imposeType": 1
    }
  ]
}

JSON_Fail

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

Sample Code_Success

등록/수정
{
   "placeNo":176129
}

조회
{
    "shippingPlaces": [
        {
            "placeNo": 177067,
            "placeName": "테스트001",
            "addrNo": 440831,
            "isSetAdditionalShippingFee": true,
            "backwoodsAdditionalShippingFee": 20000.0000,
            "jejuAdditionalShippingFee": 10000.0000,
            "isDefaultShippingPlace": false,
            "imposeType": 2
        },
        {
            "placeNo": 177063,
            "placeName": "테스트002",
            "addrNo": 440598,
            "isSetAdditionalShippingFee": false,
            "backwoodsAdditionalShippingFee": 0.0000,
            "jejuAdditionalShippingFee": 0.0000,
            "isDefaultShippingPlace": false,
            "imposeType": 2
        }
    ]
}

Sample Code_Fail

{
  "resultCode":1000,
  "message":"동일한 출하지 명으로 등록된 출하지가 존재합니다."
}

Error Code

결과코드	메시지	원인
3000	Invalid AddressNo	판매자주소록번호 잘 못 되었거나 없는 번호일 경우
1000	동일한 출하지 명으로 등록된 출하지가 존재합니다.	동일한 출하지명으로 등록 시도시
3000	IAC 출하지 추가 실패 제주 도서/산간 지역 추가배송비는 0원보다 크고 최대 20만원가지 설정하실 수 있습니다.	AdditionalShippingFee값을 음수나 20만을 넣을 때 혹은 숫자가 아닌 다른 값을 넣을 경우