Display Category Management

Retrieve Display Category Basic Information

get

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

dispCtgNostringRequired

Display Category No.

Example: 447

Responses

200

Display Category Basic Information Inquiry Successful

application/json

Display Category Basic

siteNostringOptional

Site No.

Example: 1

dispCtgNostringOptional

Display Category No.

Example: 992

dpmlNostringOptional

Mall No.

Example: 10001

dispSeqinteger · int32Optional

Display Order

Example: 1

useYnstringOptional

Usage Status

Example: N

uprDispCtgNostringOptional

Parent Display Category No.

Example: 972

lrgCtgNostringOptional

Large Category No.

Example: 932

midCtgNostringOptional

Middle Category No.

Example: 962

smlCtgNostringOptional

Sub Category No.

Example: 972

thnCtgNostringOptional

Detail Category No.

Example: 992

leafYnstringOptional

Lowest-Level Status

Example: N

dispCtgNmstringOptional

Display Category Name

Example: 아우터

multiDispCtgNmstringOptional

Display Category Name (Multilingual)

Example: Outer

dpmlNmstringRead-onlyOptional

Display Mall Name

Example: 통합몰

siteNmstringRead-onlyOptional

Site Name

Example: 플래티어 닷컴

lrgCtgNmstringRead-onlyOptional

Large Category Name

Example: 기타

midCtgNmstringRead-onlyOptional

Medium Category Name

Example: 컬처

smlCtgNmstringRead-onlyOptional

Small Category Name

Example: 아트

thnCtgNmstringRead-onlyOptional

Detail Category Name

Example: 굿즈/오브제

shopNostringRead-onlyOptional

Store No.

prtTypCdstringRead-onlyOptional

Output Type Code

hierarchyTextstringRead-onlyOptional

Hierarchy Structure Text

Example: 기타 > 컬처 > 아트 > 굿즈/오브제

leafCtgYnChangePossiblestringRead-onlyOptional

Whether Leaf Standard Classification Status Can Be Changed

Example: N

900

Display Category Basic Information Inquiry Failed

application/json

get/v2/display/display-category/{dispCtgNo}

GET /api/bo/v2/display/display-category/{dispCtgNo} HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "siteNo": 1,
  "dispCtgNo": 992,
  "dpmlNo": 10001,
  "dispSeq": 1,
  "useYn": "N",
  "uprDispCtgNo": 972,
  "lrgCtgNo": 932,
  "midCtgNo": 962,
  "smlCtgNo": 972,
  "thnCtgNo": 992,
  "leafYn": "N",
  "dispCtgNm": "아우터",
  "multiDispCtgNm": "Outer",
  "dpmlNm": "통합몰",
  "siteNm": "플래티어 닷컴",
  "lrgCtgNm": "기타",
  "midCtgNm": "컬처",
  "smlCtgNm": "아트",
  "thnCtgNm": "굿즈/오브제",
  "shopNo": "text",
  "prtTypCd": "text",
  "hierarchyText": "기타 > 컬처 > 아트 > 굿즈/오브제",
  "leafCtgYnChangePossible": "N",
  "realGridCUD": {
    "all": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "dpmlNm": "통합몰",
        "siteNm": "플래티어 닷컴",
        "lrgCtgNm": "기타",
        "midCtgNm": "컬처",
        "smlCtgNm": "아트",
        "thnCtgNm": "굿즈/오브제",
        "shopNo": "text",
        "prtTypCd": "text",
        "hierarchyText": "기타 > 컬처 > 아트 > 굿즈/오브제",
        "leafCtgYnChangePossible": "N",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "create": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "dpmlNm": "통합몰",
        "siteNm": "플래티어 닷컴",
        "lrgCtgNm": "기타",
        "midCtgNm": "컬처",
        "smlCtgNm": "아트",
        "thnCtgNm": "굿즈/오브제",
        "shopNo": "text",
        "prtTypCd": "text",
        "hierarchyText": "기타 > 컬처 > 아트 > 굿즈/오브제",
        "leafCtgYnChangePossible": "N",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "update": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "dpmlNm": "통합몰",
        "siteNm": "플래티어 닷컴",
        "lrgCtgNm": "기타",
        "midCtgNm": "컬처",
        "smlCtgNm": "아트",
        "thnCtgNm": "굿즈/오브제",
        "shopNo": "text",
        "prtTypCd": "text",
        "hierarchyText": "기타 > 컬처 > 아트 > 굿즈/오브제",
        "leafCtgYnChangePossible": "N",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "delete": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "dpmlNm": "통합몰",
        "siteNm": "플래티어 닷컴",
        "lrgCtgNm": "기타",
        "midCtgNm": "컬처",
        "smlCtgNm": "아트",
        "thnCtgNm": "굿즈/오브제",
        "shopNo": "text",
        "prtTypCd": "text",
        "hierarchyText": "기타 > 컬처 > 아트 > 굿즈/오브제",
        "leafCtgYnChangePossible": "N",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ]
  }
}

Modify Display Category Basic Information

put

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

dispCtgNostringRequired

Display Category No.

Example: 447

Body

Display Category Basic

siteNostringOptional

Site No.

Example: 1

dispCtgNostringOptional

Display Category No.

Example: 992

dpmlNostringOptional

