> 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/api-en/store-front-api-reference/display-api/display-category.md).

# Display Category

## Retrieve Display Icon List

> \## Function Description\
> \* This API retrieves the list of display icons.\
> \---\
> \## Detailed Description\
> \* Retrieves the display icon information list based on the site number.\
> \---\
> \## Revision History\
> \* \`\`\`Release v1.03\_231106\`\`\` : Icon (badge) settings<br>

````json
{"openapi":"3.1.0","info":{"title":"X2BEE Display API","version":"v1"},"servers":[{"url":"https://api-display.x2bee.com/api/display/","description":"prd"}],"paths":{"/v1/icon":{"get":{"tags":["Display Category"],"summary":"Retrieve Display Icon List","description":"## Function Description\n* This API retrieves the list of display icons.\n---\n## Detailed Description\n* Retrieves the display icon information list based on the site number.\n---\n## Revision History\n* ```Release v1.03_231106``` : Icon (badge) settings\n","operationId":"getIconList","parameters":[{"name":"siteNo","in":"query","description":"Site No.","required":true,"schema":{"type":"string"}},{"name":"dispMediaCd","in":"query","description":"Display Media Code (DP018)","required":true,"schema":{"type":"string"}},{"name":"iconTypCd","in":"query","description":"Icon Type Code (DP001)","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Display icon list retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconInfo"}}}}}}}},"components":{"schemas":{"IconInfo":{"type":"object","description":"Icon DTO","properties":{"siteNo":{"type":"string","description":"Site"},"dispIconNo":{"type":"string","description":"Icon No."},"iconNm":{"type":"string","description":"Icon Name"},"iconTypCd":{"type":"string","description":"Icon Type Code"},"pcIconFileNm":{"type":"string","description":"PC Icon File Name"},"pcIconPathNm":{"type":"string","description":"PC Icon Path Name"},"moIconFileNm":{"type":"string","description":"MO Icon File Name"},"moIconPathNm":{"type":"string","description":"MO Icon Path"}}}}}}
````

## Retrieve Displayed Products

> \## Function Description\
> \* This API retrieves the product list.\
> \---\
> \## Detailed Description\
> \* If a display category number is passed, retrieves the detailed product information list for the display category.\
> \* If a product number is passed, retrieves the detailed information list for the product.\
> \* If a page number and page size are passed, the total count (totalCount) is retrieved together.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Display API","version":"v1"},"servers":[{"url":"https://api-display.x2bee.com/api/display/","description":"prd"}],"paths":{"/v1/goods":{"get":{"tags":["Display Category"],"summary":"Retrieve Displayed Products","description":"## Function Description\n* This API retrieves the product list.\n---\n## Detailed Description\n* If a display category number is passed, retrieves the detailed product information list for the display category.\n* If a product number is passed, retrieves the detailed information list for the product.\n* If a page number and page size are passed, the total count (totalCount) is retrieved together.\n","operationId":"getGoodsList","parameters":[{"name":"goodsNoArr","in":"query","description":"Product No. List","schema":{"type":"string"}},{"name":"dispCtgNo","in":"query","description":"Category No.","schema":{"type":"string"}},{"name":"pageNo","in":"query","description":"Page No.","schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Page Size","schema":{"type":"integer"}},{"name":"sort","in":"query","description":"Sort Code","schema":{"type":"string"}},{"name":"saleStatCds","in":"query","description":"Sales Status Code (PR005)","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Displayed products retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Goods"}}}}}}}},"components":{"schemas":{"Goods":{"type":"object","description":"Product DTO","properties":{"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"entrNo":{"type":"string","description":"Vendor No."},"goodsCompCd":{"type":"string","description":"Product Composition Code (PR001) 10: General Product, 20: Bundled Product"},"goodsTypCd":{"type":"string","description":"Product Type Code (PR002) 10: General Product, 20: Free Gift, 30: E-Coupon Product"},"saleMethCd":{"type":"string","description":"Sales Method Code (PR003) 10: General Sale, 20: Reservation Product"},"brandNo":{"type":"string","description":"Brand No."},"brandNm":{"type":"string","description":"Brand Name"},"buyrAgeLmtCd":{"type":"string","description":"Purchaser Age Restriction Code (PR004) 0: 0, 15: 15"},"dispYn":{"type":"string","description":"Display Status"},"saleStatCd":{"type":"string","description":"Sales Status Code (PR005) 01: Temporary Save, 02: Pending Approval, 03: Rejected, 10: On Sale, 20: Sold Out, 30: Discontinued"},"goodsRegDtm":{"type":"string","format":"date-time","description":"Product Registration Date/Time"},"saleStrDtm":{"type":"string","format":"date-time","description":"Sales Start Date/Time"},"saleEndDtm":{"type":"string","format":"date-time","description":"Sales End Date/Time"},"stkMgrYn":{"type":"string","description":"Inventory Management Status"},"deliProcTypCd":{"type":"string","description":"Delivery Processing Type Code (PR008) 10: Center Delivery, 20: Vendor Delivery"},"deliGoodsGbCd":{"type":"string","description":"Delivery Product Classification Code (PR010) 01: General Product, 02: Installation Product, 03: Made-to-Order, 04: E-Coupon"},"deliWayCd":{"type":"string","description":"Delivery Method Code (PR009) 01: Courier Delivery, 02: No Delivery"},"deliDday":{"type":"string","description":"Delivery Lead Time"},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"prcHistStrDtm":{"type":"string","format":"date-time","description":"Price History Start Date/Time"},"prcHistEndDtm":{"type":"string","format":"date-time","description":"Price History End Date/Time"},"rcntSalePrc":{"type":"integer","format":"int64","description":"Recent Selling Price"},"salePrc":{"type":"integer","format":"int64","description":"Selling Price"},"aplyPrc":{"type":"integer","format":"int64","description":"Applied Price (Display Price)"},"dispCtgNo":{"type":"string","description":"Display Category No."},"dlexTypCd":{"type":"string","description":"Delivery Fee Type Code (VD005) 10: Free, 20: Paid, 30: Conditionally Free"},"goodsImmedDcCpnNo":{"type":"string","description":"Product Instant Discount Coupon No."},"goodsImmedDcAplyStrDtm":{"type":"string","format":"date-time","description":"Product Instant Discount Application Start Date/Time"},"goodsImmedDcAplyEndDtm":{"type":"string","format":"date-time","description":"Product Instant Discount Application End Date/Time"},"goodsRepImgContSn":{"type":"string","description":"Product Main Image Content Serial No."},"rservSaleYn":{"type":"string","description":"Reservation Sale Status"},"rservStrDtm":{"type":"string","format":"date-time","description":"Reservation Start Date/Time"},"rservEndDtm":{"type":"string","format":"date-time","description":"Reservation End Date/Time"},"goodsRevCnt":{"type":"string","description":"Product Review Count"},"goodsRevHlpfulCnt":{"type":"string","description":"Product Review Helpful Count"},"goodsRevStarscrAvgVal":{"type":"number","format":"double","description":"Product Review Average Rating"},"fixamtFxrtGbCd":{"type":"string","description":"Product Instant Fixed Amount/Rate Type Code (MK005)"},"dcRateAmt":{"type":"integer","format":"int64","description":"Product Instant Discount Rate/Amount"},"dcRate":{"type":"integer","format":"int64","description":"Product Discount Rate"},"wishListCnt":{"type":"string","description":"Wishlist Count"},"goodsRepImgPathNm":{"type":"string","description":"Representative Image File Path"},"trnfTextCont":{"type":"string","description":"Representative Image Alt Text"},"adlCertiYn":{"type":"string","description":"Adult Verification Status"},"iconList":{"type":"array","description":"Icon Information","items":{"type":"string"}},"prcTimeDealYn":{"type":"string","description":"Time Deal Status"}}}}}}
```

