스타배송 출하지 관리 (4월 중순 이후 사용 가능)

Description

등록 [POST] https://sa2.esmplus.com/item/v1/starship/places 수정 [PUT] https://sa2.esmplus.com/item/v1/starship/places/{placeNo} 삭제 [DELETE] https://sa2.esmplus.com/item/v1/starship/places/{placeNo} 개별조회 [GET] https://sa2.esmplus.com/item/v1/starship/places/{placeNo} 목록 조회 [GET] https://sa-sandbox.esmplus.com/item/v1/starship/places?pageSize={pageSize}&pageIndex={pageIndex}

판매자 스타배송 출하지 관리하는 API 입니다. 등록된 출하지는 판매자 스타배송 상품 등록/수정시 사용 가능하며 일반 상품에는 사용 불가 합니다. 출하지 등록시 기본 등록 정보 외 주문 마감 시간 등록이 필요합니다. 출하지는 최대 50개 까지 등록 가능 합니다.

Request Description

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

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

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

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

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

 

Response Description

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

 JSON_Success

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

조회
{
      "shipmentPlaceNo": 0,
      "placeName": "string",
      "addrNo": 0,
      "orderClosingTime": "string",
      "hasGoods": true,
      "isSetAdditionalShippingFee": true,
      "backwoodsAdditionalShippingFee": 0,
      "jejuAdditionalShippingFee": 0,
      "isDefaultShippingPlace": true,
      "imposeType": 1
}

JSON_Fail

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

Sample Code_Success

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

조회
{
    "shippingPlaces": [
        {
            "shipmentPlaceNo": 193967,
            "orderClosingTime": "23:30:00",
            "hasGoods": true,
            "placeName": "스타배송출하지01",
            "addrNo": 461330,
            "isSetAdditionalShippingFee": true,
            "backwoodsAdditionalShippingFee": 0.0000,
            "jejuAdditionalShippingFee": 20000.0000,
            "isDefaultShippingPlace": false,
            "imposeType": 1
        },
        {
            "shipmentPlaceNo": 193966,
            "orderClosingTime": "10:30:00",
            "hasGoods": false,
            "placeName": "스타배송출하지02",
            "addrNo": 461329,
            "isSetAdditionalShippingFee": true,
            "backwoodsAdditionalShippingFee": 1000.0000,
            "jejuAdditionalShippingFee": 3000.0000,
            "isDefaultShippingPlace": false,
            "imposeType": 1
        }
    ]
}

Sample Code_Fail

{
    "resultCode": 1000,
    "message": "동일한 명칭으로 등록된 스타배송 출고지가 존재합니다.",
    "data": null
}

Error Code

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