Mall No.

Example: 10001

dispSeqinteger · int32Optional

Display Order

Example: 1

useYnstringOptional

Usage Status

Example: N

uprDispCtgNostringOptional

Parent Display Category No.

Example: 972

lrgCtgNostringOptional

Large Category No.

Example: 932

midCtgNostringOptional

Middle Category No.

Example: 962

smlCtgNostringOptional

Sub Category No.

Example: 972

thnCtgNostringOptional

Detail Category No.

Example: 992

leafYnstringOptional

Lowest-Level Status

Example: N

dispCtgNmstringOptional

Display Category Name

Example: 아우터

multiDispCtgNmstringOptional

Display Category Name (Multilingual)

Example: Outer

dpmlNmstringRead-onlyOptional

Display Mall Name

Example: 통합몰

siteNmstringRead-onlyOptional

Site Name

Example: 플래티어 닷컴

lrgCtgNmstringRead-onlyOptional

Large Category Name

Example: 기타

midCtgNmstringRead-onlyOptional

Medium Category Name

Example: 컬처

smlCtgNmstringRead-onlyOptional

Small Category Name

Example: 아트

thnCtgNmstringRead-onlyOptional

Detail Category Name

Example: 굿즈/오브제

shopNostringRead-onlyOptional

Store No.

prtTypCdstringRead-onlyOptional

Output Type Code

hierarchyTextstringRead-onlyOptional

Hierarchy Structure Text

Example: 기타 > 컬처 > 아트 > 굿즈/오브제

leafCtgYnChangePossiblestringRead-onlyOptional

Whether Leaf Standard Classification Status Can Be Changed

Example: N

Responses

200

Display Category Basic Information Modification Successful

application/json

stringOptional

900

Display Category Basic Information Modification Failed

application/json

put/v2/display/display-category/{dispCtgNo}

PUT /api/bo/v2/display/display-category/{dispCtgNo} HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1697

{
  "siteNo": 1,
  "dispCtgNo": 992,
  "dpmlNo": 10001,
  "dispSeq": 1,
  "useYn": "N",
  "uprDispCtgNo": 972,
  "lrgCtgNo": 932,
  "midCtgNo": 962,
  "smlCtgNo": 972,
  "thnCtgNo": 992,
  "leafYn": "N",
  "dispCtgNm": "아우터",
  "multiDispCtgNm": "Outer",
  "realGridCUD": {
    "all": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "create": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "update": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "delete": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ]
  }
}

text

Register Display Category Basic Information

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Display Category Basic

siteNostringOptional

Site No.

Example: 1

dispCtgNostringOptional

Display Category No.

Example: 992

dpmlNostringOptional

Mall No.

Example: 10001

dispSeqinteger · int32Optional

Display Order

Example: 1

useYnstringOptional

Usage Status

Example: N

uprDispCtgNostringOptional

Parent Display Category No.

Example: 972

lrgCtgNostringOptional

Large Category No.

Example: 932

midCtgNostringOptional

Middle Category No.

Example: 962

smlCtgNostringOptional

Sub Category No.

Example: 972

thnCtgNostringOptional

Detail Category No.

Example: 992

leafYnstringOptional

Lowest-Level Status

Example: N

dispCtgNmstringOptional

Display Category Name

Example: 아우터

multiDispCtgNmstringOptional

Display Category Name (Multilingual)

Example: Outer

dpmlNmstringRead-onlyOptional

Display Mall Name

Example: 통합몰

siteNmstringRead-onlyOptional

Site Name

Example: 플래티어 닷컴

lrgCtgNmstringRead-onlyOptional

Large Category Name

Example: 기타

midCtgNmstringRead-onlyOptional

Medium Category Name

Example: 컬처

smlCtgNmstringRead-onlyOptional

Small Category Name

Example: 아트

thnCtgNmstringRead-onlyOptional

Detail Category Name

Example: 굿즈/오브제

shopNostringRead-onlyOptional

Store No.

prtTypCdstringRead-onlyOptional

Output Type Code

hierarchyTextstringRead-onlyOptional

Hierarchy Structure Text

Example: 기타 > 컬처 > 아트 > 굿즈/오브제

leafCtgYnChangePossiblestringRead-onlyOptional

Whether Leaf Standard Classification Status Can Be Changed

Example: N

Responses

200

Display Category Basic Information Registration Successful

application/json

stringOptional

900

Display Category Basic Information Registration Failed

application/json

post/v2/display/display-category

POST /api/bo/v2/display/display-category HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1697

{
  "siteNo": 1,
  "dispCtgNo": 992,
  "dpmlNo": 10001,
  "dispSeq": 1,
  "useYn": "N",
  "uprDispCtgNo": 972,
  "lrgCtgNo": 932,
  "midCtgNo": 962,
  "smlCtgNo": 972,
  "thnCtgNo": 992,
  "leafYn": "N",
  "dispCtgNm": "아우터",
  "multiDispCtgNm": "Outer",
  "realGridCUD": {
    "all": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "create": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "update": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "delete": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ]
  }
}

text

Retrieve Display Product List

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

dispCtgNostringRequired

Display Category No.

Example: 992

Query parameters

rowsPerPagestringRequired

Rows per Page

Example: 100

