> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api-guide/api-guides-en/store-front-api/order-and-payment/regular-order-application.md).

# Regular Order Application

A service among online commerce services — such as regular delivery or subscription — that automatically processes orders for products purchased at regular intervals over a set period. It provides a feature that lets customers place automatic orders on a regular basis according to a set period and application date, without having to place an order every time.

***

## Apply for a Regular Order <a href="#plus" id="plus"></a>

<div align="center"><img src="https://tech.x2bee.com/download/attachments/267813004/%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8%EC%8B%A0%EC%B2%AD%EC%84%9C.drawio.png" alt=""></div>

### 1. Look Up Regular Order Application Form <a href="#id-1" id="id-1"></a>

When a member creates or views an application form, that application form's detailed information is displayed.

\*Only members can apply for a regular order

* **Look up regular order application form (**[🔗View API >](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8/regularOrderSheet))\
  Displays the various configuration information needed when creating or viewing the application form.

```
POST /v1/regularOrderSheet/regularOrderSheet
```

### 2. Register/Change Auto-Payment Card <a href="#id-2" id="id-2"></a>

If an auto-payment card is already registered, it can be changed.\
If no auto-payment card is registered, one can be registered.

\*Can also be changed, deleted, or registered from My Page

* **Register/change auto-payment card (**[🔗View 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))\
  Registers or changes the member's auto-payment card.

```
POST /v1/autoPaymentCard/registerCard 
```

### 3. Apply for Regular Order <a href="#id-3" id="id-3"></a>

Applies for a regular order based on the content entered by the member.

* **Apply for regular order (**[🔗View API >](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8/applyForRegularOrder))\
  Applies for a regular order.

```
POST /v1/regularOrder/applyForRegularOrder 
```

### 4. Look Up Regular Order Application Completion Information <a href="#id-4" id="id-4"></a>

After the regular order application succeeds, the completed order information is displayed. This API requires member login.

Clicking View Application Details navigates to that regular order's application detail screen.

* **Look up regular order application completion information (**[🔗View API >](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8/getRegularOrderCompleteInfo))\
  Looks up the regular order application information after the application succeeds.

```
GET /v1/regularOrder/getRegularOrderCompleteInfo 
```

### 5. Look Up Customer Notification List <a href="#id-5" id="id-5"></a>

Looks up the top "notice" registered in the BO system's 'Notice Management > Customer Notification Management.'​

