Display Category

Retrieve Display Icon List

get

Function Description

This API retrieves the list of display icons.

Detailed Description

Retrieves the display icon information list based on the site number.

Revision History

Release v1.03_231106 : Icon (badge) settings

Query parameters

siteNostringRequired

Site No.

Example: 1

dispMediaCdstringRequired

Display Media Code (DP018)

Example: 20

iconTypCdstringOptional

Icon Type Code (DP001)

Example: 100

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Display icon list retrieved successfully

application/json

Icon DTO

siteNostringOptional

Site

Example: 1

dispIconNostringOptional

Icon No.

Example: 130

iconNmstringOptional

Icon Name

Example: 아이콘명

iconTypCdstringOptional

Icon Type Code

Example: 100:상품,200:게시판,300:이벤트,400:장바구니

pcIconFileNmstringOptional

PC Icon File Name

Example: PC파일명

pcIconPathNmstringOptional

PC Icon Path Name

Example: /PcPath

moIconFileNmstringOptional

MO Icon File Name

Example: MO파일명

moIconPathNmstringOptional

MO Icon Path

Example: /MoPath

get/v1/icon

GET /api/display/v1/icon?siteNo=text&dispMediaCd=text HTTP/1.1
Host: api-display.x2bee.com/
Accept: */*

200

Display icon list retrieved successfully

{
  "siteNo": 1,
  "dispIconNo": 130,
  "iconNm": "아이콘명",
  "iconTypCd": "100:상품,200:게시판,300:이벤트,400:장바구니",
  "pcIconFileNm": "PC파일명",
  "pcIconPathNm": "/PcPath",
  "moIconFileNm": "MO파일명",
  "moIconPathNm": "/MoPath"
}

Retrieve Displayed Products

get

Function Description

This API retrieves the product list.

Detailed Description

If a display category number is passed, retrieves the detailed product information list for the display category.
If a product number is passed, retrieves the detailed information list for the product.
If a page number and page size are passed, the total count (totalCount) is retrieved together.

Query parameters

goodsNoArrstringOptional

Product No. List

Example: 10001741,10001791

dispCtgNostringOptional

Category No.

Example: 10000001

pageNointegerOptional

Page No.

Example: 1

pageSizeintegerOptional

Page Size

Example: 20

sortstringOptional

Sort Code

saleStatCdsstringOptional

Sales Status Code (PR005)

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Displayed products retrieved successfully

application/json

Product DTO

goodsNostringOptional

Product No.

Example: 100000001

goodsNmstringOptional

Product Name

Example: 상품명

entrNostringOptional

Vendor No.

Example: 1000001

goodsCompCdstringOptional

Product Composition Code (PR001) 10: General Product, 20: Bundled Product

Example: 10

goodsTypCdstringOptional

Product Type Code (PR002) 10: General Product, 20: Free Gift, 30: E-Coupon Product

Example: 10

saleMethCdstringOptional

Sales Method Code (PR003) 10: General Sale, 20: Reservation Product

Example: 10

brandNostringOptional

Brand No.

Example: 1000001

brandNmstringOptional

Brand Name

Example: 브랜드명

buyrAgeLmtCdstringOptional

Purchaser Age Restriction Code (PR004) 0: 0, 15: 15

Example: 0

dispYnstringOptional

Display Status

Example: Y

saleStatCdstringOptional

Sales Status Code (PR005) 01: Temporary Save, 02: Pending Approval, 03: Rejected, 10: On Sale, 20: Sold Out, 30: Discontinued

Example: 10

goodsRegDtmstring · date-timeOptional

Product Registration Date/Time

Example: 2021-01-01 00:00:00

saleStrDtmstring · date-timeOptional

Sales Start Date/Time

Example: 2021-01-01 00:00:00

saleEndDtmstring · date-timeOptional

Sales End Date/Time

Example: 2029-01-01 00:00:00

stkMgrYnstringOptional

Inventory Management Status

Example: Y

deliProcTypCdstringOptional

Delivery Processing Type Code (PR008) 10: Center Delivery, 20: Vendor Delivery

Example: 10

deliGoodsGbCdstringOptional

Delivery Product Classification Code (PR010) 01: General Product, 02: Installation Product, 03: Made-to-Order, 04: E-Coupon

Example: 01

deliWayCdstringOptional

Delivery Method Code (PR009) 01: Courier Delivery, 02: No Delivery

Example: 10

deliDdaystringOptional

Delivery Lead Time

Example: 1

deliPolcNostringOptional

Delivery Policy No.

Example: 1

prcHistStrDtmstring · date-timeOptional

Price History Start Date/Time

Example: 2021-01-01 00:00:00

prcHistEndDtmstring · date-timeOptional

Price History End Date/Time

Example: 2029-01-01 00:00:00

rcntSalePrcinteger · int64Optional

Recent Selling Price

Example: 10000

salePrcinteger · int64Optional

Selling Price

Example: 10000

aplyPrcinteger · int64Optional

Applied Price (Display Price)

Example: 10000

dispCtgNostringOptional

Display Category No.

Example: 1

dlexTypCdstringOptional

Delivery Fee Type Code (VD005) 10: Free, 20: Paid, 30: Conditionally Free

Example: 10

goodsImmedDcCpnNostringOptional

Product Instant Discount Coupon No.

Example: 1

goodsImmedDcAplyStrDtmstring · date-timeOptional

Product Instant Discount Application Start Date/Time

Example: 2021-01-01 00:00:00

goodsImmedDcAplyEndDtmstring · date-timeOptional

Product Instant Discount Application End Date/Time

Example: 2029-01-01 00:00:00

goodsRepImgContSnstringOptional

Product Main Image Content Serial No.

Example: 1

rservSaleYnstringOptional

Reservation Sale Status

Example: Y

rservStrDtmstring · date-timeOptional

Reservation Start Date/Time

Example: 2021-01-01 00:00:00

rservEndDtmstring · date-timeOptional

Reservation End Date/Time

Example: 2029-01-01 00:00:00

goodsRevCntstringOptional

Product Review Count

Example: 1

goodsRevHlpfulCntstringOptional

Product Review Helpful Count

Example: 1

goodsRevStarscrAvgValnumber · doubleOptional

Product Review Average Rating

Example: 1

fixamtFxrtGbCdstringOptional

Product Instant Fixed Amount/Rate Type Code (MK005)

Example: 01

dcRateAmtinteger · int64Optional

Product Instant Discount Rate/Amount

dcRateinteger · int64Optional

Product Discount Rate

wishListCntstringOptional

Wishlist Count

Example: 10

goodsRepImgPathNmstringOptional

Representative Image File Path

trnfTextContstringOptional

Representative Image Alt Text

adlCertiYnstringOptional

Adult Verification Status

iconListstring[]Optional

Icon Information

prcTimeDealYnstringOptional

Time Deal Status

get/v1/goods

GET /api/display/v1/goods HTTP/1.1
Host: api-display.x2bee.com/
Accept: */*

