> 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/order/subscription-order-service.md).

# Subscription Order Service

This is an API service for shopping mall customers in which subscription orders are automatically created and products are delivered. When a customer conveniently applies for the subscription order service for a desired product, an automatic order is created according to the specified cycle and date, allowing the customer to easily receive the product.

***

## Key Features

* **Subscription Order Application**
  * Applications are made by adding products eligible for subscription orders to the cart.
  * Delivery and payment information is automatically set to the member's default information.
  * As optional settings, delivery request notes, application period, and application date can be specified.
  * Non-members cannot apply for the subscription order service.
* **Subscription Order Data Creation**
  * A subscription delivery order is automatically created on the next order creation date of the applied product.
* **Subscription Order Service Application List Lookup**
  * Retrieves the list of subscription order service applications for the member number.
  * Only orders within the lookup period are returned.
* **Subscription Order Service Detail Lookup**
  * Retrieves the subscription order details based on the subscription order number.
* **Subscription Order Change and Cancellation**
  * Cancellation and order cycle changes are possible from the subscription order service details.
  * The next scheduled order date can be changed by using Skip All.

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2F5KqXqmUhyiW9igcYkdvw%2Fimage.png?alt=media&#x26;token=97400570-b71c-4d5f-8917-4168fcabc890" alt=""><figcaption></figcaption></figure>

## Process Definition — Subscription Order Application

{% stepper %}
{% step %}

### Order Eligibility Validation

Users can enter the subscription order application form from the cart screen. Upon entering the application form, an overall validation is performed to check whether the product is eligible for ordering and whether the member is in a state eligible to order.
{% endstep %}

{% step %}

### Order Application Form Lookup

Auto-payment card, member default delivery address, order product, delivery, and accumulation information are divided into order sheet information needed to display the order sheet and order creation information needed to create the order application, and delivered accordingly.
{% endstep %}

{% step %}

### Subscription Order Number Issuance

Issues a subscription order number for creating the subscription order application.
{% endstep %}

{% step %}

### Apply for Subscription Order

Creates the subscription order application based on the order information selected on the screen.
{% endstep %}

{% step %}

### Application Completion Information Lookup

Retrieves the subscription order application completion information to display on the application completion page.
{% endstep %}

{% step %}

### Subscription Order Creation

A daily batch creates orders for subscription order applications whose next scheduled order creation date has arrived.
{% endstep %}
{% endstepper %}

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2Fc1Y4MzLiKMBW4ZqUXsXU%2Fimage.png?alt=media&#x26;token=8656f0dd-b70d-44b7-bb2b-81a2cdaabc2f" alt=""><figcaption></figcaption></figure>

## Process Definition — Subscription Order Application Lookup

{% stepper %}
{% step %}

### Subscription Order List Lookup

For members, the subscription order application list can be viewed via My Page > Subscription Order Application History.
{% endstep %}

{% step %}

### Subscription Order History Detail Lookup

Clicking the subscription order number navigates to the subscription order application details.
{% endstep %}
{% endstepper %}

## API Function List

<table><thead><tr><th width="92.3333740234375">API</th><th width="297.4444580078125">Description</th><th width="94.0001220703125">Server</th><th width="87.22216796875">Method</th><th>Remarks</th></tr></thead><tbody><tr><td>Subscription Order Application Form Lookup</td><td>Retrieves the member's subscription order application form information.</td><td>Order</td><td>POST</td><td><a href="https://api.x2bee.com/content?msa=order&#x26;depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8/regularOrderSheet">🔗View API ></a><br>Product lookup:<br>/api/goods/v1/detail/goods<br>Member default delivery address lookup: /api/member/v1/front/dlvpInfo​<br>Delivery policy lookup: /api/goods/v1/delivery/deliProcInfo</td></tr><tr><td>Subscription Order Number Issuance</td><td>Issues the subscription order number.</td><td>Order</td><td>GET</td><td><a href="https://api.x2bee.com/content?msa=order&#x26;depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8/getRglrDeliNo">🔗View API ></a></td></tr><tr><td>Subscription Order Application</td><td>Applies for the subscription order.</td><td>Order</td><td>POST</td><td><a href="https://api.x2bee.com/content?msa=order&#x26;depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8/applyForRegularOrder">🔗View API ></a></td></tr><tr><td>Subscription Order Application Completion Information Lookup</td><td>Retrieves the subscription order application information after a successful application.</td><td>Order</td><td>GET</td><td><a href="https://api.x2bee.com/content?msa=order&#x26;depth=%EC%A0%95%EA%B8%B0%EC%A3%BC%EB%AC%B8/getRegularOrderCompleteInfo">🔗View API ></a></td></tr><tr><td>Subscription Order History Lookup</td><td>Retrieves the order list for the member number.<br>Non-members cannot view the order history list.<br>Only orders within the lookup start date/time and lookup end date/time are retrieved.</td><td>Order</td><td>GET</td><td><a href="https://api.x2bee.com/content?msa=order&#x26;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/regularOrderInfoList">🔗View API ></a></td></tr><tr><td>Subscription Order History Detail Lookup</td><td>Retrieves the subscription order history for the subscription order number.</td><td>Order</td><td>GET</td><td><a href="https://api.x2bee.com/content?msa=order&#x26;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/regularOrderDetail">🔗View API ></a></td></tr></tbody></table>

## Terminology

<table><thead><tr><th width="171.7777099609375">Term</th><th>Description</th><th data-hidden>Remarks</th></tr></thead><tbody><tr><td>Subscription Delivery Cycle Value</td><td>A string composed of comma-separated numbers (e.g., “1,2,3”). When the cycle code is month, it represents the day of the month; when it is week, it represents the day of the week.</td><td></td></tr><tr><td>Next Order Creation Date</td><td>A date generated based on the subscription delivery cycle value. It is first generated at the time of application, and when that date arrives, the subscription order is created.</td><td></td></tr></tbody></table>

## Other Notes

* The subscription delivery cycle is managed via a common code. (OM034)
* When the scheduled subscription order date is first generated, the number of days corresponding to the larger of OM021's values (order application scheduled notice date, order creation date) must pass before the date becomes eligible for creation.