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

Display Store

The Display Store API provides the information needed to compose store detail information on the Front screen, based on the store number (storeNo), category number (categoryNo), and brand number (brandNo). The basic composition of a store consists of store information, template information, and a corner list. For a category store, category information is additionally provided, and for a brand store, brand information is additionally provided. Only one display template is retrieved at a time; if none exists, the store information lookup will not work correctly.


Key Features

  • Store information lookup

    • Unstructured stores, brand stores, and category stores can all be looked up.

    • The basic composition consists of the display store, display template, and display corner list.

  • Brand store lookup

    • Brand information is additionally retrieved as part of the basic composition.

  • Category store lookup

    • Category information is additionally retrieved as part of the basic composition.

    • If there is no display template, the default category display template is retrieved.

  • Display template exposure

    • The display template is exposed flexibly according to the display period.

  • Display corner list exposure

    • The display corner list is exposed flexibly according to display status, display period, and display medium.

  • Caching applied

    • Caching is applied to store information, template information, and corner list to minimize data traffic.

  • Product list provision

    • Provides a list of top-selling product information in a category.

  • Handling for members under 19

    • Certain products (harmful media and harmful drugs) are exposed to members under the age of 19 in accordance with applicable laws.

Process Definition

1

Store information lookup

Using the store number, you can retrieve information for unstructured/category/brand stores. For a category or brand store, the corresponding category/brand is also retrieved.

2

Category store information lookup

Retrieves the store, template, category, corner, and content configured for the category store. If there is no linked template, only the store, default template, and category information are retrieved.

3

Brand store information lookup

Retrieves the store, template, brand, corner, and content configured for the brand store.

4

Category best product lookup (dummy)

Called when a corner that retrieves the category's best-selling products is linked to the store template. As a dummy corner API, it may be called flexibly as corners are added.

5

Brand store list lookup

Retrieves the list of brand store information currently on display.


API Function List

API
Description
Server
Method
Notes

Store information lookup

Retrieves detailed store information by store number and display medium code. The store provides the content registered to the template and corners in the BO Display Connection Management.

Display

GET

🔗View API> Product brand list lookup: /api/goods/v1/brands/list

Product review list lookup: /api/goods/v1/review/getReviewDetailList

Brand store list lookup

Retrieves the list of brand store information currently on display. Provides the store information registered to brand stores in the BO Display Connection Management.

Display

GET

Brand store information lookup

Retrieves detailed brand store information by brand number and display medium code.

Display

GET

🔗View API> Product brand list lookup: /api/goods/v1/brands/list

Product review list lookup: /api/goods/v1/review/getReviewDetailList

Category store information lookup

Retrieves detailed category store information by category number and display medium code. If there is no store template available for display in the category store, the default category template information is provided.

Display

GET

🔗View API> Product brand list lookup: /api/goods/v1/brands/list

Product review list lookup: /api/goods/v1/review/getReviewDetailList

Category best product lookup

Retrieves category products sorted by sales. Dummy corner (sample)

Display

GET


Terminology

Term
Description

Display store

Refers to the unit to which a template and corners can be linked, divided into unstructured stores, brand stores, and category stores.

Display template

Refers to a file that defines the display store page layout by area, or in the form in which products are displayed. Once a display template is linked to a display store, corners can be mapped to it to manage the display exposure of content.

Display corner

Refers to the unit that manages the exposure of display targets — such as products, images, text, and HTML — within a specific area of a display template. Display corners are organized as sets, with 1 default set always existing.

Display connection

The basic concept in which content such as images, HTML, and videos is added based on templates and corners to provide information to the Front display area.


Other Notes

  • If a display corner is not exposed, check the display corner's display status, display period, and display medium.

  • There is no limit to the number of content items that can be registered in a display corner. However, when calling the API, retrieval follows the maximum content exposure count.

  • If a display corner's content is not exposed, check the content's display status, display period, and display order.

  • For brand stores, the brand information registered in Brand Management is not exposed; instead, the brand store information registered in Display Connection Management is exposed on the Front.