> 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/back-office-api-reference/display-bo-api/display-category-management.md). # Display Category Management ## Retrieve Display Category Basic Information > \## Function Description\ > \* Retrieves the information of the display category by display category number.\ > \---\ > \## Detailed Description\ > \* \[BO] Display > Category Management > Display Category Management > Display Category Basic Information area\ > \* Retrieves the basic information of the display category when a display category is selected on the Display Category Management page.
```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PrDispCtgBase":{"type":"object","description":"Display Category Basic","properties":{"siteNo":{"type":"string","description":"Site No."},"dispCtgNo":{"type":"string","description":"Display Category No."},"dpmlNo":{"type":"string","description":"Mall No."},"dispSeq":{"type":"integer","format":"int32","description":"Display Order"},"useYn":{"type":"string","description":"Usage Status"},"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"},"dispCtgNm":{"type":"string","description":"Display Category Name"},"multiDispCtgNm":{"type":"string","description":"Display Category Name (Multilingual)"},"dpmlNm":{"type":"string","description":"Display Mall Name","readOnly":true},"siteNm":{"type":"string","description":"Site Name","readOnly":true},"lrgCtgNm":{"type":"string","description":"Large Category Name","readOnly":true},"midCtgNm":{"type":"string","description":"Medium Category Name","readOnly":true},"smlCtgNm":{"type":"string","description":"Small Category Name","readOnly":true},"thnCtgNm":{"type":"string","description":"Detail Category Name","readOnly":true},"shopNo":{"type":"string","description":"Store No.","readOnly":true},"prtTypCd":{"type":"string","description":"Output Type Code","readOnly":true},"hierarchyText":{"type":"string","description":"Hierarchy Structure Text","readOnly":true},"leafCtgYnChangePossible":{"type":"string","description":"Whether Leaf Standard Classification Status Can Be Changed","readOnly":true},"realGridCUD":{"$ref":"#/components/schemas/RealGridCUDRequestPrDispCtgBase","description":"CUD List"}}},"RealGridCUDRequestPrDispCtgBase":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v2/display/display-category/{dispCtgNo}":{"get":{"tags":["Display Category Management"],"summary":"Retrieve Display Category Basic Information","description":"## Function Description\n* Retrieves the information of the display category by display category number.\n---\n## Detailed Description\n* [BO] Display > Category Management > Display Category Management > Display Category Basic Information area\n* Retrieves the basic information of the display category when a display category is selected on the Display Category Management page.\n","operationId":"getCategoryDetail","parameters":[{"name":"dispCtgNo","in":"path","description":"Display Category No.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Display Category Basic Information Inquiry Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrDispCtgBase"}}}},"900":{"description":"Display Category Basic Information Inquiry Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}} ``` ## Modify Display Category Basic Information > \## Function Description\ > \* Modifies the basic information of a display category.\ > \---\ > \## Detailed Description\ > \* \[BO] Display > Category Management > Display Category Management > Display Category Basic Information area\ > \* Modifies the display category name, usage status, display order, and lowest-level status in the display category basic information.\ > \* In BO, the lowest-level status can only be modified if none of the following 1, 2, 3, 4 apply.\ > 1\) Whether it has sub display categories\ > 2\) Whether products are registered\ > 3\) Whether it is linked to a standard category\ > 4\) Whether it is a fine category\ > \* Input parameters (\_\_\*\_\_: required)\ > \- \_\_dispCtgNo \*, leafYn \*, useYn \*, dispSeq \*\_\_\ > \---\ > \### Code Reference\ > \* \`\`\` Usage Status \`\`\` : Y,N\ > \* \`\`\` Lowest-Level Status \`\`\` : Y,N
````json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PrDispCtgBase":{"type":"object","description":"Display Category Basic","properties":{"siteNo":{"type":"string","description":"Site No."},"dispCtgNo":{"type":"string","description":"Display Category No."},"dpmlNo":{"type":"string","description":"Mall No."},"dispSeq":{"type":"integer","format":"int32","description":"Display Order"},"useYn":{"type":"string","description":"Usage Status"},"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"},"dispCtgNm":{"type":"string","description":"Display Category Name"},"multiDispCtgNm":{"type":"string","description":"Display Category Name (Multilingual)"},"dpmlNm":{"type":"string","description":"Display Mall Name","readOnly":true},"siteNm":{"type":"string","description":"Site Name","readOnly":true},"lrgCtgNm":{"type":"string","description":"Large Category Name","readOnly":true},"midCtgNm":{"type":"string","description":"Medium Category Name","readOnly":true},"smlCtgNm":{"type":"string","description":"Small Category Name","readOnly":true},"thnCtgNm":{"type":"string","description":"Detail Category Name","readOnly":true},"shopNo":{"type":"string","description":"Store No.","readOnly":true},"prtTypCd":{"type":"string","description":"Output Type Code","readOnly":true},"hierarchyText":{"type":"string","description":"Hierarchy Structure Text","readOnly":true},"leafCtgYnChangePossible":{"type":"string","description":"Whether Leaf Standard Classification Status Can Be Changed","readOnly":true},"realGridCUD":{"$ref":"#/components/schemas/RealGridCUDRequestPrDispCtgBase","description":"CUD List"}}},"RealGridCUDRequestPrDispCtgBase":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v2/display/display-category/{dispCtgNo}":{"put":{"tags":["Display Category Management"],"summary":"Modify Display Category Basic Information","description":"## Function Description\n* Modifies the basic information of a display category.\n---\n## Detailed Description\n* [BO] Display > Category Management > Display Category Management > Display Category Basic Information area\n* Modifies the display category name, usage status, display order, and lowest-level status in the display category basic information.\n * In BO, the lowest-level status can only be modified if none of the following 1, 2, 3, 4 apply.\n 1) Whether it has sub display categories\n 2) Whether products are registered\n 3) Whether it is linked to a standard category\n 4) Whether it is a fine category\n* Input parameters (__*__: required)\n - __dispCtgNo *, leafYn *, useYn *, dispSeq *__\n---\n### Code Reference\n* ``` Usage Status ``` : Y,N\n* ``` Lowest-Level Status ``` : Y,N\n","operationId":"modifyDisplayCategory","parameters":[{"name":"dispCtgNo","in":"path","description":"Display Category No.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrDispCtgBase"}}},"required":true},"responses":{"200":{"description":"Display Category Basic Information Modification Successful","content":{"application/json":{"schema":{"type":"string"}}}},"900":{"description":"Display Category Basic Information Modification Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}} ```` ## Register Display Category Basic Information > \## Function Description\ > \* Registers the basic information of a display category.\ > \---\ > \## Detailed Description\ > \* \[BO] Display > Category Management > Display Category Management > Display Category Basic Information area\ > \* The basic information of a display category can be registered.\ > \* Input parameters (\_\_\*\_\_: required)\ > \- \_\_siteNo \*, dpmlNo \*, dispCtgNm \*, leafYn \*, useYn \*, dispSeq\*, sysRegId\*, sysModId \*\_\_\ > \---\ > \### Code Reference\ > \* \`\`\` Usage Status \`\`\` : Y,N\ > \* \`\`\` Lowest-Level Status \`\`\` : Y,N
````json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PrDispCtgBase":{"type":"object","description":"Display Category Basic","properties":{"siteNo":{"type":"string","description":"Site No."},"dispCtgNo":{"type":"string","description":"Display Category No."},"dpmlNo":{"type":"string","description":"Mall No."},"dispSeq":{"type":"integer","format":"int32","description":"Display Order"},"useYn":{"type":"string","description":"Usage Status"},"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"},"dispCtgNm":{"type":"string","description":"Display Category Name"},"multiDispCtgNm":{"type":"string","description":"Display Category Name (Multilingual)"},"dpmlNm":{"type":"string","description":"Display Mall Name","readOnly":true},"siteNm":{"type":"string","description":"Site Name","readOnly":true},"lrgCtgNm":{"type":"string","description":"Large Category Name","readOnly":true},"midCtgNm":{"type":"string","description":"Medium Category Name","readOnly":true},"smlCtgNm":{"type":"string","description":"Small Category Name","readOnly":true},"thnCtgNm":{"type":"string","description":"Detail Category Name","readOnly":true},"shopNo":{"type":"string","description":"Store No.","readOnly":true},"prtTypCd":{"type":"string","description":"Output Type Code","readOnly":true},"hierarchyText":{"type":"string","description":"Hierarchy Structure Text","readOnly":true},"leafCtgYnChangePossible":{"type":"string","description":"Whether Leaf Standard Classification Status Can Be Changed","readOnly":true},"realGridCUD":{"$ref":"#/components/schemas/RealGridCUDRequestPrDispCtgBase","description":"CUD List"}}},"RealGridCUDRequestPrDispCtgBase":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v2/display/display-category":{"post":{"tags":["Display Category Management"],"summary":"Register Display Category Basic Information","description":"## Function Description\n* Registers the basic information of a display category.\n---\n## Detailed Description\n* [BO] Display > Category Management > Display Category Management > Display Category Basic Information area\n* The basic information of a display category can be registered.\n* Input parameters (__*__: required)\n - __siteNo *, dpmlNo *, dispCtgNm *, leafYn *, useYn *, dispSeq*, sysRegId*, sysModId *__\n---\n### Code Reference\n* ``` Usage Status ``` : Y,N\n* ``` Lowest-Level Status ``` : Y,N\n","operationId":"registerDisplayCategory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrDispCtgBase"}}},"required":true},"responses":{"200":{"description":"Display Category Basic Information Registration Successful","content":{"application/json":{"schema":{"type":"string"}}}},"900":{"description":"Display Category Basic Information Registration Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}} ```` ## Retrieve Display Product List > \## Function Description\ > \* Retrieves the display product list of the display category by display category number.\ > \---\ > \## Detailed Description\ > \* \[BO] Display > Category Management > Display Category Management > Display Product List grid area\ > \* Retrieves the display product list of the display category displayed in the grid when a display category is selected on the Display Category Management page.\ > \* Sorted in ascending order by product registration date.\ > \---\ > \## Revision History\ > \* \`\`\`Release v2.00\_240529\`\`\` : Added Display Status and Product Sale Code inquiry conditions
````json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PrDispGoodsInfo":{"type":"object","description":"Display Category Basic_Product Information","properties":{"goodsNo":{"type":"string","description":"Product No."},"dispCtgNo":{"type":"string","description":"Display Category No."},"dispYn":{"type":"string","description":"Display Status"},"errorMessage":{"type":"string","description":"Error Message","readOnly":true},"goodsList":{"type":"array","description":"Product No. List","items":{"type":"string"}},"goodsArray":{"type":"array","description":"Product No. Array","items":{"type":"string"}},"itemList":{"type":"array","description":"SKU No. List","items":{"type":"string"}},"itemArray":{"type":"array","description":"SKU No. Array","items":{"type":"string"}},"goodsNm":{"type":"string","description":"Product Name","readOnly":true},"goodsTypCd":{"type":"string","description":"Product Type","readOnly":true},"norPrc":{"type":"number","description":"Regular Price","readOnly":true},"salePrc":{"type":"number","description":"Selling Price","readOnly":true},"saleStatCd":{"type":"string","description":"Sales Status","readOnly":true},"entrNm":{"type":"string","description":"Vendor Name","readOnly":true},"goodsImg":{"type":"string","description":"Product Image","readOnly":true},"moodTagVal":{"type":"string","description":"Mood","readOnly":true},"wght":{"type":"string","description":"Weight","readOnly":true}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v2/display/display-category/{dispCtgNo}/goods":{"get":{"tags":["Display Category Management"],"summary":"Retrieve Display Product List","description":"## Function Description\n* Retrieves the display product list of the display category by display category number.\n---\n## Detailed Description\n* [BO] Display > Category Management > Display Category Management > Display Product List grid area\n* Retrieves the display product list of the display category displayed in the grid when a display category is selected on the Display Category Management page.\n* Sorted in ascending order by product registration date.\n---\n## Revision History\n* ```Release v2.00_240529``` : Added Display Status and Product Sale Code inquiry conditions\n","operationId":"getDisplayGoodsList","parameters":[{"name":"rowsPerPage","in":"query","description":"Rows per Page","required":true,"schema":{"type":"string"}},{"name":"pageIdx","in":"query","description":"Current Page","required":true,"schema":{"type":"string"}},{"name":"dispCtgNo","in":"path","description":"Display Category No.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Display Product List Inquiry Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrDispGoodsInfo"}}}},"900":{"description":"Display Product List Inquiry Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}} ```` ## Save Display Product List > \## Function Description\ > \* Saves the display product list of the display category.\ > \---\ > \## Detailed Description\ > \* \[BO] Display > Category Management > Display Category Management > Display Product List grid area\ > \* Adds, modifies, and deletes products in the display product list grid.\ > \* Input parameters (\_\_\*\_\_: required)\ > \- create: \_\_dispCtgNo \*, goodsNo \*, dispYn \*\_\_\ > \- update: \_\_dispCtgNo \*, goodsNo \*, dispYn \*\_\_\ > \- delete: \_\_dispCtgNo \*, goodsNo \*\_\_
```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RealGridCUDRequestPrDispGoodsInfo":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/PrDispGoodsInfo"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/PrDispGoodsInfo"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/PrDispGoodsInfo"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/PrDispGoodsInfo"}}}},"PrDispGoodsInfo":{"type":"object","description":"Display Category Basic_Product Information","properties":{"goodsNo":{"type":"string","description":"Product No."},"dispCtgNo":{"type":"string","description":"Display Category No."},"dispYn":{"type":"string","description":"Display Status"},"errorMessage":{"type":"string","description":"Error Message","readOnly":true},"goodsList":{"type":"array","description":"Product No. List","items":{"type":"string"}},"goodsArray":{"type":"array","description":"Product No. Array","items":{"type":"string"}},"itemList":{"type":"array","description":"SKU No. List","items":{"type":"string"}},"itemArray":{"type":"array","description":"SKU No. Array","items":{"type":"string"}},"goodsNm":{"type":"string","description":"Product Name","readOnly":true},"goodsTypCd":{"type":"string","description":"Product Type","readOnly":true},"norPrc":{"type":"number","description":"Regular Price","readOnly":true},"salePrc":{"type":"number","description":"Selling Price","readOnly":true},"saleStatCd":{"type":"string","description":"Sales Status","readOnly":true},"entrNm":{"type":"string","description":"Vendor Name","readOnly":true},"goodsImg":{"type":"string","description":"Product Image","readOnly":true},"moodTagVal":{"type":"string","description":"Mood","readOnly":true},"wght":{"type":"string","description":"Weight","readOnly":true}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v2/display/display-category/{dispCtgNo}/goods":{"post":{"tags":["Display Category Management"],"summary":"Save Display Product List","description":"## Function Description\n* Saves the display product list of the display category.\n---\n## Detailed Description\n* [BO] Display > Category Management > Display Category Management > Display Product List grid area\n* Adds, modifies, and deletes products in the display product list grid.\n* Input parameters (__*__: required)\n - create: __dispCtgNo *, goodsNo *, dispYn *__\n - update: __dispCtgNo *, goodsNo *, dispYn *__\n - delete: __dispCtgNo *, goodsNo *__\n","operationId":"saveGoodsList","parameters":[{"name":"dispCtgNo","in":"path","description":"Display Category No.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestPrDispGoodsInfo"}}},"required":true},"responses":{"200":{"description":"Display Product List Save Successful","content":{"application/json":{"schema":{"type":"string"}}}},"900":{"description":"Display Product List Save Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}} ``` ## Excel Display Product List Bulk Save > \## Function Description\ > \* Saves only the non-duplicate products among the display category's display product list.\ > \---\ > \## Detailed Description\ > \* \[BO] Display > Category Management > Display Category Management > Display Product Bulk Registration button > Display Product Bulk Registration popup\ > \* Saves only the non-duplicate display products entered in the bulk registration grid via an Excel file, and returns the duplicate products.\ > \* Input parameters (\_\_\*\_\_: required)\ > \- \_\_dispCtgNo \*, displayGoodsList \*\_\_
```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"DisplayCategoryGoodsExcel":{"type":"object","properties":{"dispCtgNo":{"type":"string","description":"Product No."},"displayGoodsList":{"type":"array","description":"Product List","items":{"$ref":"#/components/schemas/PrDispGoodsInfo"}}}},"PrDispGoodsInfo":{"type":"object","description":"Display Category Basic_Product Information","properties":{"goodsNo":{"type":"string","description":"Product No."},"dispCtgNo":{"type":"string","description":"Display Category No."},"dispYn":{"type":"string","description":"Display Status"},"errorMessage":{"type":"string","description":"Error Message","readOnly":true},"goodsList":{"type":"array","description":"Product No. List","items":{"type":"string"}},"goodsArray":{"type":"array","description":"Product No. Array","items":{"type":"string"}},"itemList":{"type":"array","description":"SKU No. List","items":{"type":"string"}},"itemArray":{"type":"array","description":"SKU No. Array","items":{"type":"string"}},"goodsNm":{"type":"string","description":"Product Name","readOnly":true},"goodsTypCd":{"type":"string","description":"Product Type","readOnly":true},"norPrc":{"type":"number","description":"Regular Price","readOnly":true},"salePrc":{"type":"number","description":"Selling Price","readOnly":true},"saleStatCd":{"type":"string","description":"Sales Status","readOnly":true},"entrNm":{"type":"string","description":"Vendor Name","readOnly":true},"goodsImg":{"type":"string","description":"Product Image","readOnly":true},"moodTagVal":{"type":"string","description":"Mood","readOnly":true},"wght":{"type":"string","description":"Weight","readOnly":true}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v2/display/display-category/{dispCtgNo}/excel":{"post":{"tags":["Display Category Management"],"summary":"Excel Display Product List Bulk Save","description":"## Function Description\n* Saves only the non-duplicate products among the display category's display product list.\n---\n## Detailed Description\n* [BO] Display > Category Management > Display Category Management > Display Product Bulk Registration button > Display Product Bulk Registration popup\n* Saves only the non-duplicate display products entered in the bulk registration grid via an Excel file, and returns the duplicate products.\n* Input parameters (__*__: required)\n - __dispCtgNo *, displayGoodsList *__\n","operationId":"registerExcelGoodsList","parameters":[{"name":"dispCtgNo","in":"path","description":"Display Category No.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisplayCategoryGoodsExcel"}}},"required":true},"responses":{"200":{"description":"Excel Display Product List Bulk Save Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrDispGoodsInfo"}}}},"900":{"description":"Excel Display Product List Bulk Save Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}} ``` ## Retrieve Display Category Name Multilingual List > \## Function Description\ > \* Retrieves the multilingual category name list of the display category by a list of display category numbers.\ > \---\ > \## Detailed Description\ > \* \[BO] Display > Category Management > Standard Category Management > Register Multilingual button > Display Category Name Multilingual Registration popup\ > \* Retrieves the multilingual list of the display category displayed in the grid when the Register Multilingual button is selected on the Display Category Management page.\ > \---\ > \### Code Reference\ > \* \`\`\` Multilingual Language Code \`\`\` : ko, en
````json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PrDispCtgBase":{"type":"object","description":"Display Category Basic","properties":{"siteNo":{"type":"string","description":"Site No."},"dispCtgNo":{"type":"string","description":"Display Category No."},"dpmlNo":{"type":"string","description":"Mall No."},"dispSeq":{"type":"integer","format":"int32","description":"Display Order"},"useYn":{"type":"string","description":"Usage Status"},"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"},"dispCtgNm":{"type":"string","description":"Display Category Name"},"multiDispCtgNm":{"type":"string","description":"Display Category Name (Multilingual)"},"dpmlNm":{"type":"string","description":"Display Mall Name","readOnly":true},"siteNm":{"type":"string","description":"Site Name","readOnly":true},"lrgCtgNm":{"type":"string","description":"Large Category Name","readOnly":true},"midCtgNm":{"type":"string","description":"Medium Category Name","readOnly":true},"smlCtgNm":{"type":"string","description":"Small Category Name","readOnly":true},"thnCtgNm":{"type":"string","description":"Detail Category Name","readOnly":true},"shopNo":{"type":"string","description":"Store No.","readOnly":true},"prtTypCd":{"type":"string","description":"Output Type Code","readOnly":true},"hierarchyText":{"type":"string","description":"Hierarchy Structure Text","readOnly":true},"leafCtgYnChangePossible":{"type":"string","description":"Whether Leaf Standard Classification Status Can Be Changed","readOnly":true},"realGridCUD":{"$ref":"#/components/schemas/RealGridCUDRequestPrDispCtgBase","description":"CUD List"}}},"RealGridCUDRequestPrDispCtgBase":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v2/display/display-category/multi-lang":{"get":{"tags":["Display Category Management"],"summary":"Retrieve Display Category Name Multilingual List","description":"## Function Description\n* Retrieves the multilingual category name list of the display category by a list of display category numbers.\n---\n## Detailed Description\n* [BO] Display > Category Management > Standard Category Management > Register Multilingual button > Display Category Name Multilingual Registration popup\n* Retrieves the multilingual list of the display category displayed in the grid when the Register Multilingual button is selected on the Display Category Management page.\n---\n### Code Reference\n* ``` Multilingual Language Code ``` : ko, en\n","operationId":"getDisplayCategoryMgmtSubCategoryMultiLanguageList","parameters":[{"name":"dispCtgNoList","in":"query","description":"Display Category No. List","required":true,"schema":{"type":"array"}},{"name":"multiLangCd","in":"query","description":"Multilingual Language Code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Display Category Name Multilingual List Inquiry Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrDispCtgBase"}}}},"900":{"description":"Display Category Name Multilingual List Inquiry Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}} ```` ## Save Display Category Name Multilingual > \## Function Description\ > \* Saves the multilingual category name list of the display category.\ > \---\ > \## Detailed Description\ > \* \[BO] Display > Category Management > Standard Category Management > Register Multilingual button > Display Category Name Multilingual Registration popup\ > \* Saves the multilingual list of the display category displayed in the grid when the Register Multilingual button is selected on the Display Category Management page.\ > \* Input parameters (\_\_\*\_\_: required)\ > \- \_\_dispCtgNm \*, langCd \*\_\_, multiDispCtgNm\ > \---\ > \### Code Reference\ > \* \`\`\` Multilingual Language Code \`\`\` : ko, en
````json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"DisplayCategoryMultiLang":{"type":"object","properties":{"realGridCUD":{"$ref":"#/components/schemas/RealGridCUDRequestPrDispCtgBase","description":"Display Category Multilingual Grid Information"},"langCd":{"type":"string"},"displayCategoryMlList":{"type":"array","description":"Display Category Multilingual List","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"sysRegId":{"type":"string","description":"Registrant ID"},"sysModId":{"type":"string","description":"Modifier ID"}}},"RealGridCUDRequestPrDispCtgBase":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}}}},"PrDispCtgBase":{"type":"object","description":"Display Category Basic","properties":{"siteNo":{"type":"string","description":"Site No."},"dispCtgNo":{"type":"string","description":"Display Category No."},"dpmlNo":{"type":"string","description":"Mall No."},"dispSeq":{"type":"integer","format":"int32","description":"Display Order"},"useYn":{"type":"string","description":"Usage Status"},"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"},"dispCtgNm":{"type":"string","description":"Display Category Name"},"multiDispCtgNm":{"type":"string","description":"Display Category Name (Multilingual)"},"dpmlNm":{"type":"string","description":"Display Mall Name","readOnly":true},"siteNm":{"type":"string","description":"Site Name","readOnly":true},"lrgCtgNm":{"type":"string","description":"Large Category Name","readOnly":true},"midCtgNm":{"type":"string","description":"Medium Category Name","readOnly":true},"smlCtgNm":{"type":"string","description":"Small Category Name","readOnly":true},"thnCtgNm":{"type":"string","description":"Detail Category Name","readOnly":true},"shopNo":{"type":"string","description":"Store No.","readOnly":true},"prtTypCd":{"type":"string","description":"Output Type Code","readOnly":true},"hierarchyText":{"type":"string","description":"Hierarchy Structure Text","readOnly":true},"leafCtgYnChangePossible":{"type":"string","description":"Whether Leaf Standard Classification Status Can Be Changed","readOnly":true},"realGridCUD":{"$ref":"#/components/schemas/RealGridCUDRequestPrDispCtgBase","description":"CUD List"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v2/display/display-category/multi-lang":{"post":{"tags":["Display Category Management"],"summary":"Save Display Category Name Multilingual","description":"## Function Description\n* Saves the multilingual category name list of the display category.\n---\n## Detailed Description\n* [BO] Display > Category Management > Standard Category Management > Register Multilingual button > Display Category Name Multilingual Registration popup\n* Saves the multilingual list of the display category displayed in the grid when the Register Multilingual button is selected on the Display Category Management page.\n* Input parameters (__*__: required)\n - __dispCtgNm *, langCd *__, multiDispCtgNm\n---\n### Code Reference\n* ``` Multilingual Language Code ``` : ko, en\n","operationId":"saveSubCategoryMultiLanguage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisplayCategoryMultiLang"}}},"required":true},"responses":{"200":{"description":"Sub Display Category Name Multilingual Save Successful","content":{"application/json":{"schema":{"type":"string"}}}},"900":{"description":"Sub Display Category Name Multilingual Save Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}} ```` ## Check Display Category List Deletable Status > \## Function Description\ > \* Checks whether a display category list can be deleted, by display category number.\ > \---\ > \## Detailed Description\ > \* \[BO] Display > Category Management > Display Category Management > Sub Display Category List grid area\ > \* Checks whether deletion is possible when deleting a display category in the sub display category list grid.\ > \* A display category can only be deleted if none of the following 1, 2, 3 apply.\ > 1\) Whether it has sub display categories\ > 2\) Whether products are registered\ > 3\) Whether it is linked to a standard category
```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PrDispCtgSearch":{"type":"object","description":"Display Category Search Model","properties":{"siteNo":{"type":"string","description":"Site No."},"dispCtgNo":{"type":"string","description":"Display Category No."},"dpmlNo":{"type":"string","description":"Mall No."},"useYn":{"type":"string","description":"Usage Status"},"dispYn":{"type":"string","description":"Display Status"},"dispCtgNoList":{"type":"array","description":"Display Category No. List","items":{"type":"string"}},"dispCtgNm":{"type":"string","description":"Display Category Name"},"multiLangCd":{"type":"string","description":"Multilingual Language Code"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v2/display/display-category/getCheckDisplayCategoryListDelete":{"post":{"tags":["Display Category Management"],"summary":"Check Display Category List Deletable Status","description":"## Function Description\n* Checks whether a display category list can be deleted, by display category number.\n---\n## Detailed Description\n* [BO] Display > Category Management > Display Category Management > Sub Display Category List grid area\n* Checks whether deletion is possible when deleting a display category in the sub display category list grid.\n* A display category can only be deleted if none of the following 1, 2, 3 apply.\n 1) Whether it has sub display categories\n 2) Whether products are registered\n 3) Whether it is linked to a standard category\n","operationId":"getCheckStandardCategoryListDelete_1","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgSearch"}}}},"required":true},"responses":{"200":{"description":"Display Category Deletion Availability Check Success","content":{"application/json":{"schema":{"type":"boolean"}}}},"900":{"description":"Display Category Deletion Availability Check Failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}} ``` ## Save Sub Display Category List > \## Function Description\ > \* Saves the sub display category list.\ > \---\ > \## Detailed Description\ > \* \[BO] Display > Category Management > Display Category Management > Sub Display Category List area\ > \* Adds, modifies, and deletes display categories in the sub display category list grid.\ > \* Input parameters (\_\_\*\_\_: required)\ > \- create: \_\_siteNo \*, dpmlNo \*, uprDispCtgNo \*, leafYn \*, useYn \*, dispSeq \*\_\_, lrgCtgNo, midCtgNo, smlCtgNo, thnCtgNo\ > \- update: \_\_dispCtgNo \*, leafYn \*, useYn \*, dispSeq \*\_\_\ > \- delete: \_\_dispCtgNo \*\_\_
```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PrDispCtgBase":{"type":"object","description":"Display Category Basic","properties":{"siteNo":{"type":"string","description":"Site No."},"dispCtgNo":{"type":"string","description":"Display Category No."},"dpmlNo":{"type":"string","description":"Mall No."},"dispSeq":{"type":"integer","format":"int32","description":"Display Order"},"useYn":{"type":"string","description":"Usage Status"},"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"},"dispCtgNm":{"type":"string","description":"Display Category Name"},"multiDispCtgNm":{"type":"string","description":"Display Category Name (Multilingual)"},"dpmlNm":{"type":"string","description":"Display Mall Name","readOnly":true},"siteNm":{"type":"string","description":"Site Name","readOnly":true},"lrgCtgNm":{"type":"string","description":"Large Category Name","readOnly":true},"midCtgNm":{"type":"string","description":"Medium Category Name","readOnly":true},"smlCtgNm":{"type":"string","description":"Small Category Name","readOnly":true},"thnCtgNm":{"type":"string","description":"Detail Category Name","readOnly":true},"shopNo":{"type":"string","description":"Store No.","readOnly":true},"prtTypCd":{"type":"string","description":"Output Type Code","readOnly":true},"hierarchyText":{"type":"string","description":"Hierarchy Structure Text","readOnly":true},"leafCtgYnChangePossible":{"type":"string","description":"Whether Leaf Standard Classification Status Can Be Changed","readOnly":true},"realGridCUD":{"$ref":"#/components/schemas/RealGridCUDRequestPrDispCtgBase","description":"CUD List"}}},"RealGridCUDRequestPrDispCtgBase":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v2/display/display-category/categories":{"post":{"tags":["Display Category Management"],"summary":"Save Sub Display Category List","description":"## Function Description\n* Saves the sub display category list.\n---\n## Detailed Description\n* [BO] Display > Category Management > Display Category Management > Sub Display Category List area\n* Adds, modifies, and deletes display categories in the sub display category list grid.\n* Input parameters (__*__: required)\n - create: __siteNo *, dpmlNo *, uprDispCtgNo *, leafYn *, useYn *, dispSeq *__, lrgCtgNo, midCtgNo, smlCtgNo, thnCtgNo\n - update: __dispCtgNo *, leafYn *, useYn *, dispSeq *__\n - delete: __dispCtgNo *__\n","operationId":"saveCategoryList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrDispCtgBase"}}},"required":true},"responses":{"200":{"description":"Sub Display Category List Save Successful","content":{"application/json":{"schema":{"type":"string"}}}},"900":{"description":"Sub Display Category List Save Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}} ``` ## Retrieve Display Product List > \## Function Description\ > \* Retrieves product list information after checking for duplicates with existing display products, using product numbers.\ > \---\ > \## Detailed Description\ > \* \[BO] Display > Category Management > Display Category Management > Display Product List grid area\ > \* When adding a display product in BO, the product number is passed from the product inquiry popup.\ > \* Retrieves the product detail information after checking for duplicates with existing display products, using the array of product numbers.\ > \* Adds a row with the product detail information to display it in the display product list grid.
```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PrDispGoodsInfo":{"type":"object","description":"Display Category Basic_Product Information","properties":{"goodsNo":{"type":"string","description":"Product No."},"dispCtgNo":{"type":"string","description":"Display Category No."},"dispYn":{"type":"string","description":"Display Status"},"errorMessage":{"type":"string","description":"Error Message","readOnly":true},"goodsList":{"type":"array","description":"Product No. List","items":{"type":"string"}},"goodsArray":{"type":"array","description":"Product No. Array","items":{"type":"string"}},"itemList":{"type":"array","description":"SKU No. List","items":{"type":"string"}},"itemArray":{"type":"array","description":"SKU No. Array","items":{"type":"string"}},"goodsNm":{"type":"string","description":"Product Name","readOnly":true},"goodsTypCd":{"type":"string","description":"Product Type","readOnly":true},"norPrc":{"type":"number","description":"Regular Price","readOnly":true},"salePrc":{"type":"number","description":"Selling Price","readOnly":true},"saleStatCd":{"type":"string","description":"Sales Status","readOnly":true},"entrNm":{"type":"string","description":"Vendor Name","readOnly":true},"goodsImg":{"type":"string","description":"Product Image","readOnly":true},"moodTagVal":{"type":"string","description":"Mood","readOnly":true},"wght":{"type":"string","description":"Weight","readOnly":true}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v2/display/display-category/{dispCtgNo}/goods/valid":{"get":{"tags":["Display Category Management"],"summary":"Retrieve Display Product List","description":"## Function Description\n* Retrieves product list information after checking for duplicates with existing display products, using product numbers.\n---\n## Detailed Description\n* [BO] Display > Category Management > Display Category Management > Display Product List grid area\n* When adding a display product in BO, the product number is passed from the product inquiry popup.\n* Retrieves the product detail information after checking for duplicates with existing display products, using the array of product numbers.\n* Adds a row with the product detail information to display it in the display product list grid.\n","operationId":"getGoodsListDetail","parameters":[{"name":"dispCtgNo","in":"path","description":"Display Category No.","required":true,"schema":{"type":"string"}},{"name":"goodsArray","in":"query","description":"Display Product Number Array","required":true,"schema":{"type":"array"}}],"responses":{"200":{"description":"Display Product List Detail Inquiry Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrDispGoodsInfo"}}}},"900":{"description":"Display Product List Detail Inquiry Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}} ``` ## Retrieve Validity of Bulk-Registered Display Products > \## Function Description\ > \* Checks whether a product is valid for addition to display products, using the product number and display category number.\ > \---\ > \## Detailed Description\ > \* \[BO] Display > Category Management > Display Category Management > Display Product Bulk Registration button > Display Product Bulk Registration popup\ > \* Checks whether the received display product bulk registration products are invalid (duplicate / non-existent) for addition to display products.\ > \* If a product is a duplicate of an already registered display product or does not exist, sets and returns an error message for that product.\ > \---\ > \## Code Reference\ > \* \`\`\` Display Status \`\`\` : Y, N
````json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PrDispGoodsInfo":{"type":"object","description":"Display Category Basic_Product Information","properties":{"goodsNo":{"type":"string","description":"Product No."},"dispCtgNo":{"type":"string","description":"Display Category No."},"dispYn":{"type":"string","description":"Display Status"},"errorMessage":{"type":"string","description":"Error Message","readOnly":true},"goodsList":{"type":"array","description":"Product No. List","items":{"type":"string"}},"goodsArray":{"type":"array","description":"Product No. Array","items":{"type":"string"}},"itemList":{"type":"array","description":"SKU No. List","items":{"type":"string"}},"itemArray":{"type":"array","description":"SKU No. Array","items":{"type":"string"}},"goodsNm":{"type":"string","description":"Product Name","readOnly":true},"goodsTypCd":{"type":"string","description":"Product Type","readOnly":true},"norPrc":{"type":"number","description":"Regular Price","readOnly":true},"salePrc":{"type":"number","description":"Selling Price","readOnly":true},"saleStatCd":{"type":"string","description":"Sales Status","readOnly":true},"entrNm":{"type":"string","description":"Vendor Name","readOnly":true},"goodsImg":{"type":"string","description":"Product Image","readOnly":true},"moodTagVal":{"type":"string","description":"Mood","readOnly":true},"wght":{"type":"string","description":"Weight","readOnly":true}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v2/display/display-category/{dispCtgNo}/excel/valid":{"get":{"tags":["Display Category Management"],"summary":"Retrieve Validity of Bulk-Registered Display Products","description":"## Function Description\n* Checks whether a product is valid for addition to display products, using the product number and display category number.\n---\n## Detailed Description\n* [BO] Display > Category Management > Display Category Management > Display Product Bulk Registration button > Display Product Bulk Registration popup\n* Checks whether the received display product bulk registration products are invalid (duplicate / non-existent) for addition to display products.\n* If a product is a duplicate of an already registered display product or does not exist, sets and returns an error message for that product.\n---\n## Code Reference\n* ``` Display Status ``` : Y, N\n","operationId":"getDisplayGoodsExcelValid","parameters":[{"name":"goodsArr","in":"query","description":"Product No.","required":true,"schema":{"type":"array"}},{"name":"dispCtgNo","in":"path","description":"Display Category No.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Bulk-Registered Display Product Validity Inquiry Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrDispGoodsInfo"}}}},"900":{"description":"Bulk-Registered Display Product Validity Inquiry Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}} ```` ## Retrieve Display Category List > \## Function Description\ > \* Retrieves the sub display category list of the display category by display category number.\ > \---\ > \## Detailed Description\ > \* \[BO] Display > Category Management > Display Category Management > Sub Display Category List grid area\ > \* Retrieves the sub display categories and total count of the display category displayed in the grid when a display category is selected on the Display Category Management page.\ > \* Sorted in ascending order by display order and descending order by modification date and time.
```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PrDispCtgBase":{"type":"object","description":"Display Category Basic","properties":{"siteNo":{"type":"string","description":"Site No."},"dispCtgNo":{"type":"string","description":"Display Category No."},"dpmlNo":{"type":"string","description":"Mall No."},"dispSeq":{"type":"integer","format":"int32","description":"Display Order"},"useYn":{"type":"string","description":"Usage Status"},"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"},"dispCtgNm":{"type":"string","description":"Display Category Name"},"multiDispCtgNm":{"type":"string","description":"Display Category Name (Multilingual)"},"dpmlNm":{"type":"string","description":"Display Mall Name","readOnly":true},"siteNm":{"type":"string","description":"Site Name","readOnly":true},"lrgCtgNm":{"type":"string","description":"Large Category Name","readOnly":true},"midCtgNm":{"type":"string","description":"Medium Category Name","readOnly":true},"smlCtgNm":{"type":"string","description":"Small Category Name","readOnly":true},"thnCtgNm":{"type":"string","description":"Detail Category Name","readOnly":true},"shopNo":{"type":"string","description":"Store No.","readOnly":true},"prtTypCd":{"type":"string","description":"Output Type Code","readOnly":true},"hierarchyText":{"type":"string","description":"Hierarchy Structure Text","readOnly":true},"leafCtgYnChangePossible":{"type":"string","description":"Whether Leaf Standard Classification Status Can Be Changed","readOnly":true},"realGridCUD":{"$ref":"#/components/schemas/RealGridCUDRequestPrDispCtgBase","description":"CUD List"}}},"RealGridCUDRequestPrDispCtgBase":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v2/display/display-category/{dispCtgNo}/categories":{"get":{"tags":["Display Category Management"],"summary":"Retrieve Display Category List","description":"## Function Description\n* Retrieves the sub display category list of the display category by display category number.\n---\n## Detailed Description\n* [BO] Display > Category Management > Display Category Management > Sub Display Category List grid area\n* Retrieves the sub display categories and total count of the display category displayed in the grid when a display category is selected on the Display Category Management page.\n* Sorted in ascending order by display order and descending order by modification date and time.\n","operationId":"getCategoryList","parameters":[{"name":"dispCtgNo","in":"path","description":"Display Category No.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sub Display Category List Inquiry Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrDispCtgBase"}}}},"900":{"description":"Sub Display Category List Inquiry Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}} ``` ## Retrieve Full Display Category List > \## Function Description\ > \* Retrieves the full display category list.\ > \---\ > \## Detailed Description\ > \* \[BO] Display > Category Management > Display Category Management > Display Category Inquiry Tree area\ > \* Retrieves the full display category list to display categories in a tree structure on the Display Category Management page.\ > \* Retrieved in ascending order of Parent Display Category No. and display order, and descending order of modification date and time.\ > \---\ > \### Code Reference\ > \* \`\`\` Usage Status \`\`\` : Y,N
````json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PrDispCtgBase":{"type":"object","description":"Display Category Basic","properties":{"siteNo":{"type":"string","description":"Site No."},"dispCtgNo":{"type":"string","description":"Display Category No."},"dpmlNo":{"type":"string","description":"Mall No."},"dispSeq":{"type":"integer","format":"int32","description":"Display Order"},"useYn":{"type":"string","description":"Usage Status"},"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"},"dispCtgNm":{"type":"string","description":"Display Category Name"},"multiDispCtgNm":{"type":"string","description":"Display Category Name (Multilingual)"},"dpmlNm":{"type":"string","description":"Display Mall Name","readOnly":true},"siteNm":{"type":"string","description":"Site Name","readOnly":true},"lrgCtgNm":{"type":"string","description":"Large Category Name","readOnly":true},"midCtgNm":{"type":"string","description":"Medium Category Name","readOnly":true},"smlCtgNm":{"type":"string","description":"Small Category Name","readOnly":true},"thnCtgNm":{"type":"string","description":"Detail Category Name","readOnly":true},"shopNo":{"type":"string","description":"Store No.","readOnly":true},"prtTypCd":{"type":"string","description":"Output Type Code","readOnly":true},"hierarchyText":{"type":"string","description":"Hierarchy Structure Text","readOnly":true},"leafCtgYnChangePossible":{"type":"string","description":"Whether Leaf Standard Classification Status Can Be Changed","readOnly":true},"realGridCUD":{"$ref":"#/components/schemas/RealGridCUDRequestPrDispCtgBase","description":"CUD List"}}},"RealGridCUDRequestPrDispCtgBase":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/PrDispCtgBase"}}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v2/display/display-category/tree":{"get":{"tags":["Display Category Management"],"summary":"Retrieve Full Display Category List","description":"## Function Description\n* Retrieves the full display category list.\n---\n## Detailed Description\n* [BO] Display > Category Management > Display Category Management > Display Category Inquiry Tree area\n* Retrieves the full display category list to display categories in a tree structure on the Display Category Management page.\n* Retrieved in ascending order of Parent Display Category No. and display order, and descending order of modification date and time.\n---\n### Code Reference\n* ``` Usage Status ``` : Y,N\n","operationId":"getCategoryTreeList","parameters":[{"name":"siteNo","in":"query","description":"Site No.","required":true,"schema":{"type":"string"}},{"name":"dpmlNo","in":"query","description":"Display Mall No.","required":true,"schema":{"type":"string"}},{"name":"useYn","in":"query","description":"Usage Status","schema":{"type":"string"}}],"responses":{"200":{"description":"Display Category Management List Inquiry Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrDispCtgBase"}}}},"900":{"description":"Display Category Management List Inquiry Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}} ```` ## Check Display Category Deletable Status > \## Function Description\ > \* Checks whether a display category can be deleted, by display category number.\ > \---\ > \## Detailed Description\ > \* \[BO] Display > Category Management > Display Category Management > Sub Display Category List grid area\ > \* Checks whether deletion is possible when deleting a display category in the sub display category list grid.\ > \* A display category can only be deleted if none of the following 1, 2, 3 apply.\ > 1\) Whether it has sub display categories\ > 2\) Whether products are registered\ > 3\) Whether it is linked to a standard category
```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v2/display/display-category/getCheckDisplayCategoryDelete":{"get":{"tags":["Display Category Management"],"summary":"Check Display Category Deletable Status","description":"## Function Description\n* Checks whether a display category can be deleted, by display category number.\n---\n## Detailed Description\n* [BO] Display > Category Management > Display Category Management > Sub Display Category List grid area\n* Checks whether deletion is possible when deleting a display category in the sub display category list grid.\n* A display category can only be deleted if none of the following 1, 2, 3 apply.\n 1) Whether it has sub display categories\n 2) Whether products are registered\n 3) Whether it is linked to a standard category\n","operationId":"getCheckStandardCategoryDelete_1","parameters":[{"name":"dispCtgNo","in":"query","description":"Display Category No.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Display Category Deletion Availability Check Success","content":{"application/json":{"schema":{"type":"boolean"}}}},"900":{"description":"Display Category Deletion Availability Check Failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}} ```