Ctrlk
X2BEE 바로가기
For the complete documentation index, see llms.txt. This page is also available as Markdown.

전시카테고리

전시 아이콘 목록 조회

get

기능설명

  • 전시 아이콘 목록을 조회하는 API 입니다.

상세설명

  • 사이트번호 기준으로 전시 아이콘 정보 목록을 조회합니다.

수정번호

  • Release v1.03_231106 : 아이콘(뱃지) 설정

Query parameters
siteNostringRequired

사이트번호

Example: 1
dispMediaCdstringRequired

전시매체코드(DP018)

Example: 20
iconTypCdstringOptional

아이콘유형코드(DP001)

Example: 100
Header parameters
AuthorizationanyOptional

Access Token

Responses
200

전시 아이콘 목록 조회 성공

application/json

아이콘 DTO

siteNostringOptional

사이트

Example: 1
dispIconNostringOptional

아이콘번호

Example: 130
iconNmstringOptional

아이콘명

Example: 아이콘명
iconTypCdstringOptional

아이콘유형코드

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

PC아이콘파일명

Example: PC파일명
pcIconPathNmstringOptional

PC아이콘경로명

Example: /PcPath
moIconFileNmstringOptional

MO아이콘파일명

Example: MO파일명
moIconPathNmstringOptional

Mo아이콘경로명

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

전시 아이콘 목록 조회 성공

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

전시상품 조회

get

기능설명

  • 상품 목록을 조회하는 API 입니다.

상세설명

  • 전시카테고리번호 전달 시 전시카테고리 상품 상세 정보 목록을 조회합니다.

  • 상품번호 전달 시 해당 상품의 상세 정보 목록을 조회합니다.

  • 페이지번호, 페이지사이즈 전달 시 전체 개수(totalCount)를 함께 조회합니다.

Query parameters
goodsNoArrstringOptional

상품번호 리스트

Example: 10001741,10001791
dispCtgNostringOptional

카테고리 번호

Example: 10000001
pageNointegerOptional

페이지번호

Example: 1
pageSizeintegerOptional

페이지사이즈

Example: 20
sortstringOptional

정렬코드

saleStatCdsstringOptional

판매상태코드(PR005)

Header parameters
AuthorizationanyOptional

Access Token

Responses
200

전시상품 조회 성공

application/json

상품 DTO

goodsNostringOptional

상품번호

Example: 100000001
goodsNmstringOptional

상품명

Example: 상품명
entrNostringOptional

협력사번호

Example: 1000001
goodsCompCdstringOptional

상품구성코드(PR001) 10:일반상품, 20:묶음상품

Example: 10
goodsTypCdstringOptional

상품유형코드(PR002) 10:일반상품, 20:사은품, 30:e-쿠폰상품

Example: 10
saleMethCdstringOptional

판매방식코드(PR003) 10:일반판매, 20:예약상품

Example: 10
brandNostringOptional

브랜드번호

Example: 1000001
brandNmstringOptional

브랜드명

Example: 브랜드명
buyrAgeLmtCdstringOptional

구입자나이제한코드(PR004) 0:0, 15:15

Example: 0
dispYnstringOptional

전시여부

Example: Y
saleStatCdstringOptional

판매상태코드(PR005) 01:임시저장, 02:승인대기, 03:반려, 10:판매중, 20:품절, 30:판매종료

Example: 10
goodsRegDtmstring · date-timeOptional

상품등록일시

Example: 2021-01-01 00:00:00
saleStrDtmstring · date-timeOptional

판매시작일시

Example: 2021-01-01 00:00:00
saleEndDtmstring · date-timeOptional

판매종료일시

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

재고관리여부

Example: Y
deliProcTypCdstringOptional

배송처리유형코드(PR008) 10:센터배송, 20:업체배송

Example: 10
deliGoodsGbCdstringOptional

배송상품구분코드(PR010) 01:일반상품, 02:설치상품, 03:주문제작, 04:e-쿠폰

Example: 01
deliWayCdstringOptional

배송수단코드(PR009) 01:택배배송, 02:무배송

Example: 10
deliDdaystringOptional

배송기일

Example: 1
deliPolcNostringOptional

배송정책번호

Example: 1
prcHistStrDtmstring · date-timeOptional

가격이력시작일시

Example: 2021-01-01 00:00:00
prcHistEndDtmstring · date-timeOptional

가격이력종료일시

Example: 2029-01-01 00:00:00
rcntSalePrcinteger · int64Optional

최근판매가

Example: 10000
salePrcinteger · int64Optional

