# 정기 주문 신청
온라인 커머스 서비스 중 정기배송이나 정구구독과 같이 일정한 기간 동안 일정한 주기로 상품을 구매할 수 있는 서비스를 자동으로 주문 처리하는 서비스입니다. 고객은 매번 주문을 하지 않고 기간, 신청일자에 따라 정기적으로 자동 주문이 가능한 기능을 제공합니다.
***
## 정기주문 신청하기
### 1. 정기주문신청서 조회
회원이 신청서 생성 및 조회 시, 해당 신청서의 상세 정보가 나타납니다.
\*회원만 정기주문 신청 가능
* **정기주문신청서 조회 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8/regularOrderSheet))\
신청서 생성 및 조회 시 필요한 다양한 구성 정보가 나타납니다.
```
POST /v1/regularOrderSheet/regularOrderSheet
```
### 2. 자동 결제 카드 등록/변경
이미 자동 결제 카드가 등록되어 있는 경우, 변경할 수 있습니다. \
자동 결제 카드가 등록되어 있지 않은 경우, 등록할 수 있습니다.
\*마이페이지에서도 변경, 삭제, 등록 가능
* **자동 결제 카드 등록/변경 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=order\&depth=%EC%9E%90%EB%8F%99%EA%B2%B0%EC%A0%9C%EC%B9%B4%EB%93%9C%EA%B4%80%EB%A6%AC/registerCard))\
회원의 자동 결제 카드를 등록하거나 변경할 수 있습니다.
```
POST /v1/autoPaymentCard/registerCard
```
### 3. 정기 주문 신청
회원이 입력한 내용을 바탕으로 정기 주문을 신청합니다.
* **정기 주문 신청 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8/applyForRegularOrder))\
정기 주문을 신청합니다.
```
POST /v1/regularOrder/applyForRegularOrder
```
### 4. 정기주문신청 완료 정보 조회
정기주문신청 성공 후 완료된 주문 정보가 나타납니다. 해당 API는 회원 로그인이 필수입니다.
신청 내역 보기 클릭 시 해당 정기주문의 신청 상세 화면으로 이동합니다.
* **정기주문 신청완료 정보 조회 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8/getRegularOrderCompleteInfo))\
정기주문신청 성공 후 정기주문신청 정보를 조회합니다.
```
POST /api/order/v1/regularOrder/getRegularOrderCompleteInfo
```
### 5. 고객알림리스트 조회
BO 시스템의 ‘공지사항 관리 > 고객 알림 관리’에 등록하여 나타나는 상단 “공지사항”을 조회합니다.
* **화면 고객알림 조회 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=common\&depth=%EA%B3%B5%ED%86%B5\&path=getContsList))\
고객알림리스트를 조회합니다.
```
GET /v1/common/getContsList
```
***
## 정기주문 신청 목록
### 1. 정기주문신청목록 조회
로그인 사용자(회원)에 한해, 정기주문 신청 목록을 조회합니다.
조회시작일시, 조회종료일시 사이에 포함된 정기 주문 신청 목록만 조회합니다.
비회원은 정기 주문 목록 조회 불가능합니다.
* **정기주문신청목록 조회 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8%EB%82%B4%EC%97%AD%EC%A1%B0%ED%9A%8C))\
정기주문 신청 목록을 조회합니다.
```
GET /v1/mypage/regularOrder/regularOrderInfoList
```
### 2. 정기주문신청 상세 이동
로그인 사용자(회원)에 한해, 정기주문 신청 상세를 조회합니다.
정기주문번호에 해당하는 정기주문신청 정보를 조회합니다.
* **정기주문신청 상세 조회 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8%EB%82%B4%EC%97%AD%EC%A1%B0%ED%9A%8C))\
정기주문 신청 상세를 조회합니다.
```
GET /v1/mypage/regularOrder/regularOrderDetail
```
### 3. 정기주문 건너뛰기
선택한 정기주문 상품의 건너뛰기 여부를 Y로 변경합니다.
Y로 변경된 거건너뛰기 여부부는 주문 생성 시점에서 N으로 초기화됩니다.
전체 건너뛰기를 Y로 설정할 경우 다음 주문 예정일이 업데이트 된 후 , 건너뛰기 여부가 N으로 변경됩니다.
* **정기 주문 건너뛰기**([🔗API 확인하기 >](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8))\
선택한 정기주문 상품의 주문을 건너뛰기 설정 합니다.
```
POST /v1/regularOrder/skipRegularOrder
```
***
## 정기주문 신청 상세보기
### 1. 정기주문신청 상세
로그인 사용자(회원)에 한해, 정기주문 신청 상세를 조회합니다.
정기주문번호에 해당하는 정기주문신청 정보를 조회합니다.
* **정기주문신청 상세 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8%EB%82%B4%EC%97%AD%EC%A1%B0%ED%9A%8C))\
정기주문 신청 상세를 조회합니다.
```
GET /v1/mypage/regularOrder/regularOrderDetail
```
### 2. 옵션변경
정기주문의 단품 및 수량을 변경합니다.
* **정기주문 옵션변경 (**[🔗API 확인하기 >](https://tech.x2bee.com/v1/regularOrder/regularOrderOptionChange))\
정기주문 상품의 단품 및 수량을 변경합니다.
```
get /v1/regularOrder/regularOrderOptionChange
```
### 3. 정기주문 건너뛰기
선택한 정기주문 상품의 건너뛰기 여부를 Y로 변경합니다.
Y로 변경된 거건너뛰기 여부부는 주문 생성 시점에서 N으로 초기화됩니다.
전체 건너뛰기를 Y로 설정할 경우 다음 주문 예정일이 업데이트 된 후 , 건너뛰기 여부가 N으로 변경됩니다.
* **정기 주문 신청 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8))\
선택한 정기주문 상품의 주문을 건너뛰기 설정 합니다.
```
POST /v1/regularOrder/skipRegularOrder
```
### 4. 신청주기 변경
정기주문의의 신청기간과 신청일자를 변경합니다.
변경 기간이 남은 기간보다 짧을 경우 변경이 불가능 합니다.
정기주문의 변경한 신청기간과 신청일자에 해당하는 다음 주문 예정일을 업데이트 합니다.
* **정기 주문 신청주기 변경 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8))\
정기주문의 주기를 변경합니다.
```
PUT /v1/regularOrder/changeDeliTermRegularOrderFO
```
### 5. 정기주문 주문변경 전 유효성 검증
정기주문 주기 변경 전 유효성 검증을 합니다.
변경 기간이 남은 기간보다 짧을 경우 예외를 발생시킵니다.
* **정기주문 주문변경 전 유효성 검증 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8))\
정기주문 주기 변경 전 유효성 검증을 합니다.
```
POST /v1/regularOrder/validateChangeRegularOrder
```
### 6. 주기변경 후의 정기주문예정일 조회
주기변경 후의 정기주문예정일을 조회합니다. 변경일로부터 해당 주문의 주기가 지난 이후부터 날짜를 계산합니다.
* **주기변경 후의 정기주문예정일 조회 (** [🔗API 확인하기 >](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8))\
주기변경 후의 정기주문예정일을 조회합니다.
```
POST /v1/regularOrder/getNextRegularOrderDate
```
### 7. 정기주문 해지하기
로그인 사용자(회원)에 한해, 정기주문의 상태(OM009)를 해지 상태로 변경합니다.
* **정기 주문 해지 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8))\
정기주문의 상태를 해지 상태로 변경합니다.
```
PUT /v1/regularOrder/terminateRegularOrderFO
```
***
## 정기주문 신청완료
### 1. 정기주문 신청완료 정보 조회
정기주문 신청완료 정보를 조회할 수 있습니다.
API 조회 도중 예외 발생 시 API 반환 메세지를 경고창으로 표시하고 확인 버튼을 클릭하면 메인화면으로 이동합니다.
선물하기와 비회원은 정기주문신청이 불가능하기 때문에 신청완료 페이지가 존재하지 않습니다.
* **정기주문 신청완료 정보 조회 (**[🔗API 확인하기 ](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8/getRegularOrderCompleteInfo)[>](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8/getRegularOrderCompleteInfo))\
정기주문신청 성공 후 정기주문신청 정보를 조회하는 API 입니다.
```
POST /api/order/v1/regularOrder/getRegularOrderCompleteInfo
```
### 2. 고객알림리스트 조회
BO 시스템의 ‘공지사항 관리 > 고객 알림 관리’에 등록하여 나타나는 상단 “공지사항”을 조회합니다.
* **화면 고객알림 조회 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=common\&depth=%EA%B3%B5%ED%86%B5\&path=getContsList))\
고객알림리스트를 조회합니다.
```
GET /v1/common/getContsList
```