> 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/back-office/goods-bo/product-common.md).

# Product Common

Efficiently provides functionality used in the Product menu, and looks up product summary information needed for product status, inquiry status, and charts. This helps users check a brief overview of product information at a glance on the BO main screen.

***

## Key Features

* **Product Dashboard API**
  * Provides a way for users to check a brief overview of product information at a glance.
  * Visually provides product status and inquiry status to support effective product management.
* **Product Common API**
  * Commonly classifies content needed for product development to increase reusability.
  * Efficiently looks up product summary information, and includes essential common functions.
* **Product Management Common Popup API**
  * Provides functionality to look up the product list and bulk-change the sale status.
  * Supports convenient product management in popup form to improve user convenience.
* **Product Full View Popup API**
  * Provides functionality to look up detail information, including stock information, in the product list.
  * Allows users to check overall information about a product.

## Process Definition\_ Dashboard

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FFxJCgR4S1pAfoGCqOLec%2F%E1%84%89%E1%85%A1%E1%86%BC%E1%84%91%E1%85%AE%E1%86%B7%20%E1%84%83%E1%85%A2%E1%84%89%E1%85%B5%E1%84%87%E1%85%A9%E1%84%83%E1%85%B3.png?alt=media&#x26;token=881cffea-3c62-475d-819c-4cb47bfa0955" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Product Inquiry Status Lookup

* If the logged-in user has a partner value, only that partner's products are looked up
* If the request contains a transfer processing status code (CS006), only the inquiry list matching that code is looked up
* Looks up only the top 10 inquiries, in order of most recent registration date
  {% endstep %}

{% step %}

### Product Summary Information Lookup

* If the logged-in user has a partner value, only that partner's products are looked up
* For each category (order, wishlist, cart), looks up the product with the most events
* Looks up only products from within the last 7 days
  {% endstep %}

{% step %}

### Product Status Lookup

* If the logged-in user has a partner value, only that partner's products are looked up
* For a product managed for stock, if the stock is less than the safety stock quantity, the product status is looked up as Out of Stock
  {% endstep %}
  {% endstepper %}

## Process Definition\_ Product Common

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FNQ0AUMkf3cr8BMaTzdNr%2F%E1%84%89%E1%85%A1%E1%86%BC%E1%84%91%E1%85%AE%E1%86%B7%E1%84%80%E1%85%A9%E1%86%BC%E1%84%90%E1%85%A9%E1%86%BC.png?alt=media&#x26;token=bc1f371d-831a-453e-922f-f59091cbf32f" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Product Basic Information Lookup

* Looks up the product's basic information
  {% endstep %}

{% step %}

### General Product Information Lookup

* Looks up the product information of a general product
  {% endstep %}

{% step %}

### Bundle Product Information Lookup

* Looks up the product information of a bundle product
  {% endstep %}

{% step %}

### Gift Information Lookup

* Looks up gift information
  {% endstep %}

{% step %}

### Product Notification Item List Lookup

* Looks up the list of product notification items according to the product notification item code
  {% endstep %}

{% step %}

### Product Category Attribute List Lookup

* Looks up the list of product attribute information mapped to the standard category
  {% endstep %}

{% step %}

### Partner Basic Information Lookup

* Looks up the partner's basic information according to the partner number
  {% endstep %}

{% step %}

### Shipping/Return Fee Policy List Lookup

* Looks up the shipping/return fee policy list according to the partner
  {% endstep %}

{% step %}

### Price Change Reservation Registration/Cancellation

* Registers or cancels a price change reservation
* Distinguishes registration and cancellation according to the price change request code
* If a price change reservation is already registered, the existing registered item is deleted and the requested information is registered
* All required values must be entered in this case\
  a. Supply cost, list price, sale price, margin rate, history start date/time, price change reason code (PR033)
  {% endstep %}

{% step %}

### Currently Applied Event Price Lookup

* Looks up the event price information currently applied to the product
  {% endstep %}

{% step %}

### Event Price Registration/Change

* Registers, changes, or deletes an event price reservation
* Distinguishes registration and cancellation according to the price change request code
* If an event price reservation is already registered, the existing registered item is deleted and the requested information is registered
* All required values must be entered in this case\
  a. Supply cost, list price, sale price, margin rate, history start date/time, price change reason code (PR033)
  {% endstep %}

{% step %}

### General Product Modification

* Modifies general product information
* When the sale status is changed to Out of Stock, the sale status of the product and all its SKUs on sale is changed to Out of Stock, and the out-of-stock reason is saved as 'Administrator Out of Stock'
* Product information cannot be modified for a product whose sale status is Ended
* For a product on reservation sale with sale status Out of Stock, the status cannot be changed to On Sale
* Sends an error message if any required value is not entered
  {% endstep %}

{% step %}

### Bundle Product Modification

* Modifies bundle product information
* Product information cannot be modified for a product whose sale status is Ended
* Sends an error message if any required value is not entered
  {% endstep %}

{% step %}

### Gift Modification

* Modifies gift information
* Gift information cannot be modified for a gift whose sale status is Ended
* Sends an error message if any required value is not entered
  {% endstep %}