pageIdxstringRequired

Current Page

Example: 1

Responses

200

Display Product List Inquiry Successful

application/json

Display Category Basic_Product Information

goodsNostringOptional

Product No.

Example: 10002042

dispCtgNostringOptional

Display Category No.

Example: 242

dispYnstringOptional

Display Status

Example: Y

errorMessagestringRead-onlyOptional

Error Message

goodsListstring[]Optional

Product No. List

goodsArraystring[]Optional

Product No. Array

itemListstring[]Optional

SKU No. List

itemArraystring[]Optional

SKU No. Array

goodsNmstringRead-onlyOptional

Product Name

goodsTypCdstringRead-onlyOptional

Product Type

norPrcnumberRead-onlyOptional

Regular Price

salePrcnumberRead-onlyOptional

Selling Price

saleStatCdstringRead-onlyOptional

Sales Status

entrNmstringRead-onlyOptional

Vendor Name

goodsImgstringRead-onlyOptional

Product Image

moodTagValstringRead-onlyOptional

Mood

wghtstringRead-onlyOptional

Weight

900

Display Product List Inquiry Failed

application/json

get/v2/display/display-category/{dispCtgNo}/goods

GET /api/bo/v2/display/display-category/{dispCtgNo}/goods?rowsPerPage=text&pageIdx=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "goodsNo": 10002042,
  "dispCtgNo": 242,
  "dispYn": "Y",
  "errorMessage": "text",
  "goodsList": [
    "text"
  ],
  "goodsArray": [
    "text"
  ],
  "itemList": [
    "text"
  ],
  "itemArray": [
    "text"
  ],
  "goodsNm": "text",
  "goodsTypCd": "text",
  "norPrc": 1,
  "salePrc": 1,
  "saleStatCd": "text",
  "entrNm": "text",
  "goodsImg": "text",
  "moodTagVal": "text",
  "wght": "text"
}

Save Display Product List

post

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 *

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

dispCtgNostringRequired

Display Category No.

Example: 992

Body

Responses

200

Display Product List Save Successful

application/json

stringOptional

900

Display Product List Save Failed

application/json

post/v2/display/display-category/{dispCtgNo}/goods

POST /api/bo/v2/display/display-category/{dispCtgNo}/goods HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 578

{
  "all": [
    {
      "goodsNo": 10002042,
      "dispCtgNo": 242,
      "dispYn": "Y",
      "goodsList": [
        "text"
      ],
      "goodsArray": [
        "text"
      ],
      "itemList": [
        "text"
      ],
      "itemArray": [
        "text"
      ]
    }
  ],
  "create": [
    {
      "goodsNo": 10002042,
      "dispCtgNo": 242,
      "dispYn": "Y",
      "goodsList": [
        "text"
      ],
      "goodsArray": [
        "text"
      ],
      "itemList": [
        "text"
      ],
      "itemArray": [
        "text"
      ]
    }
  ],
  "update": [
    {
      "goodsNo": 10002042,
      "dispCtgNo": 242,
      "dispYn": "Y",
      "goodsList": [
        "text"
      ],
      "goodsArray": [
        "text"
      ],
      "itemList": [
        "text"
      ],
      "itemArray": [
        "text"
      ]
    }
  ],
  "delete": [
    {
      "goodsNo": 10002042,
      "dispCtgNo": 242,
      "dispYn": "Y",
      "goodsList": [
        "text"
      ],
      "goodsArray": [
        "text"
      ],
      "itemList": [
        "text"
      ],
      "itemArray": [
        "text"
      ]
    }
  ]
}

text

Excel Display Product List Bulk Save

post

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 *

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

dispCtgNostringRequired

Display Category No.

Example: 447

Body

dispCtgNostringOptional

Product No.

Example: 10002042

Responses

200

Excel Display Product List Bulk Save Successful

application/json

Display Category Basic_Product Information

goodsNostringOptional

Product No.

Example: 10002042

dispCtgNostringOptional

Display Category No.

Example: 242

dispYnstringOptional

Display Status

Example: Y

errorMessagestringRead-onlyOptional

Error Message

goodsListstring[]Optional

Product No. List

goodsArraystring[]Optional

Product No. Array

itemListstring[]Optional

SKU No. List

itemArraystring[]Optional

SKU No. Array

goodsNmstringRead-onlyOptional

Product Name

goodsTypCdstringRead-onlyOptional

Product Type

norPrcnumberRead-onlyOptional

Regular Price

salePrcnumberRead-onlyOptional

Selling Price

saleStatCdstringRead-onlyOptional

Sales Status

entrNmstringRead-onlyOptional

Vendor Name

goodsImgstringRead-onlyOptional

Product Image

moodTagValstringRead-onlyOptional

Mood

wghtstringRead-onlyOptional

Weight

900

Excel Display Product List Bulk Save Failed

application/json

post/v2/display/display-category/{dispCtgNo}/excel

POST /api/bo/v2/display/display-category/{dispCtgNo}/excel HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 177

{
  "dispCtgNo": 10002042,
  "displayGoodsList": [
    {
      "goodsNo": 10002042,
      "dispCtgNo": 242,
      "dispYn": "Y",
      "goodsList": [
        "text"
      ],
      "goodsArray": [
        "text"
      ],
      "itemList": [
        "text"
      ],
      "itemArray": [
        "text"
      ]
    }
  ]
}

