묶음배송비관리 API

Description

등록 : [POST] https://sa2.esmplus.com/item/v1/shipping/policies 수정 : [PUT] https://sa2.esmplus.com/item/v1/shipping/policies/{policyNo} 조회 : [GET] https://sa2.esmplus.com/item/v1/shipping/places/{placeNo}/policies

출하지별 묶음배송비 관리 API 입니다. 동일출하지 상품 주문시 묶음배송비 설정되며 계산 방식에 따라 배송비 최소/최대 부과 처리 됩니다. 등록시 마스터 ID 하위 모든 사이트 판매자 ID 에서 사용할 수 있습니다.

Request Description

항목	항목명	필수여부	Type	Description
policyNo	묶음배송비 정책 번호	Y	Path	수정, 조회시 필수
feeType	정책구분	Y	int	묶음배송비 정책 구분 1 : 무료 2 : 유료 3 : 조건부
fee	배송비금액	Y	number	금액 입력
isPrepayment	배송비 선결제여부	Y	boolean	true : 선결제 false : 선결제아님
isCashOnDelivery	착불여부	Y	boolean	true : 착불 false : 착불아님
placeNo	출하지번호	Y	int	출하지 같은 상품 주문시 묶음배송비 설정
isDefault	기본배송비여부	Y	boolean	true : 기본배송비 정책 false: 기본배송비 정책 아님
shippingFee > condition	조건부 기준금액		number	- feeType > 3 경우 필수 - 1000 ~ 10,000,000원 미만 설정 가능

JSON
등록/수정
{
  "feeType": 1,
  "fee": 0,
  "isPrepayment": true,
  "isCashOnDelivery": true,
  "placeNo": 0,
  "isDefault": true,
  "shippingFee": [
    {
      "condition": 0
    }
  ]
}

조회 - URL만 호출 / Request Body 없음
[GET] https://sa2.esmplus.com/item/v1/shipping/places/176129

Sample - 무료
{
"feeType": 1,
  "fee": 0,
  "isPrepayment": true,
  "isCashOnDelivery": false,
  "placeNo": 176042,
  "isDefault": false,
  "shippingFee": [
    {
      "condition": 0
    }
  ]
}

Sample - 유료
{
"feeType": 2,
  "fee": 2500,
  "isPrepayment": true,
  "isCashOnDelivery": false,
  "placeNo": 176042,
  "isDefault": false,
  "shippingFee": [
    {
      "condition": 0
    }
  ]
}

Sample - 조건부무료
{
"feeType": 3,
  "fee": 2500,
  "isPrepayment": true,
  "isCashOnDelivery": false,
  "placeNo": 176042,
  "isDefault": false,
  "shippingFee": [
    {
      "condition": 20000
    }
  ]
}

Response Description

항목	항목명	Type	Description
resultCode	결과코드	int	실패 시 내려가는 정보
message	메시지	string	실패 시 내려가는 정보
data	데이터	object	실패 시 내려가는 정보
policies > policyNo	묶음배송비 정책 번호	bigint	조회 시 내려가는 정보
policies > placeNo	출하지번호	int	조회 시 내려가는 정보
policies > feeType	정책구분	int	조회 시 내려가는 정보
policies > fee	배송비금액	number	조회 시 내려가는 정보
policies > isPrepayment	배송비 선결제여부	boolean	조회 시 내려가는 정보
policies > isCashOnDelivery	착불여부	boolean	조회 시 내려가는 정보
policies > shippingFee > condition	조건부 기준금액	number	조회 시 내려가는 정보

 JSON_Success

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

조회
{
  "placeNo": 0,
  "policies": [
    {
      "policyNo": 0,
      "feeType": 1,
      "fee": 0,
      "isPrepayment": true,
      "isCashOnDelivery": true,
      "shippingFee": [
        {
          "condition": 0
        }
      ]
    }
  ]
}

JSON_Fail

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

Sample Code_Success

등록/수정
{
   "placeNo":176042,
   "policyNo":663289
}

조회
{
   "placeNo":175962,
   "policies":
   [
    {
      "policyNo":662971,
      "feeType":3,
      "fee":3000,
      "isPrepayment":false,
      "isCashOnDelivery":true,
      "shippingFee":
   [
    {
      "condition":10000
    }
   ]
  },
    {
      "policyNo":662995,
      "feeType":3,
      "fee":2500,
      "isPrepayment":true,
      "isCashOnDelivery":false,
      "shippingFee":
   [
    {
      "condition":20000
    }
   ]
  },
 ]
}

Sample Code_Fail

{
  "resultCode":1000,
  "message":"유료 배송비 선결제 여부(IsPrepay)와 착불 여부(IsCod)가 모두 false일 수 없습니다."
}

Error Code

결과코드	메시지	원인
1000	출하지 번호는 변경할 수 없습니다	출하지 번호 수정 시도할 경우
1000	배송비정책번호를 확인해 주세요	묶음배송비 정책번호가 잘 못 되었거나 없을 경우
1000	유료 배송비 선결제 여부(IsPrepay)와 착불 여부(IsCod)가 모두 false일 수 없습니다	선결제/착불모두 불가(false)로 설정했을 경우
3000	Null 허용 개체에는 값이 있어야 합니다.	엔티티에 값을 넣지 않았을 때 발생