{% step %}

### Bulk Product Information Modification

* Bulk-modifies the display category or promotional message of the selected products
* When modifying the promotional message, the existing promotional message is deleted and changed to the requested promotional message
  {% endstep %}

{% step %}

### SKU Option List Lookup

* Looks up the SKU option list
  {% endstep %}

{% step %}

### SKU Sale Status List Lookup

* Looks up the SKU sale status list
  {% endstep %}

{% step %}

### Icon Information Lookup

* Looks up the icon information registered on a product
  {% endstep %}

{% step %}

### Product Multilingual Information Lookup

* Looks up, as a list, all multilingual information currently registered on a product
  {% endstep %}

{% step %}

### Product Multilingual Information Registration/Modification

* Registers or modifies the product's multilingual information
* Sends an error message if any required value is not entered
  {% endstep %}

{% step %}

### Display Category List by Standard Category Lookup

* Looks up the display category list by standard category
  {% endstep %}
  {% endstepper %}

## Process Definition\_ Product Management Common Popup

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2F9smsLhMaGrL01JcmtGas%2F%E1%84%89%E1%85%A1%E1%86%BC%E1%84%91%E1%85%AE%E1%86%B7%E1%84%80%E1%85%A9%E1%86%BC%E1%84%90%E1%85%A9%E1%86%BC%20%E1%84%91%E1%85%A1%E1%86%B8%E1%84%8B%E1%85%A5%E1%86%B8.png?alt=media&#x26;token=00356bbf-ec66-4ad3-8cc0-e17481c01a9c" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Product List Lookup

* Looks up the product list according to the search conditions
* If a product number is entered, ignores the product registration period condition and looks up across the entire period
  {% endstep %}

{% step %}

### Bulk Sale Status Change

* Bulk-changes the sale status of products or SKUs
  {% endstep %}
  {% endstepper %}

## API Function List\_ Dashboard

<table><thead><tr><th width="126.7777099609375">API</th><th width="303.888916015625">Description</th><th width="94.666748046875">Server</th><th width="91.333251953125">Method</th><th>Remarks</th></tr></thead><tbody><tr><td>Product Inquiry Status Lookup</td><td>•Looks up the product inquiry status to be displayed on the dashboard.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EB%8C%80%EC%8B%9C%EB%B3%B4%EB%93%9C&#x26;path=getQnASicuations">🔗View API ></a></td></tr><tr><td>Product Summary Information Lookup</td><td>•Looks up the product summary information to be displayed on the dashboard.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EB%8C%80%EC%8B%9C%EB%B3%B4%EB%93%9C&#x26;path=getGoodsSummary">🔗View API ></a></td></tr><tr><td>Product Status Lookup</td><td>•Looks up the product status to be displayed on the dashboard.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EB%8C%80%EC%8B%9C%EB%B3%B4%EB%93%9C&#x26;path=getQnASicuations">🔗View API ></a></td></tr></tbody></table>

## API List\_ Product Common