{
  "goodsNo": 10002042,
  "dispCtgNo": 242,
  "dispYn": "Y",
  "errorMessage": "text",
  "goodsList": [
    "text"
  ],
  "goodsArray": [
    "text"
  ],
  "itemList": [
    "text"
  ],
  "itemArray": [
    "text"
  ],
  "goodsNm": "text",
  "goodsTypCd": "text",
  "norPrc": 1,
  "salePrc": 1,
  "saleStatCd": "text",
  "entrNm": "text",
  "goodsImg": "text",
  "moodTagVal": "text",
  "wght": "text"
}

Retrieve Display Category Name Multilingual List

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

dispCtgNoListarrayRequired

Display Category No. List

multiLangCdstringRequired

Multilingual Language Code

Example: en

Responses

200

Display Category Name Multilingual List Inquiry Successful

application/json

Display Category Basic

siteNostringOptional

Site No.

Example: 1

dispCtgNostringOptional

Display Category No.

Example: 992

dpmlNostringOptional

Mall No.

Example: 10001

dispSeqinteger · int32Optional

Display Order

Example: 1

useYnstringOptional

Usage Status

Example: N

uprDispCtgNostringOptional

Parent Display Category No.

Example: 972

lrgCtgNostringOptional

Large Category No.

Example: 932

midCtgNostringOptional

Middle Category No.

Example: 962

smlCtgNostringOptional

Sub Category No.

Example: 972

thnCtgNostringOptional

Detail Category No.

Example: 992

leafYnstringOptional

Lowest-Level Status

Example: N

dispCtgNmstringOptional

Display Category Name

Example: 아우터

multiDispCtgNmstringOptional

Display Category Name (Multilingual)

Example: Outer

dpmlNmstringRead-onlyOptional

Display Mall Name

Example: 통합몰

siteNmstringRead-onlyOptional

Site Name

Example: 플래티어 닷컴

lrgCtgNmstringRead-onlyOptional

Large Category Name

Example: 기타

midCtgNmstringRead-onlyOptional

Medium Category Name

Example: 컬처

smlCtgNmstringRead-onlyOptional

Small Category Name

Example: 아트

thnCtgNmstringRead-onlyOptional

Detail Category Name

Example: 굿즈/오브제

shopNostringRead-onlyOptional

Store No.

prtTypCdstringRead-onlyOptional

Output Type Code

hierarchyTextstringRead-onlyOptional

Hierarchy Structure Text

Example: 기타 > 컬처 > 아트 > 굿즈/오브제

leafCtgYnChangePossiblestringRead-onlyOptional

Whether Leaf Standard Classification Status Can Be Changed

Example: N

900

Display Category Name Multilingual List Inquiry Failed

application/json

get/v2/display/display-category/multi-lang

GET /api/bo/v2/display/display-category/multi-lang?dispCtgNoList=undefined&multiLangCd=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "siteNo": 1,
  "dispCtgNo": 992,
  "dpmlNo": 10001,
  "dispSeq": 1,
  "useYn": "N",
  "uprDispCtgNo": 972,
  "lrgCtgNo": 932,
  "midCtgNo": 962,
  "smlCtgNo": 972,
  "thnCtgNo": 992,
  "leafYn": "N",
  "dispCtgNm": "아우터",
  "multiDispCtgNm": "Outer",
  "dpmlNm": "통합몰",
  "siteNm": "플래티어 닷컴",
  "lrgCtgNm": "기타",
  "midCtgNm": "컬처",
  "smlCtgNm": "아트",
  "thnCtgNm": "굿즈/오브제",
  "shopNo": "text",
  "prtTypCd": "text",
  "hierarchyText": "기타 > 컬처 > 아트 > 굿즈/오브제",
  "leafCtgYnChangePossible": "N",
  "realGridCUD": {
    "all": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "dpmlNm": "통합몰",
        "siteNm": "플래티어 닷컴",
        "lrgCtgNm": "기타",
        "midCtgNm": "컬처",
        "smlCtgNm": "아트",
        "thnCtgNm": "굿즈/오브제",
        "shopNo": "text",
        "prtTypCd": "text",
        "hierarchyText": "기타 > 컬처 > 아트 > 굿즈/오브제",
        "leafCtgYnChangePossible": "N",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "create": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "dpmlNm": "통합몰",
        "siteNm": "플래티어 닷컴",
        "lrgCtgNm": "기타",
        "midCtgNm": "컬처",
        "smlCtgNm": "아트",
        "thnCtgNm": "굿즈/오브제",
        "shopNo": "text",
        "prtTypCd": "text",
        "hierarchyText": "기타 > 컬처 > 아트 > 굿즈/오브제",
        "leafCtgYnChangePossible": "N",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "update": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "dpmlNm": "통합몰",
        "siteNm": "플래티어 닷컴",
        "lrgCtgNm": "기타",
        "midCtgNm": "컬처",
        "smlCtgNm": "아트",
        "thnCtgNm": "굿즈/오브제",
        "shopNo": "text",
        "prtTypCd": "text",
        "hierarchyText": "기타 > 컬처 > 아트 > 굿즈/오브제",
        "leafCtgYnChangePossible": "N",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "delete": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "dpmlNm": "통합몰",
        "siteNm": "플래티어 닷컴",
        "lrgCtgNm": "기타",
        "midCtgNm": "컬처",
        "smlCtgNm": "아트",
        "thnCtgNm": "굿즈/오브제",
        "shopNo": "text",
        "prtTypCd": "text",
        "hierarchyText": "기타 > 컬처 > 아트 > 굿즈/오브제",
        "leafCtgYnChangePossible": "N",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ]
  }
}