판매가

Example: 10000
aplyPrcinteger · int64Optional

적용가(전시가격)

Example: 10000
dispCtgNostringOptional

전시카테고리번호

Example: 1
dlexTypCdstringOptional

배송비유형코드(VD005) 10:무료, 20:유료, 30:조건부무료

Example: 10
goodsImmedDcCpnNostringOptional

상품즉시할인쿠폰번호

Example: 1
goodsImmedDcAplyStrDtmstring · date-timeOptional

상품즉시할인적용시작일시

Example: 2021-01-01 00:00:00
goodsImmedDcAplyEndDtmstring · date-timeOptional

상품즉시할인적용종료일시

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

상품대표이미지컨텐츠일련번호

Example: 1
rservSaleYnstringOptional

예약판매여부

Example: Y
rservStrDtmstring · date-timeOptional

예약시작일시

Example: 2021-01-01 00:00:00
rservEndDtmstring · date-timeOptional

예약종료일시

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

상품리뷰수

Example: 1
goodsRevHlpfulCntstringOptional

상품리뷰도움돼요수

Example: 1
goodsRevStarscrAvgValnumber · doubleOptional

상품리뷰별점평균값

Example: 1
fixamtFxrtGbCdstringOptional

상품즉시정액정율구분코드(MK005)

Example: 01
dcRateAmtinteger · int64Optional

상품즉시할인율금액

dcRateinteger · int64Optional

상품할인율

wishListCntstringOptional

위시리스트수

Example: 10
goodsRepImgPathNmstringOptional

대표이미지파일 경로

trnfTextContstringOptional

대표이미지 대체 텍스트

adlCertiYnstringOptional

성인인증여부

iconListstring[]Optional

아이콘정보

prcTimeDealYnstringOptional

타임딜여부

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

전시상품 조회 성공

{
  "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"
}

전시 카테고리 목록 조회

get

기능설명

  • 전체 전시 카테고리 정보 또는 브랜드 전시카테고리 정보를 조회한다.

상세설명

  • 전체 전시 카테고리 정보

    • 파라미터가 없다면 전체 전시 카테고리 정보를 subCategoryList를 이용해 대/중/소/세 계층적으로 조회한다.

  • 브랜드 전시 카테고리 정보

    • 브랜드 번호(brandNo)를 파라미터로 받는 경우 해당 브랜드 상품들이 속해 있는 전시 카테고리 정보를 subCategoryList를 이용해 대/중/소/세 계층적으로 조회한다.

Query parameters
brandNostringOptional

브랜드번호

Example: 100001
Header parameters
AuthorizationanyOptional

Access Token

Responses
200

전시 카테고리 정보 조회 성공

application/json

전시카테고리

dispCtgNostringOptional

전시카테고리번호

dispCtgNmstringOptional

전시카테고리명

dispSeqinteger · int32Optional

전시순서

uprDispCtgNostringOptional

상위전시카테고리번호

lrgCtgNostringOptional

대카테고리번호

midCtgNostringOptional

중카테고리번호

smlCtgNostringOptional

소카테고리번호

thnCtgNostringOptional

세카테고리번호

leafYnstringOptional

최하위 여부

depthstringOptional

카테고리 depth

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]"
          ]
        }
      ]
    }
  ]
}

전시카테고리 단건 조회

get

기능설명

  • 전시 카테고리 번호로 전시 카테고리 정보를 조회한다.

상세설명

  • 단건 전시 카테고리 정보

    • 전시카테고리번호(dispCtgNo)를 파라미터로 받아 해당 전시 카테고리 정보만을 조회한다.

    • 전달받은 전시 카테고리 번호의 정보만 조회하기 때문에 subCategoryList는 response 값에 제외된다.

Path parameters
dispCtgNostringRequired

전시카테고리번호

Example: 444
Header parameters
AuthorizationanyOptional

Access Token

Responses
200

전시카테고리 단건 조회 성공

application/json

전시카테고리

dispCtgNostringOptional

전시카테고리번호

dispCtgNmstringOptional

전시카테고리명

dispSeqinteger · int32Optional

전시순서

uprDispCtgNostringOptional

상위전시카테고리번호

lrgCtgNostringOptional

대카테고리번호

midCtgNostringOptional

중카테고리번호

smlCtgNostringOptional

소카테고리번호

thnCtgNostringOptional

세카테고리번호

leafYnstringOptional

최하위 여부

depthstringOptional

카테고리 depth

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]"
          ]
        }
      ]
    }
  ]
}
이전기획전
다음Models

마지막 업데이트