스타배송 묶음배송비관리 API (4월 중순 이후 사용 가능)

Description

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

스타배송 출하지별 묶음배송비 관리 API 입니다. 동일출하지 상품 주문시 묶음배송비 설정되며 계산 방식에 따라 배송비 최소/최대 부과 처리 됩니다. 등록된 배송비는 판매자 스타배송 상품 등록/수정시 사용 가능하며 일반 상품에는 사용 불가 합니다.

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/starship/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 >  goodsCount	상품수	int	조회 시 내려가는 정보
policies > isPrepayment	배송비 선결제여부	boolean	조회 시 내려가는 정보
policies > isCashOnDelivery	착불여부	boolean	조회 시 내려가는 정보
policies > shippingFee > condition	조건부 기준금액	number	조회 시 내려가는 정보

 JSON_Success

등록/수정
{
    "ResultCode": 0,
    "Message": "string",
    "Data": {
        "placeNo": int,
        "policyNo": int
    }
}

조회시
{
    "ResultCode": 0,
    "Message": "string",
    "Data": {
        "placeNo": int,
        "policies": [
            {
                "fee": int,
                "isCashOnDelivery": false,
                "isDefault": false,
                "isPrepayment": true,
                "policyNo": int,
                "feeType": int,
                "goodsCount": int,
                "shippingFee": []
            },
            {
                "fee": 0,
                "isCashOnDelivery": false,
                "isDefault": true,
                "isPrepayment": false,
                "policyNo": int,
                "feeType": int,
                "goodsCount": int,
                "shippingFee": []
            }
        ],
        "totalCount": int,
        "pageSize": int,
        "pageIndex": int
    }
}

JSON_Fail

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

Sample Code_Success

등록/수정
{
    "ResultCode": 0,
    "Message": "성공",
    "Data": {
        "placeNo": 192968,
        "policyNo": 689858
    }
}

조회
{
    "ResultCode": 0,
    "Message": "성공",
    "Data": {
        "placeNo": 192968,
        "policies": [
            {
                "fee": 2000,
                "isCashOnDelivery": false,
                "isDefault": false,
                "isPrepayment": true,
                "policyNo": 688816,
                "feeType": 2,
                "goodsCount": 0,
                "shippingFee": []
            },
            {
                "fee": 0,
                "isCashOnDelivery": false,
                "isDefault": true,
                "isPrepayment": false,
                "policyNo": 688817,
                "feeType": 1,
                "goodsCount": 0,
                "shippingFee": []
            }
        ],
        "totalCount": 2,
        "pageSize": 500,
        "pageIndex": 1
    }
}

Sample Code_Fail

{
    "resultCode": 1000,
    "message": "배송비 결제여부는 필수로 입력해주세요.",
    "data": null
}