Save Display Category Name Multilingual

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

langCdstringOptional

sysRegIdstringOptional

Registrant ID

sysModIdstringOptional

Modifier ID

Responses

200

Sub Display Category Name Multilingual Save Successful

application/json

stringOptional

900

Sub Display Category Name Multilingual Save Failed

application/json

post/v2/display/display-category/multi-lang

POST /api/bo/v2/display/display-category/multi-lang HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1926

{
  "realGridCUD": {
    "all": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "create": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "update": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "delete": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ]
  },
  "langCd": "text",
  "displayCategoryMlList": [
    {
      "siteNo": 1,
      "dispCtgNo": 992,
      "dpmlNo": 10001,
      "dispSeq": 1,
      "useYn": "N",
      "uprDispCtgNo": 972,
      "lrgCtgNo": 932,
      "midCtgNo": 962,
      "smlCtgNo": 972,
      "thnCtgNo": 992,
      "leafYn": "N",
      "dispCtgNm": "아우터",
      "multiDispCtgNm": "Outer",
      "realGridCUD": {
        "all": [
          "[Circular Reference]"
        ],
        "create": [
          "[Circular Reference]"
        ],
        "update": [
          "[Circular Reference]"
        ],
        "delete": [
          "[Circular Reference]"
        ]
      }
    }
  ],
  "sysRegId": "text",
  "sysModId": "text"
}

text

Check Display Category List Deletable Status

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject · PrDispCtgSearch[]

Display Category Search Model

siteNostringOptional

Site No.

Example: 1

dispCtgNostringOptional

Display Category No.

Example: 447

dpmlNostringOptional

Mall No.

Example: 10001

useYnstringOptional

Usage Status

Example: Y

dispYnstringOptional

Display Status

Example: Y

dispCtgNoListstring[]Optional

Display Category No. List

dispCtgNmstringOptional

Display Category Name

Example: 10001

multiLangCdstringOptional

Multilingual Language Code

Example: en

Responses

200

Display Category Deletion Availability Check Success

application/json

booleanOptional

900

Display Category Deletion Availability Check Failure

application/json

post/v2/display/display-category/getCheckDisplayCategoryListDelete

POST /api/bo/v2/display/display-category/getCheckDisplayCategoryListDelete HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 132

[
  {
    "siteNo": 1,
    "dispCtgNo": 447,
    "dpmlNo": 10001,
    "useYn": "Y",
    "dispYn": "Y",
    "dispCtgNoList": [
      "text"
    ],
    "dispCtgNm": 10001,
    "multiLangCd": "en"
  }
]

true

Save Sub Display Category List

post

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 *

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Display Category Basic

siteNostringOptional

Site No.

Example: 1

dispCtgNostringOptional

Display Category No.

Example: 992

dpmlNostringOptional

Mall No.

Example: 10001

dispSeqinteger · int32Optional

Display Order

Example: 1

useYnstringOptional

Usage Status

Example: N

uprDispCtgNostringOptional

Parent Display Category No.

Example: 972

lrgCtgNostringOptional

Large Category No.

Example: 932

midCtgNostringOptional

Middle Category No.

Example: 962

smlCtgNostringOptional

Sub Category No.

Example: 972

thnCtgNostringOptional

Detail Category No.

Example: 992

leafYnstringOptional

Lowest-Level Status

Example: N

dispCtgNmstringOptional

Display Category Name

Example: 아우터

multiDispCtgNmstringOptional

Display Category Name (Multilingual)

Example: Outer

dpmlNmstringRead-onlyOptional

Display Mall Name

Example: 통합몰

siteNmstringRead-onlyOptional

Site Name

Example: 플래티어 닷컴

lrgCtgNmstringRead-onlyOptional

Large Category Name

Example: 기타

midCtgNmstringRead-onlyOptional

Medium Category Name

Example: 컬처

smlCtgNmstringRead-onlyOptional

Small Category Name

Example: 아트

thnCtgNmstringRead-onlyOptional

Detail Category Name

Example: 굿즈/오브제

shopNostringRead-onlyOptional

Store No.

prtTypCdstringRead-onlyOptional

Output Type Code

hierarchyTextstringRead-onlyOptional

Hierarchy Structure Text

Example: 기타 > 컬처 > 아트 > 굿즈/오브제

leafCtgYnChangePossiblestringRead-onlyOptional

Whether Leaf Standard Classification Status Can Be Changed

Example: N

Responses

200

Sub Display Category List Save Successful

application/json

stringOptional

900

Sub Display Category List Save Failed

application/json

post/v2/display/display-category/categories

POST /api/bo/v2/display/display-category/categories HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1697

