> 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/goods/product-detail.md). # Product Detail This is a guide to the Product Detail API used to compose the product detail screen on the front end based on the registered product number (goodsNo). **Providing Product Information** * The basic unit of a product, including sub-item information such as color/size. * Provides a variety of information, including product price, stock, sales status, partner, brand, product reviews, product Q\&A, product delivery information, and discount information (including promotions). **Applying Caching** * Caching is applied to external content (images, product detail HTML) to minimize data traffic, with customer experience designed as the top priority. *** ## Key Features * **Vendor Information Management**: Provides additional information about the product supply vendor (partner). * **Standard Category Information**: Provides a standard classification system for managing products, allowing navigation to the representative display category for each standard category. * **Filtering for Members Under 19**: In accordance with applicable law, filters certain products (harmful media and harmful drugs) from being shown to members under the age of 19. * **Price Information** * Provides various price information, including supply price, regular price, selling price, and event price. * Various option combinations can be configured per item, and additional charges per item are also transparently provided. * **Product Status**: Provides sales status options such as sold out, temporarily sold out, sales ended, and reserved, depending on the sales status of the product and its items. * **Stock Management**: Configured to manage stock efficiently, providing features such as the maximum order quantity per order, stock quantity display, and safety stock. * **Delivery Information**: Provides various delivery-related information based on the applied delivery type and delivery/return fee policy. * **Image Information**: Provides various image information, including the main image, additional images, and thumbnail images, developed with caching to minimize customer traffic. * **Related Product Registration**: Developed so that products similar or related to the current product can be registered and displayed as related products. * **Additional Services**: Provides additional services related to product purchases by offering gift and complimentary item information. * **External Channel Discount Information**: When a customer accesses the product detail page through an external channel, provides information about additional discounts specific to that channel code. ## Process Definition

{% stepper %} {% step %} ### Retrieve Product Detail Information * Retrieves and displays product detail information * Retrieves and displays basic product information, content information, related products, brief review information, product icon information, and basic item information {% endstep %} {% step %} ### Retrieve Maximum Benefit Price per Product * Reflects the maximum benefit price when displaying the product price * The maximum benefit price information API provides information from the promotion module {% endstep %} {% step %} ### Retrieve Option Information (Option Popup) * Displays item option information in a select box * Validates quantity changes using stock management status, purchase quantity limits, and minimum/maximum purchase quantity information {% endstep %} {% step %} ### Increase/Decrease Stock per Item * API for increasing/decreasing stock due to orders, exchanges, and returns * Requests an increase/decrease based on item orders placed through the order module * Only stock-managed products are processed for increase/decrease {% endstep %} {% step %} ### Retrieve Complimentary Item Information * Requested by the order module to display the complimentary item for the relevant product * Complimentary item information is provided as text only, containing the item name {% endstep %} {% step %} ### Retrieve Display Product Information (Display Product Summary) * Summarized product information used in listings; requested to retrieve product information for display in a list * Supports retrieving multiple products at once for the products to be displayed in a list * Product image: Provides the required main image of the product {% endstep %} {% step %} ### Retrieve Item Information per Product * Retrieves information about the items under a product * Provides basic product information, representative display category information, item name, stock information, and price information {% endstep %} {% step %} ### Retrieve Item Information per Product (Order-Only) * Retrieves information for multiple products * Used when selecting a different item with the same available purchase quantity, selling price, and item surcharge during an exchange in the order module * Only items with stock greater than the requested quantity are retrieved {% endstep %} {% step %} ### Retrieve Substitutable Item Information (Cart) * Retrieves information for multiple products * Among items other than the requested product/item, retrieves other items with the same selling price and item surcharge * Retrieves other item information with the same item surcharge * Only items with a quantity greater than the requested quantity are retrieved {% endstep %} {% step %} ### Retrieve Item Information per Product (Cart-Only) * Requested to display detailed information for each item in the cart * Retrieves item information based on multiple item numbers received as a list {% endstep %} {% step %} ### Retrieve Available Payment Methods per Product * Retrieves payment methods for multiple products * Only retrieves payment methods with a usage status of 'Y' * Retrieved by the order module to display the list of payment methods for a product {% endstep %} {% step %} ### Retrieve Instant Discount Price per Item * The instant discount price information API provides information from the promotion module * Requested to display the instant discount price in the product list {% endstep %} {% endstepper %} ## API Function List