<table><thead><tr><th width="113.4444580078125">API</th><th width="320.22216796875">Description</th><th width="92.4444580078125">Server</th><th width="90.22216796875">Method</th><th>Remarks</th></tr></thead><tbody><tr><td>Product Basic Information Lookup</td><td><ul><li>Looks up the product's basic information.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getGeneralGoodsInfo">🔗View API ></a></td></tr><tr><td>General Product<br>Information Lookup</td><td><ul><li>Looks up the product information of a general product.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EB%8C%80%EC%8B%9C%EB%B3%B4%EB%93%9C&#x26;path=getQnASicuations">🔗View API ></a></td></tr><tr><td>Bundle Product<br>Information Lookup</td><td><ul><li>Looks up the product information of a bundle product.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getPackageGoodsInfo">🔗View API ></a></td></tr><tr><td>Gift Information Lookup</td><td><ul><li>Looks up gift information.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getPackageGoodsInfo">🔗View API ></a></td></tr><tr><td>Product Notification<br>Item List Lookup</td><td><ul><li>Looks up the product notification item list needed on the product registration/modification/detail pages.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getGoodsNotificationItemList">🔗View API ></a></td></tr><tr><td>Product Category Attribute List Lookup</td><td><ul><li>Looks up the product category attribute list needed on the product registration/modification/detail pages.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getGoodsCtgAttInfoList">🔗View API ></a></td></tr><tr><td>Partner Basic Information Lookup</td><td><ul><li>Looks up the partner basic information needed on the product registration/modification/detail pages.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getEtEntrBase">🔗View API ></a></td></tr><tr><td>Shipping/Return Fee Policy List Lookup</td><td><ul><li>Looks up the shipping/return fee policy list needed on the product registration/modification/detail pages</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getDisplayCategoryListByStandardCategory">🔗View API ></a></td></tr><tr><td>Price Change Reservation Registration/Cancellation</td><td><ul><li>Registers or cancels a price change reservation.</li><li>Distinguishes registration and cancellation according to the price change request code (rsvCudStat). If a price change reservation is already registered, deletes the existing registered item and registers the requested information</li></ul></td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=modifyGeneralGoodsPriceReservation">🔗View API ></a></td></tr><tr><td>Currently Applied Event Price Lookup</td><td><ul><li>Looks up the event price information currently applied to the product.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EB%8C%80%EC%8B%9C%EB%B3%B4%EB%93%9C&#x26;path=getQnASicuations">🔗View API ></a></td></tr><tr><td>Event Price Registration/Change</td><td><ul><li>Registers/changes the event price reservation information. Distinguishes registration and cancellation according to the price change request code (rsvCudStat). If an event price reservation is already registered, deletes the existing registered item and registers the requested information.</li></ul></td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=modifyGeneralGoodsEventPriceReservation">🔗View API ></a></td></tr><tr><td>General Product Modification</td><td><ul><li>Modifies general product information. When the sale status is changed to Out of Stock, the sale status of the product and all its SKUs on sale is changed to Out of Stock, and the out-of-stock reason is saved as 'Administrator Out of Stock'</li></ul></td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=modifyGeneralGoods">🔗View API ></a></td></tr><tr><td>Bundle Product Modification</td><td><ul><li>Modifies bundle product information. Product information cannot be modified for a product whose sale status is Ended. Sends an error message if any required value is not entered</li></ul></td><td>BO</td><td>POST</td><td><a href="http://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=modifyGiftGoods">🔗View API ></a></td></tr><tr><td>Gift Modification</td><td><ul><li>Modifies gift information. Gift information cannot be modified for a gift whose sale status is Ended.</li></ul></td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EB%8C%80%EC%8B%9C%EB%B3%B4%EB%93%9C&#x26;path=getQnASicuations">🔗View API ></a></td></tr><tr><td>Bulk Product Information Modification</td><td><ul><li>Bulk-modifies the display category and promotional message of the selected products. Bulk-modifies the display category or promotional message of the selected products. When modifying the promotional message, deletes the existing promotional message and changes it to the requested promotional message.</li></ul></td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=modifyGoodsInfo">🔗View API ></a></td></tr><tr><td>SKU Option List Lookup</td><td><ul><li>Looks up the SKU option list.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getItemOptionList">🔗View API ></a></td></tr><tr><td>SKU Sale Status List Lookup</td><td><ul><li>Looks up the SKU sale status list.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getGoodsSaleStateList">🔗View API ></a></td></tr><tr><td>Icon Information Lookup</td><td><ul><li>Looks up the icon information registered on a product. NEW and BEST icons are not manually registered; their display is determined every time the query runs</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getPrGoodsIconInfoList">🔗View API ></a></td></tr><tr><td>Product Multilingual Information Lookup</td><td><ul><li>Looks up, as a list, all multilingual information currently registered on a product.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=registGoodsMultiLanguage">🔗View API ></a></td></tr><tr><td>Product Multilingual Information Registration/Modification</td><td><ul><li>Registers or modifies the product's multilingual information. Sends an error message if any required value is not entered.</li></ul></td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getDisplayCategoryListByStandardCategory">🔗View API ></a></td></tr><tr><td>Display Category List by Standard Category Lookup</td><td><ul><li>Looks up the display category list by standard category.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getDisplayCategoryListByStandardCategory">🔗View API ></a></td></tr></tbody></table>

## API Function List\_ Product Common Popup

| API                     | Description                                        | Server | Method | Remarks |
| ----------------------- | -------------------------------------------------- | ------ | ------ | ------- |
| Product List Lookup     | •Looks up the product list.                        | BO     | GET    | ---     |
| Bulk Sale Status Change | •Bulk-changes the sale status of products or SKUs. | BO     | POST   | ---     |

## API Function List\_ Product Full View Popup

| API                                   | Description                                              | Server | Method | Remarks |
| ------------------------------------- | -------------------------------------------------------- | ------ | ------ | ------- |
| Product (Including Stock) List Lookup | •Looks up the product list, including stock information. | BO     | GET    | ---     |

## Terminology

<table><thead><tr><th width="127.3333740234375">Term</th><th>Description</th></tr></thead><tbody><tr><td>Dashboard</td><td>The area showing 4 charts displayed in the center when logging in to the BO system.</td></tr></tbody></table>

## Other Notes

* Icon Information Lookup API
  * NEW and BEST icons are not manually registered; their display is determined every time the query runs.
* Bulk Sale Status Change API
  * Bulk-changes the sale status of products or SKUs.
  * When bulk-changing the sale status of a product, enter only the product number and leave the SKU number blank.
  * When bulk-changing the sale status of a product, all of that product's SKUs also have their status changed in bulk.
  * When changing from On Sale -> Out of Stock, only SKUs that are On Sale are changed to Out of Stock.
  * When changing from Out of Stock -> On Sale, all SKUs in Out of Stock status that have not been separately changed are changed to On Sale.
  * When changed to On Sale, an SKU with no stock is automatically changed to Out of Stock when the out-of-stock batch runs.
  * When bulk-changing the sale status of SKUs, enter both the product number and the SKU number.
  * When bulk-changing the sale status of SKUs, if the sale status of all SKUs changes, the product's sale status is also changed accordingly.