* **Look up screen customer notification (**[🔗View API >](https://api.x2bee.com/content?msa=common\&depth=%EA%B3%B5%ED%86%B5\&path=getContsList))\
  Looks up the customer notification list.

```
GET /v1/common/getContsList  
```

***

## Regular Order Application List <a href="#plus" id="plus"></a>

<div align="center"><img src="https://tech.x2bee.com/download/attachments/267813004/1711933117036-%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8%EC%8B%A0%EC%B2%AD%EC%84%9C.drawio.png" alt=""></div>

### 1. Look Up Regular Order Application List <a href="#id-1" id="id-1"></a>

For logged-in users (members) only, looks up the list of regular order applications.​

Only looks up regular order applications included between the search start date/time and search end date/time.​

Non-members cannot look up the regular order list.​<br>

* **Look up regular order application list (**[🔗View 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))\
  Looks up the regular order application list.

```
GET /v1/mypage/regularOrder/regularOrderInfoList
```

### 2. Navigate to Regular Order Application Detail <a href="#id-2" id="id-2"></a>

For logged-in users (members) only, looks up the regular order application detail.​

Looks up the regular order application information matching the regular order number.<br>

* **Look up regular order application detail (**[🔗View 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))\
  Looks up the regular order application detail.

```
GET /v1/mypage/regularOrder/regularOrderDetail​ 
```

### 3. Skip Regular Order <a href="#id-3" id="id-3"></a>

Changes the skip status of the selected regular order product to Y.​

A skip status changed to Y is reset to N at the time the order is created.​

If Skip All is set to Y, the skip status is changed back to N after the next scheduled order date is updated.​<br>

* **Skip regular order**([🔗View API >](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8))\
  Sets the order for the selected regular order product to be skipped.

```
PUT /v1/regularOrder/skipRegularOrder​ 
```

***

## Regular Order Application Detail View <a href="#plus" id="plus"></a>

<div align="center"><img src="https://tech.x2bee.com/download/attachments/267813004/1711933514678-%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8%EC%8B%A0%EC%B2%AD%EC%84%9C.drawio.png" alt=""></div>

### 1. Regular Order Application Detail <a href="#id-1" id="id-1"></a>

For logged-in users (members) only, looks up the regular order application detail.​

Looks up the regular order application information matching the regular order number.<br>

* **Regular order application detail (**[🔗View 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))\
  Looks up the regular order application detail.

```
GET /v1/mypage/regularOrder/regularOrderDetail​ 
```

### 2. Change Options <a href="#id-2" id="id-2"></a>

Changes the item and quantity of the regular order.

* **Change regular order options (**[🔗View API >](https://tech.x2bee.com/v1/regularOrder/regularOrderOptionChange))\
  Changes the item and quantity for the regular order product.

```
POST /v1/regularOrder/regularOrderOptionChange 
```

### 3. Skip Regular Order <a href="#id-3.-.1" id="id-3.-.1"></a>

Changes the skip status of the selected regular order product to Y.​

A skip status changed to Y is reset to N at the time the order is created.​

If Skip All is set to Y, the skip status is changed back to N after the next scheduled order date is updated.​<br>

* **Regular order application (**[🔗View API >](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8))\
  Sets the order for the selected regular order product to be skipped.

```
PUT /v1/regularOrder/skipRegularOrder​ 
```

### 4. Change Application Cycle <a href="#id-4" id="id-4"></a>

Changes the regular order's application period and application date.​

If the changed period is shorter than the remaining period, the change is not allowed.​

Updates the next scheduled order date for the regular order to match the changed application period and application date.<br>

* **Change regular order application cycle (**[🔗View API >](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8))\
  Changes the regular order's cycle.​

```
POST /v1/regularOrder/changeDeliTermRegularOrderFO 
```

### 5. Validate Before Changing a Regular Order <a href="#id-5" id="id-5"></a>

Runs validation before changing the regular order cycle.

Raises an exception if the changed period is shorter than the remaining period.<br>

* **Validate before changing a regular order (**[🔗View API >](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8))\
  Runs validation before changing the regular order cycle.

```
POST /v1/regularOrder/validateChangeRegularOrder 
```

### 6. Look Up Next Scheduled Regular Order Date After Cycle Change <a href="#id-6" id="id-6"></a>

Looks up the next scheduled regular order date after the cycle change. Calculates the date starting after that order's cycle has elapsed from the change date.

* **Look up next scheduled regular order date after cycle change (** [🔗View API >](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8))\
  Looks up the next scheduled regular order date after the cycle change.

```
POST /v1/regularOrder/getNextRegularOrderDate
```

### 7. Cancel Regular Order <a href="#id-7" id="id-7"></a>

For logged-in users (members) only, changes the regular order's status (OM009) to Cancelled.<br>

* **Cancel regular order (**[🔗View API >](https://api.x2bee.com/content?msa=order\&depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8))\
  Changes the regular order's status to Cancelled.​

```
PUT /v1/regularOrder/terminateRegularOrderFO 
```

***

## Regular Order Application Completed <a href="#plus" id="plus"></a>

<div align="center"><img src="https://tech.x2bee.com/download/attachments/267813004/Ordersheet.drawio.png" alt=""></div>

### 1. Look Up Regular Order Application Completion Information <a href="#id-1" id="id-1"></a>

You can look up the regular order application completion information.

If an exception occurs during the API lookup, the API's returned message is shown in an alert, and clicking the confirm button navigates to the main screen.

Since gifting and non-members cannot apply for regular orders, there is no application completion page for them.<br>

* **Look up regular order application completion information (**[🔗View 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))\
  An API that looks up the regular order application information after the application succeeds.

```
GET /v1/regularOrder/getRegularOrderCompleteInfo 
```

### 2. Look Up Customer Notification List <a href="#id-2" id="id-2"></a>

Looks up the top "notice" registered in the BO system's 'Notice Management > Customer Notification Management.'​

* **Look up screen customer notification (**[🔗View API >](https://api.x2bee.com/content?msa=common\&depth=%EA%B3%B5%ED%86%B5\&path=getContsList))\
  Looks up the customer notification list.

```
GET /v1/common/getContsList 
```