200

Displayed products retrieved successfully

{
  "goodsNo": 100000001,
  "goodsNm": "상품명",
  "entrNo": 1000001,
  "goodsCompCd": 10,
  "goodsTypCd": 10,
  "saleMethCd": 10,
  "brandNo": 1000001,
  "brandNm": "브랜드명",
  "buyrAgeLmtCd": 0,
  "dispYn": "Y",
  "saleStatCd": 10,
  "goodsRegDtm": "2021-01-01 00:00:00",
  "saleStrDtm": "2021-01-01 00:00:00",
  "saleEndDtm": "2029-01-01 00:00:00",
  "stkMgrYn": "Y",
  "deliProcTypCd": 10,
  "deliGoodsGbCd": "01",
  "deliWayCd": 10,
  "deliDday": 1,
  "deliPolcNo": 1,
  "prcHistStrDtm": "2021-01-01 00:00:00",
  "prcHistEndDtm": "2029-01-01 00:00:00",
  "rcntSalePrc": 10000,
  "salePrc": 10000,
  "aplyPrc": 10000,
  "dispCtgNo": 1,
  "dlexTypCd": 10,
  "goodsImmedDcCpnNo": 1,
  "goodsImmedDcAplyStrDtm": "2021-01-01 00:00:00",
  "goodsImmedDcAplyEndDtm": "2029-01-01 00:00:00",
  "goodsRepImgContSn": 1,
  "rservSaleYn": "Y",
  "rservStrDtm": "2021-01-01 00:00:00",
  "rservEndDtm": "2029-01-01 00:00:00",
  "goodsRevCnt": 1,
  "goodsRevHlpfulCnt": 1,
  "goodsRevStarscrAvgVal": 1,
  "fixamtFxrtGbCd": "01",
  "dcRateAmt": 1,
  "dcRate": 1,
  "wishListCnt": 10,
  "goodsRepImgPathNm": "text",
  "trnfTextCont": "text",
  "adlCertiYn": "text",
  "iconList": [
    "text"
  ],
  "prcTimeDealYn": "text"
}

Retrieve Display Category List

get

Function Description

Retrieves all display category information or brand display category information.

