Ctrlk
X2BEE Home
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Order Form

The page where a customer proceeds with an order to purchase a product; on this page, they can review the ordered product information and edit various information such as delivery and payment method.

PC

Mobile

Order Form Basic View Area

1. Validate Order Form Entry

When entering the order form, user validation (checking required information, membership status, age, etc.) is performed before the order form is displayed.

  • Validate order form entry (🔗View API >) If order form entry validation fails, returns a code and message for each exception case.

2. View Order Form and Enter Payment Method

When creating or viewing an order form for a member or non-member, that order form's detailed information is displayed. You can select and register a payment method, and the final payment amount is calculated based on the delivery address/mileage (auxiliary payment)/coupons and benefits.

1) Member\

  • “Orderer, email, password, confirm password” information is not displayed.\

  • The member's default delivery address is shown by default.

2) Non-member\

  • “Coupons and benefits, held mileage, mileage to be accrued” information is not displayed.\

  • The Add Delivery Address button is displayed.

  • Look up order form (🔗View API >) Displays the various configuration information needed when creating or viewing an order form.

The payment method selection screen displays different payment methods depending on the following situations:

  • Held mileage and payment method display information appear according to the payment method in the price information at the time the product was registered.

  • Apple Pay and Samsung Pay display information differently depending on the OS and browser.\

    • Apple Pay: when on iOS, Safari\

    • Samsung Pay: when not on iOS

3. Look Up Common Codes Used in the Order Form

  • Look up common code list (🔗View API >) Looks up multiple common codes needed when creating or viewing an order form.

4. Look Up Order Form Top Notice

  • Look up screen customer notification (🔗View API >) Looks up the customer notification list to be displayed at the top of the order form and non-member order form.

    If there are no notification items, the customer notification area is not displayed.

5. Look Up Gift Promotion

  • Look up order form gift promotion (🔗View API >) Checks whether an ongoing gift promotion exists for the ordered products.

    Selecting a gift promotion product can be done in the gift promotion modal popup that appears when the payment button is clicked.

6. Look Up Member Information

Non-members are not looked up since they have no delivery address to retrieve.

  • Look up member information (unmasked) (🔗View API >) Looks up the member's unmasked information and displays the member's default delivery address.

7. Look Up Order Form Coupon List

Non-members cannot use coupons, so this is not looked up for them.

  • Look up order form coupon list (🔗View API >) Looks up the maximum applicable benefit value for the order form and displays the number of coupons and the discount amount.

8. Look Up Order Form Accrual Information

Non-members cannot accrue mileage, so this is not looked up for them.

  • Look up order form accrual information (🔗View API >) Looks up accrual information matching the order information and shows the purchasing member the mileage to be accrued.

Add/Change Delivery Address and Calculate Delivery Fee on the Order Form

1. Look Up Delivery Address List

On the order form, calls the delivery address change popup when the user changes or adds a delivery address.

  • Look up member delivery address list (🔗View API >) Looks up the orderer's delivery address list.

2. Look Up Delivery Fee by Delivery Group

Called when the user changes or adds delivery address information, or changes the product quantity, on the order form.

  • Look up delivery group fee (🔗View API >) Looks up the delivery fee for each delivery group; if the requested delivery group's postal code is in a remote/island area, an additional delivery fee is charged.

3. Look Up Maximum Delivery Fee Benefit

On the order form, when the user changes or adds delivery address information, or changes the product quantity, looks up the coupon information that provides the maximum benefit among the delivery fee coupons.

  • Look up maximum delivery fee benefit (🔗View API >) Looks up available delivery fee coupon information for each delivery group and sets the delivery fee coupon on the one delivery group that matches the condition.

View and Change Discount Benefit Details on the Order Form

1. View Discount Benefit Details

Clicking the Change Benefits button on the order form looks up the benefit information available for that order and displays it in a popup.

  1. By default, the maximum discount benefit information is shown, and you can set/clear the maximum discount information at any time via the Apply Maximum Discount checkbox at the top.

  2. Non-member orders cannot receive discount benefits, so the coupons and benefits area is not displayed on the order form.

  • Look up order form coupon list (🔗View API >) Looks up available benefit information when entering the coupon selection popup.

Only one discount benefit can be selected per stage.

  • Primary discount: sale price discount (an area set on the product; cannot be selected)

  • Secondary discount: employee discount / instant product discount / product discount coupon

  • Tertiary discount: cart coupon / stackable discount coupon

  • Other: delivery fee coupon

Example 1) In a single order, you can use a product discount coupon, a cart coupon, and a delivery fee coupon at the same time.

Example 2) In a single order, you cannot use an instant product discount and a product discount coupon at the same time.

If you select the employee discount in the secondary discount, you cannot select a tertiary discount.

2. Apply Discount Benefit

After selecting a discount benefit in the discount benefit lookup popup and clicking the Apply button at the bottom, the selected discount benefit information is applied to the order and displayed in the coupons and benefits area and the payment area.

Gifting

1. Validate Gifting Order

On the cart page, clicking that product's Gift button runs order product validation to enter the gifting order form.

If the product is determined to be orderable, the gifting order form page appears.

For this API, please refer to the order eligibility validation in the Cart document.

2. View Gifting Order Form and Enter Payment Information

When creating or viewing a gifting order form, that order form's detailed information is displayed. For this API, please refer to View Order Form and Enter Payment Information in the Order Form document.

The gifting order form differs from a standard order form by providing the following features:

  • Non-members cannot use the gifting feature

  • Provides a gift message, card selection, and recipient information entry features

  • Does not provide delivery address and delivery message entry fields

Managing Received/Sent Gifts

For a description of viewing and managing history of gifts received or sent, please see the My Menu > Gift Box document.

PreviousCart
NextPayment