본문 바로가기
서비스 API/당일배송

지점별 배송Slot 관리 API

Description
등록 : [POST] https://sa2.esmplus.com/item/v1/exshop/branches/{branchId}/delivery-slots
수정 : [PUT] https://sa2.esmplus.com/item/v1/exshop/branches/{branchId}/delivery-slots/{deliverySlotId}
삭제 : [DELETE] https://sa2.esmplus.com/item/v1/exshop/branches/{branchId}/delivery-slots/{deliverySlotId}

조회 : [GET] https://sa2.esmplus.com/item/v1/exshop/branches/{branchId}/delivery-slots
지점별 배송Slot 시간을 등록합니다.
시간별로 배송 가능 or 배송 불가능 설정 가능하며 주문 마감시간도 설정 가능 합니다.
배송 슬롯 정보 수정 후 바로 조회하는 경우 수정하신 정보 확인이 안될 수 있으며 10분 정도 뒤에 확인 가능합니다.

Request Description

항목 항목명 필수여부 Type Description
branchId 지점코드 Y path  
deliverable 배송가능여부 Y boolean true: 배송가능
false :
배송마감/불가
deliveryStartDate 배송시작시간 Y string YYYY-MM-DD hh:mm
deliveryEndDate 배송종료시간 Y string YYYY-MM-DD hh:mm
requestDueDate 배송신청마감시간 Y string YYYY-MM-DD hh:mm
remainderCount 배송가능건수 Y int 숫자만입력
longDistanceEnable 원거리제한여부 Y boolean 원거리 우편번호를 배송주소로 설정된 고객에 대해 배송불가(마감 등으로 표기)
false :
원거리제한
true :
원거리제공
zone > code 권역코드   int 지점에 서비스타입이 null 아닌 경우 필수 입력
원거리 제한여부 설정하지 않은 경우 필수 입력
zone > code 1
개만 입력 가능
JSON
{
  "remainderCount": 0,
  "deliverable": true,
  "deliveryStartDate": "string",
  "deliveryEndDate": "string",
  "requestDueDate": "string",
  "longDistanceEnable": true,
  "zone": {
    "code": 0
  }
}

 

Response Description

항목 항목명 Type Description
deliverySlotId 배송Slot코드 int 조회 시 내려가는 정보
deliverable 배송가능여부 boolean 조회 시 내려가는 정보
deliveryStartDate 배송시작시간 string 조회 시 내려가는 정보
deliveryEndDate 배송종료시간 string 조회 시 내려가는 정보
requestDueDate 배송신청마감시간 string 조회 시 내려가는 정보
longDistance 원거리여부 boolean 조회 시 내려가는 정보
zone > code 권역코드 int 조회 시 내려가는 정보
resultCode 결과코드 int 실패 시 내려가는 정보
message 메시지 string 실패 시 내려가는 정보

 JSON_Success

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

조회
[
  {
    "deliverySlotId": 0,
    "remainderCount": 0,
    "deliverable": true,
    "deliveryStartDate": "string",
    "deliveryEndDate": "string",
    "requestDueDate": "string",
    "longDistanceEnable": true,
    "zone": {
      "code": 0
    }
  }
]

JSON_Fail

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

Sample Code_Success

등록/수정
{
  "DeliverySlotId": 304669
}

조회
[
    {
        "deliverySlotId": 568289,
        "remainderCount": 26,
        "deliverable": false,
        "deliveryStartDate": "2019-05-03 10:00",
        "deliveryEndDate": "2019-05-03 13:00",
        "requestDueDate": "2019-05-03 08:40",
        "longDistanceEnable": false
        "zone": {
            "code": 1234
        }   
    },
    {
        "deliverySlotId": 568302,
        "remainderCount": 42,
        "deliverable": true,
        "deliveryStartDate": "2019-05-03 19:00",
        "deliveryEndDate": "2019-05-03 21:00",
        "requestDueDate": "2019-05-03 17:40",
        "longDistanceEnable": true,
        "zone": {
            "code": 5678
        }        
    }
]

Sample Code_Fail

{
    "resultCode": 1000,
    "message": "요청한 번호로 설정된 권역정보가 없습니다."
}

Error Code

결과코드 메시지 원인
1000 유효하지 않은 지점 입니다. (해당 셀러의 지점이 아닙니다.) 없는 지점번호로 조회 시 발생
1000 서비스 타입을 확인해 주세요. 등록된 지점의 서비스 타입과 slot 서비스 타입이 다른 경우
1000 배송가능여부(deliverable)를 확인 해주세요. 해당 값 미입력 시 발생
1000 배송시작시간(deliveryStartDate) 을 확인 해주세요. 해당 값 미입력 시 발생
1000 배송시작시간(deliveryStartDate)이 배송종료시간(deliveryEndDate)보다 늦을 수 없습니다. 배송시작시간이 배송종료시간보다 늦을 경우
1000 배송종료시간(deliveryEndDate)을 확인 해주세요. 해당 값 미입력 시 발생
1000 배송신청마감시간(requestDueDate)이 배송시작시간(deliveryStartDate)보다 늦을 수 없습니다. 배송신청마감시간이 배송시작시간보다 늦을 경우
1000 배송신청마감시간(requestDueDate)을 확인 해주세요. 해당 값 미입력 시 발생
1000 배송가능건수(remainderCount)을 확인 해주세요. 해당 값 미입력 시 발생
1000 원거리제한여부(longDistanceEnable)를 설정 할 수 없습니다. 권역의 서비스 형태를 확인하세요 등록/수정 시 사용한 권역의 서비스형태 정보가 null이 아닌 경우
1000 권역이 등록된 지점입니다. 권역 코드를 확인하세요 branchId 서비스형태가 null이 아닌데 권역코드를 미호출하거나, 입력하지 않은 경우
1000 요청한 번호로 설정된 권역정보가 없습니다. 존재 하지 않는 zonecode 입력 시
1000 권역 등록이 불가능한 지점입니다. branchId 서비스형태가 null인데 권역코드항목을 입력 했을 경우

 

 

'서비스 API > 당일배송' 카테고리의 다른 글

지점 서비스별 권역 관리 API  (0) 2022.11.03
상품별 지점정보 관리 API  (0) 2022.11.03
상품별 프로모션 관리 API  (0) 2022.11.03
배송Slot 기준 원거리 관리 API  (0) 2022.11.03
실시간 Slot체크 API  (0) 2022.10.07