{
  "siteNo": 1,
  "dispCtgNo": 992,
  "dpmlNo": 10001,
  "dispSeq": 1,
  "useYn": "N",
  "uprDispCtgNo": 972,
  "lrgCtgNo": 932,
  "midCtgNo": 962,
  "smlCtgNo": 972,
  "thnCtgNo": 992,
  "leafYn": "N",
  "dispCtgNm": "아우터",
  "multiDispCtgNm": "Outer",
  "realGridCUD": {
    "all": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "create": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "update": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "delete": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ]
  }
}

text

Retrieve Display Product List

get

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

dispCtgNostringRequired

Display Category No.

Example: 992

Query parameters

goodsArrayarrayRequired

Display Product Number Array

Responses

200

Display Product List Detail Inquiry Successful

application/json

Display Category Basic_Product Information

goodsNostringOptional

Product No.

Example: 10002042

dispCtgNostringOptional

Display Category No.

Example: 242

dispYnstringOptional

Display Status

Example: Y

errorMessagestringRead-onlyOptional

Error Message

goodsListstring[]Optional

Product No. List

goodsArraystring[]Optional

Product No. Array

itemListstring[]Optional

SKU No. List

itemArraystring[]Optional

SKU No. Array

goodsNmstringRead-onlyOptional

Product Name

goodsTypCdstringRead-onlyOptional

Product Type

norPrcnumberRead-onlyOptional

Regular Price

salePrcnumberRead-onlyOptional

Selling Price

saleStatCdstringRead-onlyOptional

Sales Status

entrNmstringRead-onlyOptional

Vendor Name

goodsImgstringRead-onlyOptional

Product Image

moodTagValstringRead-onlyOptional

Mood

wghtstringRead-onlyOptional

Weight

900

Display Product List Detail Inquiry Failed

application/json

get/v2/display/display-category/{dispCtgNo}/goods/valid

GET /api/bo/v2/display/display-category/{dispCtgNo}/goods/valid?goodsArray=undefined HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "goodsNo": 10002042,
  "dispCtgNo": 242,
  "dispYn": "Y",
  "errorMessage": "text",
  "goodsList": [
    "text"
  ],
  "goodsArray": [
    "text"
  ],
  "itemList": [
    "text"
  ],
  "itemArray": [
    "text"
  ],
  "goodsNm": "text",
  "goodsTypCd": "text",
  "norPrc": 1,
  "salePrc": 1,
  "saleStatCd": "text",
  "entrNm": "text",
  "goodsImg": "text",
  "moodTagVal": "text",
  "wght": "text"
}

Retrieve Validity of Bulk-Registered Display Products

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

dispCtgNostringRequired

Display Category No.

Example: 992

Query parameters

goodsArrarrayRequired

Product No.

Example: [10118759]

Responses

200

Bulk-Registered Display Product Validity Inquiry Successful

application/json

Display Category Basic_Product Information

goodsNostringOptional

Product No.

Example: 10002042

dispCtgNostringOptional

Display Category No.

Example: 242

dispYnstringOptional

Display Status

Example: Y

errorMessagestringRead-onlyOptional

Error Message

goodsListstring[]Optional

Product No. List

goodsArraystring[]Optional

Product No. Array

itemListstring[]Optional

SKU No. List

itemArraystring[]Optional

SKU No. Array

goodsNmstringRead-onlyOptional

Product Name

goodsTypCdstringRead-onlyOptional

Product Type

norPrcnumberRead-onlyOptional

Regular Price

salePrcnumberRead-onlyOptional

Selling Price

saleStatCdstringRead-onlyOptional

Sales Status

entrNmstringRead-onlyOptional

Vendor Name

goodsImgstringRead-onlyOptional

Product Image

moodTagValstringRead-onlyOptional

Mood

wghtstringRead-onlyOptional

Weight

900

Bulk-Registered Display Product Validity Inquiry Failed

application/json

get/v2/display/display-category/{dispCtgNo}/excel/valid

GET /api/bo/v2/display/display-category/{dispCtgNo}/excel/valid?goodsArr=undefined HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "goodsNo": 10002042,
  "dispCtgNo": 242,
  "dispYn": "Y",
  "errorMessage": "text",
  "goodsList": [
    "text"
  ],
  "goodsArray": [
    "text"
  ],
  "itemList": [
    "text"
  ],
  "itemArray": [
    "text"
  ],
  "goodsNm": "text",
  "goodsTypCd": "text",
  "norPrc": 1,
  "salePrc": 1,
  "saleStatCd": "text",
  "entrNm": "text",
  "goodsImg": "text",
  "moodTagVal": "text",
  "wght": "text"
}

Retrieve Display Category List

get

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

dispCtgNostringRequired

Display Category No.

Example: 932

Responses

200

Sub Display Category List Inquiry Successful

application/json

Display Category Basic

siteNostringOptional

Site No.

Example: 1

dispCtgNostringOptional

Display Category No.

Example: 992

dpmlNostringOptional

Mall No.

Example: 10001

dispSeqinteger · int32Optional

Display Order

Example: 1

useYnstringOptional

Usage Status

Example: N

uprDispCtgNostringOptional

Parent Display Category No.

Example: 972

lrgCtgNostringOptional

Large Category No.

Example: 932

midCtgNostringOptional

Middle Category No.