Detailed Description

All display category information
- If there are no parameters, retrieves all display category information hierarchically (large/medium/small/detail) using subCategoryList.
Brand display category information
- If a brand number (brandNo) is provided as a parameter, retrieves the display category information that the brand's products belong to, hierarchically (large/medium/small/detail) using subCategoryList.

Query parameters

brandNostringOptional

Brand No.

Example: 100001

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Display category information retrieved successfully

application/json

Display Category

dispCtgNostringOptional

Display Category No.

dispCtgNmstringOptional

Display Category Name

dispSeqinteger · int32Optional

Display Order

uprDispCtgNostringOptional

Parent Display Category No.

lrgCtgNostringOptional

Large Category No.

midCtgNostringOptional

Middle Category No.

smlCtgNostringOptional

Sub Category No.

thnCtgNostringOptional

Detail Category No.

leafYnstringOptional

Lowest-Level Status

depthstringOptional

Category Depth

400

Failed to retrieve display category information

application/json

get/v1/displayCategory

GET /api/display/v1/displayCategory HTTP/1.1
Host: api-display.x2bee.com/
Accept: */*

{
  "dispCtgNo": "text",
  "dispCtgNm": "text",
  "dispSeq": 1,
  "uprDispCtgNo": "text",
  "lrgCtgNo": "text",
  "midCtgNo": "text",
  "smlCtgNo": "text",
  "thnCtgNo": "text",
  "leafYn": "text",
  "depth": "text",
  "subCategoryList": [
    {
      "dispCtgNo": "text",
      "dispCtgNm": "text",
      "dispSeq": 1,
      "uprDispCtgNo": "text",
      "lrgCtgNo": "text",
      "midCtgNo": "text",
      "smlCtgNo": "text",
      "thnCtgNo": "text",
      "leafYn": "text",
      "depth": "text",
      "subCategoryList": [
        {
          "dispCtgNo": "text",
          "dispCtgNm": "text",
          "dispSeq": 1,
          "uprDispCtgNo": "text",
          "lrgCtgNo": "text",
          "midCtgNo": "text",
          "smlCtgNo": "text",
          "thnCtgNo": "text",
          "leafYn": "text",
          "depth": "text",
          "subCategoryList": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ]
}

Retrieve Single Display Category

get

Function Description

Retrieves display category information by display category number.

Detailed Description

Single display category information
- Retrieves only the display category information corresponding to the display category number (dispCtgNo) provided as a parameter.
- Since only the information for the given display category number is retrieved, subCategoryList is excluded from the response.

Path parameters

dispCtgNostringRequired

Display Category No.

Example: 444

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Single display category retrieved successfully

application/json

Display Category

dispCtgNostringOptional

Display Category No.

dispCtgNmstringOptional

Display Category Name

dispSeqinteger · int32Optional

Display Order

uprDispCtgNostringOptional

Parent Display Category No.

lrgCtgNostringOptional

Large Category No.

midCtgNostringOptional

Middle Category No.

smlCtgNostringOptional

Sub Category No.

thnCtgNostringOptional

Detail Category No.

leafYnstringOptional

Lowest-Level Status

depthstringOptional

Category Depth

400

Failed to retrieve single display category

application/json

get/v1/displayCategory/{dispCtgNo}

GET /api/display/v1/displayCategory/{dispCtgNo} HTTP/1.1
Host: api-display.x2bee.com/
Accept: */*

{
  "dispCtgNo": "text",
  "dispCtgNm": "text",
  "dispSeq": 1,
  "uprDispCtgNo": "text",
  "lrgCtgNo": "text",
  "midCtgNo": "text",
  "smlCtgNo": "text",
  "thnCtgNo": "text",
  "leafYn": "text",
  "depth": "text",
  "subCategoryList": [
    {
      "dispCtgNo": "text",
      "dispCtgNm": "text",
      "dispSeq": 1,
      "uprDispCtgNo": "text",
      "lrgCtgNo": "text",
      "midCtgNo": "text",
      "smlCtgNo": "text",
      "thnCtgNo": "text",
      "leafYn": "text",
      "depth": "text",
      "subCategoryList": [
        {
          "dispCtgNo": "text",
          "dispCtgNm": "text",
          "dispSeq": 1,
          "uprDispCtgNo": "text",
          "lrgCtgNo": "text",
          "midCtgNo": "text",
          "smlCtgNo": "text",
          "thnCtgNo": "text",
          "leafYn": "text",
          "depth": "text",
          "subCategoryList": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ]
}

PreviousSpecial Exhibition

NextModels

Last updated 1 month ago