## Retrieve Display Category List

> \## Function Description\
> \* Retrieves all display category information or brand display category information.\
> \---\
> \## Detailed Description\
> \* All display category information\
> &#x20;   \* If there are no parameters, retrieves all display category information hierarchically (large/medium/small/detail) using subCategoryList.\
> \* Brand display category information\
> &#x20;   \* If a brand number (brandNo) is provided as a parameter, retrieves the display category information that the brand's products belong to, hierarchically (large/medium/small/detail) using subCategoryList.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Display API","version":"v1"},"servers":[{"url":"https://api-display.x2bee.com/api/display/","description":"prd"}],"paths":{"/v1/displayCategory":{"get":{"tags":["Display Category"],"summary":"Retrieve Display Category List","description":"## Function Description\n* Retrieves all display category information or brand display category information.\n---\n## Detailed Description\n* All display category information\n    * If there are no parameters, retrieves all display category information hierarchically (large/medium/small/detail) using subCategoryList.\n* Brand display category information\n    * If a brand number (brandNo) is provided as a parameter, retrieves the display category information that the brand's products belong to, hierarchically (large/medium/small/detail) using subCategoryList.\n","operationId":"getCategoryList","parameters":[{"name":"brandNo","in":"query","description":"Brand No.","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Display category information retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisplayCategory"}}}},"400":{"description":"Failed to retrieve display category information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}},"components":{"schemas":{"DisplayCategory":{"type":"object","description":"Display Category","properties":{"dispCtgNo":{"type":"string","description":"Display Category No."},"dispCtgNm":{"type":"string","description":"Display Category Name"},"dispSeq":{"type":"integer","format":"int32","description":"Display Order"},"uprDispCtgNo":{"type":"string","description":"Parent Display Category No."},"lrgCtgNo":{"type":"string","description":"Large Category No."},"midCtgNo":{"type":"string","description":"Middle Category No."},"smlCtgNo":{"type":"string","description":"Sub Category No."},"thnCtgNo":{"type":"string","description":"Detail Category No."},"leafYn":{"type":"string","description":"Lowest-Level Status"},"depth":{"type":"string","description":"Category Depth"},"subCategoryList":{"type":"array","description":"Sub-Category List","items":{"$ref":"#/components/schemas/DisplayCategory"}}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}}}
```

## Retrieve Single Display Category

> \## Function Description\
> \* Retrieves display category information by display category number.\
> \---\
> \## Detailed Description\
> \* Single display category information\
> &#x20;   \* Retrieves only the display category information corresponding to the display category number (dispCtgNo) provided as a parameter.\
> &#x20;   \* Since only the information for the given display category number is retrieved, subCategoryList is excluded from the response.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Display API","version":"v1"},"servers":[{"url":"https://api-display.x2bee.com/api/display/","description":"prd"}],"paths":{"/v1/displayCategory/{dispCtgNo}":{"get":{"tags":["Display Category"],"summary":"Retrieve Single Display Category","description":"## Function Description\n* Retrieves display category information by display category number.\n---\n## Detailed Description\n* Single display category information\n    * Retrieves only the display category information corresponding to the display category number (dispCtgNo) provided as a parameter.\n    * Since only the information for the given display category number is retrieved, subCategoryList is excluded from the response.\n","operationId":"getDisplayCategory","parameters":[{"name":"dispCtgNo","in":"path","description":"Display Category No.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Single display category retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisplayCategory"}}}},"400":{"description":"Failed to retrieve single display category","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}},"components":{"schemas":{"DisplayCategory":{"type":"object","description":"Display Category","properties":{"dispCtgNo":{"type":"string","description":"Display Category No."},"dispCtgNm":{"type":"string","description":"Display Category Name"},"dispSeq":{"type":"integer","format":"int32","description":"Display Order"},"uprDispCtgNo":{"type":"string","description":"Parent Display Category No."},"lrgCtgNo":{"type":"string","description":"Large Category No."},"midCtgNo":{"type":"string","description":"Middle Category No."},"smlCtgNo":{"type":"string","description":"Sub Category No."},"thnCtgNo":{"type":"string","description":"Detail Category No."},"leafYn":{"type":"string","description":"Lowest-Level Status"},"depth":{"type":"string","description":"Category Depth"},"subCategoryList":{"type":"array","description":"Sub-Category List","items":{"$ref":"#/components/schemas/DisplayCategory"}}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}}}
```