Example: 962

smlCtgNostringOptional

Sub Category No.

Example: 972

thnCtgNostringOptional

Detail Category No.

Example: 992

leafYnstringOptional

Lowest-Level Status

Example: N

dispCtgNmstringOptional

Display Category Name

Example: 아우터

multiDispCtgNmstringOptional

Display Category Name (Multilingual)

Example: Outer

dpmlNmstringRead-onlyOptional

Display Mall Name

Example: 통합몰

siteNmstringRead-onlyOptional

Site Name

Example: 플래티어 닷컴

lrgCtgNmstringRead-onlyOptional

Large Category Name

Example: 기타

midCtgNmstringRead-onlyOptional

Medium Category Name

Example: 컬처

smlCtgNmstringRead-onlyOptional

Small Category Name

Example: 아트

thnCtgNmstringRead-onlyOptional

Detail Category Name

Example: 굿즈/오브제

shopNostringRead-onlyOptional

Store No.

prtTypCdstringRead-onlyOptional

Output Type Code

hierarchyTextstringRead-onlyOptional

Hierarchy Structure Text

Example: 기타 > 컬처 > 아트 > 굿즈/오브제

leafCtgYnChangePossiblestringRead-onlyOptional

Whether Leaf Standard Classification Status Can Be Changed

Example: N

900

Sub Display Category List Inquiry Failed

application/json

get/v2/display/display-category/{dispCtgNo}/categories

GET /api/bo/v2/display/display-category/{dispCtgNo}/categories HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "siteNo": 1,
  "dispCtgNo": 992,
  "dpmlNo": 10001,
  "dispSeq": 1,
  "useYn": "N",
  "uprDispCtgNo": 972,
  "lrgCtgNo": 932,
  "midCtgNo": 962,
  "smlCtgNo": 972,
  "thnCtgNo": 992,
  "leafYn": "N",
  "dispCtgNm": "아우터",
  "multiDispCtgNm": "Outer",
  "dpmlNm": "통합몰",
  "siteNm": "플래티어 닷컴",
  "lrgCtgNm": "기타",
  "midCtgNm": "컬처",
  "smlCtgNm": "아트",
  "thnCtgNm": "굿즈/오브제",
  "shopNo": "text",
  "prtTypCd": "text",
  "hierarchyText": "기타 > 컬처 > 아트 > 굿즈/오브제",
  "leafCtgYnChangePossible": "N",
  "realGridCUD": {
    "all": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "dpmlNm": "통합몰",
        "siteNm": "플래티어 닷컴",
        "lrgCtgNm": "기타",
        "midCtgNm": "컬처",
        "smlCtgNm": "아트",
        "thnCtgNm": "굿즈/오브제",
        "shopNo": "text",
        "prtTypCd": "text",
        "hierarchyText": "기타 > 컬처 > 아트 > 굿즈/오브제",
        "leafCtgYnChangePossible": "N",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "create": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "dpmlNm": "통합몰",
        "siteNm": "플래티어 닷컴",
        "lrgCtgNm": "기타",
        "midCtgNm": "컬처",
        "smlCtgNm": "아트",
        "thnCtgNm": "굿즈/오브제",
        "shopNo": "text",
        "prtTypCd": "text",
        "hierarchyText": "기타 > 컬처 > 아트 > 굿즈/오브제",
        "leafCtgYnChangePossible": "N",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "update": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "dpmlNm": "통합몰",
        "siteNm": "플래티어 닷컴",
        "lrgCtgNm": "기타",
        "midCtgNm": "컬처",
        "smlCtgNm": "아트",
        "thnCtgNm": "굿즈/오브제",
        "shopNo": "text",
        "prtTypCd": "text",
        "hierarchyText": "기타 > 컬처 > 아트 > 굿즈/오브제",
        "leafCtgYnChangePossible": "N",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "delete": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "dpmlNm": "통합몰",
        "siteNm": "플래티어 닷컴",
        "lrgCtgNm": "기타",
        "midCtgNm": "컬처",
        "smlCtgNm": "아트",
        "thnCtgNm": "굿즈/오브제",
        "shopNo": "text",
        "prtTypCd": "text",
        "hierarchyText": "기타 > 컬처 > 아트 > 굿즈/오브제",
        "leafCtgYnChangePossible": "N",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ]
  }
}

Retrieve Full Display Category List

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

siteNostringRequired

Site No.

Example: 1

dpmlNostringRequired

Display Mall No.

Example: 10001

useYnstringOptional

Usage Status

Example: Y

Responses

200

Display Category Management List Inquiry Successful

application/json

Display Category Basic

siteNostringOptional

Site No.

Example: 1

dispCtgNostringOptional

Display Category No.

Example: 992

dpmlNostringOptional

Mall No.

Example: 10001

dispSeqinteger · int32Optional

Display Order

Example: 1

useYnstringOptional

Usage Status

Example: N

uprDispCtgNostringOptional

Parent Display Category No.

Example: 972

lrgCtgNostringOptional

Large Category No.

Example: 932

midCtgNostringOptional

Middle Category No.

Example: 962

smlCtgNostringOptional

Sub Category No.

Example: 972

thnCtgNostringOptional

Detail Category No.

Example: 992

leafYnstringOptional

Lowest-Level Status