API	Description	Server	Method	Notes
Retrieve Substitutable Item Information (Cart)	•API called when retrieving a single product. •For the requested product, retrieves a list of other items — besides the requested item — that are substitutable by product+item+quantity (other items with the same selling price + item surcharge). • Since the product price is the same, only the item surcharge is checked. • Only retrieves items whose stock is greater than the requested quantity. • Retrieves using the language code stored in the cookie.	Goods	POST	🔗View API >
Increase/Decrease Stock per Item	• Returns an error if the decreased item quantity exceeds the stock quantity (resulting in negative stock). • Changes the item sales status code to "On Sale" if the increased item quantity exceeds the safety stock quantity.	Goods	PUT	🔗View API >
Retrieve Option Information (Option Popup)	• API for retrieving the option list for a product. • When retrieving a bundle product, retrieves the option list of the bundle product's representative product. • Retrieves the options that include items whose product display status is Y and whose item sales status is On Sale/Sold Out. • Excludes single products with no item list from the retrieval. • Includes basic item information for leaf options. • Retrieves using the site number and mall number stored in the cookie. • For preview, retrieves using the preview language code in the request; otherwise, retrieves using the language code stored in the cookie.	Goods	GET	🔗View API >
Retrieve Item Information per Product (Cart-Only)	• Called to retrieve detailed information per item in the cart. • Retrieves item detail information based on the item numbers received as a list. • Retrieves using the language code and mall number stored in the cookie.	Goods	POST	🔗View API >
Retrieve Item Information per Product (Order-Only)	• Called when retrieving multiple products. • For each requested product, retrieves the item list per product for other items — besides the requested item — that are substitutable by product+item+quantity (other items with the same selling price + item surcharge). • Only retrieves items whose stock is greater than the requested quantity. • Retrieves using the language code stored in the cookie.	Goods	POST	🔗View API >
Retrieve Item Information per Product	• Retrieves information for all items within a product, based on the product number. • Retrieves using the language code stored in the cookie. • Retrieves the item name, stock information, and price information.	Goods	POST	🔗View API >
Retrieve Maximum Benefit Price per Product (Provided by Promotion)	• API for retrieving the maximum benefit price of a product. • If the request does not include an item number, retrieves the price based on the item with the lowest item number, applying the promotion's maximum benefit price. • If the request includes an item number, retrieves the price based on that item number of the product, applying the promotion's maximum benefit price. • Retrieves the list of promotions applicable to the maximum benefit price. • Retrieves using the site number and mall number stored in the cookie. • If the request includes a channel number, retrieves using that channel number; otherwise, retrieves using the channel number stored in the cookie. • If the user is logged in, the logged-in user's information is applied to the promotion's maximum benefit price calculation conditions.	Goods	GET	🔗View API > [Product Detail Maximum Benefit Price Lookup] /api/order/v1/marketing/maxDcAmt
Retrieve Instant Discount Price per Item	• API for retrieving the instant discount price per item. • Retrieves using the site number and mall number stored in the cookie. - Retrieves price information with the instant discount price applied to the item.	Goods	GET	🔗View API > [Retrieve Instant Discount Price per Product] /api/order/v1/marketing/goodsDirectDiscountList
Retrieve Available Payment Methods per Product	• Retrieves the payment methods for each of multiple products. • Retrieves using the language code stored in the cookie. • Only retrieves payment methods with a usage status of 'Y'.	Goods	POST	🔗View API >
Retrieve Complimentary Item Information	• Retrieves the complimentary item for a product. • 1001: An error that occurs when the request value is missing or the request value does not include a product number.	Goods	POST	🔗View API >
Retrieve Product Detail Information	• API for retrieving detailed product information on the product's detail page. • Retrieves products whose display status is Y, sales status is On Sale/Sold Out, and that fall within the sales period. • Retrieves the product's basic/item/brand/image/price/payment method/related product/bundle product/delivery fee policy/promotion/complimentary item/review rating statistics information. • Retrieves using the language code, site number, and mall number stored in the cookie.	Goods	GET	🔗View API >
Retrieve Display Product Information (Display Product Summary)	• Supports retrieving multiple products. • Provides the product's main image as the image. • For preview, retrieves using the preview language code in the request; otherwise, retrieves using the language code stored in the cookie.	Goods	POST	🔗View API >

## Terminology

Term	Description	Notes
Product	• Refers to any goods sold through a commerce channel. • The basic unit for displaying a product, and the basic unit that composes the product detail screen. • A product is the unit by which price is managed.
Item	• The smallest management unit under a product — the smallest unit of product stock and sale, i.e., the unit the customer actually purchases. • The unit for managing order product information based on the customer's selected options. • The unit for managing stock. (In the solution, stock refers to 'web stock'.) • Item information is created from a combination of options. (Example) Item A: Color-Black/Size-260 / Item B: Color-Black/Size-250
Option	• The basic unit for creating product variations. • Items such as 'Color' and 'Size' are called option names, and 'Black', 'XL', etc. are called option values. • Option types that are commonly used across most commerce include gender, color, size, weight, capacity, and region, and additional types can be added per site as needed.
General Product (Category)	• Refers to any goods product for which standard delivery is provided.
Gift (Category)	• Refers to a product provided at no additional cost to customers who meet certain conditions through a promotion or event, such as purchasing a specific product or purchasing above a certain amount.
General Product	• Refers to a product whose options are managed as codes at the item level. • Stock is deducted at the item level.
Bundle Product	• Refers to a bundle product used for display purposes, regardless of whether a discount is applied. • Customers purchase by selecting some of the products that make up the option composition.
Reservation Product	• Refers to a product that is pre-ordered over a set period and shipped together on the delivery notification date. - Reservation products are registered by selecting at the item level, which is the sales unit. • Items can only be retrieved and selected when the reservation product information's display period falls within the product's display period.