Example: N

dispCtgNmstringOptional

Display Category Name

Example: 아우터

multiDispCtgNmstringOptional

Display Category Name (Multilingual)

Example: Outer

dpmlNmstringRead-onlyOptional

Display Mall Name

Example: 통합몰

siteNmstringRead-onlyOptional

Site Name

Example: 플래티어 닷컴

lrgCtgNmstringRead-onlyOptional

Large Category Name

Example: 기타

midCtgNmstringRead-onlyOptional

Medium Category Name

Example: 컬처

smlCtgNmstringRead-onlyOptional

Small Category Name

Example: 아트

thnCtgNmstringRead-onlyOptional

Detail Category Name

Example: 굿즈/오브제

shopNostringRead-onlyOptional

Store No.

prtTypCdstringRead-onlyOptional

Output Type Code

hierarchyTextstringRead-onlyOptional

Hierarchy Structure Text

Example: 기타 > 컬처 > 아트 > 굿즈/오브제

leafCtgYnChangePossiblestringRead-onlyOptional

Whether Leaf Standard Classification Status Can Be Changed

Example: N

900

Display Category Management List Inquiry Failed

application/json

get/v2/display/display-category/tree

GET /api/bo/v2/display/display-category/tree?siteNo=text&dpmlNo=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "siteNo": 1,
  "dispCtgNo": 992,
  "dpmlNo": 10001,
  "dispSeq": 1,
  "useYn": "N",
  "uprDispCtgNo": 972,
  "lrgCtgNo": 932,
  "midCtgNo": 962,
  "smlCtgNo": 972,
  "thnCtgNo": 992,
  "leafYn": "N",
  "dispCtgNm": "아우터",
  "multiDispCtgNm": "Outer",
  "dpmlNm": "통합몰",
  "siteNm": "플래티어 닷컴",
  "lrgCtgNm": "기타",
  "midCtgNm": "컬처",
  "smlCtgNm": "아트",
  "thnCtgNm": "굿즈/오브제",
  "shopNo": "text",
  "prtTypCd": "text",
  "hierarchyText": "기타 > 컬처 > 아트 > 굿즈/오브제",
  "leafCtgYnChangePossible": "N",
  "realGridCUD": {
    "all": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "dpmlNm": "통합몰",
        "siteNm": "플래티어 닷컴",
        "lrgCtgNm": "기타",
        "midCtgNm": "컬처",
        "smlCtgNm": "아트",
        "thnCtgNm": "굿즈/오브제",
        "shopNo": "text",
        "prtTypCd": "text",
        "hierarchyText": "기타 > 컬처 > 아트 > 굿즈/오브제",
        "leafCtgYnChangePossible": "N",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "create": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "dpmlNm": "통합몰",
        "siteNm": "플래티어 닷컴",
        "lrgCtgNm": "기타",
        "midCtgNm": "컬처",
        "smlCtgNm": "아트",
        "thnCtgNm": "굿즈/오브제",
        "shopNo": "text",
        "prtTypCd": "text",
        "hierarchyText": "기타 > 컬처 > 아트 > 굿즈/오브제",
        "leafCtgYnChangePossible": "N",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "update": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "dpmlNm": "통합몰",
        "siteNm": "플래티어 닷컴",
        "lrgCtgNm": "기타",
        "midCtgNm": "컬처",
        "smlCtgNm": "아트",
        "thnCtgNm": "굿즈/오브제",
        "shopNo": "text",
        "prtTypCd": "text",
        "hierarchyText": "기타 > 컬처 > 아트 > 굿즈/오브제",
        "leafCtgYnChangePossible": "N",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "delete": [
      {
        "siteNo": 1,
        "dispCtgNo": 992,
        "dpmlNo": 10001,
        "dispSeq": 1,
        "useYn": "N",
        "uprDispCtgNo": 972,
        "lrgCtgNo": 932,
        "midCtgNo": 962,
        "smlCtgNo": 972,
        "thnCtgNo": 992,
        "leafYn": "N",
        "dispCtgNm": "아우터",
        "multiDispCtgNm": "Outer",
        "dpmlNm": "통합몰",
        "siteNm": "플래티어 닷컴",
        "lrgCtgNm": "기타",
        "midCtgNm": "컬처",
        "smlCtgNm": "아트",
        "thnCtgNm": "굿즈/오브제",
        "shopNo": "text",
        "prtTypCd": "text",
        "hierarchyText": "기타 > 컬처 > 아트 > 굿즈/오브제",
        "leafCtgYnChangePossible": "N",
        "realGridCUD": {
          "all": [
            "[Circular Reference]"
          ],
          "create": [
            "[Circular Reference]"
          ],
          "update": [
            "[Circular Reference]"
          ],
          "delete": [
            "[Circular Reference]"
          ]
        }
      }
    ]
  }
}

Check Display Category Deletable Status

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

dispCtgNostringRequired

Display Category No.

Example: 932

Responses

200

Display Category Deletion Availability Check Success

application/json

booleanOptional

900

Display Category Deletion Availability Check Failure

application/json

get/v2/display/display-category/getCheckDisplayCategoryDelete

GET /api/bo/v2/display/display-category/getCheckDisplayCategoryDelete?dispCtgNo=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true