기획전
- X2BEE 관리자
- 정현 도
기획전 관리 페이지 API는 등록된 사이트(siteNo), 몰(mallNo), 기획전 번호(mkdpNo)를 기준으로, Front 화면에 기획전 목록과 기획전 상세 정보를 구성하기 위한 정보를 제공합니다. 이 API는 다양한 정보를 포함하며, 외부 콘텐츠(이미지, 기획전 상세 HTML)에 대한 캐싱을 적용하여 데이터 트래픽을 최소화하고 고객 경험을 최적화하도록 설계되었습니다.
주요 기능
기획전 목록 페이지
최신순 또는 마감순으로 선택된 정렬 기준에 따라 기획전 정보를 조회합니다.
진행 중인 기획전은 상태가 '진행 중'이며, 오늘 날짜가 전시 기간에 포함되어야 합니다. (기간이 지난 경우 '지난 기획전 목록'에 노출)
기획전 그룹은 사용 여부가 'Y'이고, 오늘 날짜가 기획전 그룹 전시 기간에 포함되어야 그룹 목록에 노출됩니다.
기획전 브랜드는 기획전에 등록된 브랜드를 조회하여 브랜드 목록에 노출됩니다.
전시 회원 등급과 임직원 여부에 따라 기획전 노출이 제한됩니다.
기획전 상세 페이지
기획전 템플릿에 따라 기획전 상세 페이지를 구성합니다.
기획전 구분자 정보는 전시 순서에 따라 노출됩니다.
상품 정렬 코드를 사용하여 상품에 대한 전시 순서를 제어할 수 있습니다.
전시 회원 등급과 임직원 여부에 따라 기획전 노출이 제한됩니다.
기획전 권한 체크
전시 회원 등급과 임직원 여부에 따라 기획전 노출을 제한할 수 있습니다.
권한 체크는 AND 기준으로 진행되며, 전시 회원 등급(GREEN) 및 임직원 전용을 체크한 경우 해당 기획전은 '임직원 + GREEN' 회원에게만 노출됩니다.
전시 회원 등급 및 임직원 전용을 모두 체크하지 않으면, 비회원을 포함한 모든 사용자에게 노출됩니다.
프로세스 정의
번호 | 업무명 | 설명 |
|---|---|---|
1 | 기획전 목록 조회 | 진행중인 기획전 : 오늘 날짜가 전시기간 안에 포함된 경우. 지난 기획전 : 전시기간날짜가 지난경우 전시회원등급 및 임직원 여부에 따라 기획전 노출을 제어합니다. |
2 | 기획전 상세 조회 | 진행중이지 않는 기획전 상세에 접근할 경우, ‘페이지 찾을수 없음’ 화면 출력 비로그인 진입시 전시회원등급 or 임직원 기획전인 경우, ‘로그인 후 확인하실 수 있습니다.’ Alert 출력 로그인 진입시 해당 회원이 전시회원등급 or 임직원 기획전에 일치하지 않을 경우 ‘페이지에 접근하실 수 없습니다. (특정 고객 대상 접근 가능)’ Alert 출력 비로그인 진입해 쿠폰 배너 클릭 할 경우, ‘로그인 후 쿠폰을 받으실 수 있습니다.’ Alert 출력 최신 기획전 10건을 조회합니다. |
3 | 기획전 노출 제한 | 전시회원등급,임직원 여부에 따른 기획전 노출 제한
|
API 기능 목록
API | 설명 | Server | 메소드 | 비고 |
|---|---|---|---|---|
기획전 조회 | •기획전 목록 페이지에서 사이트, 몰 기준으로 기획전 정보를 조회합니다. •브랜드. 정렬타입(최신순, 마감순), 진행여부에 따라 기획전 정보를 조회합니다. | Display | GET | |
기획전 브랜드 조회 | •기획전 목록 페이지에서 사이트, 몰 기준으로 브랜드 정보를 조회합니다. | Display | GET | 브랜드 정보조회: |
기획전 그룹 목록 조회 | •기획전 목록 페이지에서 사이트, 몰 기준으로 그룹 정보를 조회합니다. •사용 여부가 Y이고 현재날짜 기준으로 전시 기간에 해당하는 정보를 조회합니다. | Display | GET | |
기획전 상세 조회 | 기획전 번호를 통해 상세정보, 최신 기획전 정보, 구분자 정보 및 해당 상품정보를 조회하는 API입니다. 기획전 구분자와 해당 구분자별 상품은 설정한 전시순서순으로 노출됩니다. | Display | GET | |
기획전 구분자별 상품 조회 | 기획전 번호와 구분자 번호를 통해 해당 구분자의 상품정보를 조회합니다. 상품정렬타입(신상순,판매순,고가순,저가순,상품평순)에 따라 상품을 노출합니다. | Display | GET | |
기획전 조회(위시리스트) | 기획전 번호를 파라미터로 받아 이에 해당하는 기획전 정보를 제공해줍니다. | Display | GET |
용어 정의
명칭 | 설명 | 비고 |
|---|---|---|
전시기간 | 기획전이 기획전 목록에서 전시되는 기간을 말합니다. 전시기간이 끝난 기획전은 상세 진입이 안됩니다. |
|
템플릿 | 기획전 템플릿에 따라 기획전 상세페이지를 구성합니다. 현재 4개(기획전 템플릿1, 2, 3, 4)의 템플릿이 존재합니다. |
|
회원등급 | 회원등급에 따라 기획전 노출을 제한합니다. |
|
임직원전용 | 임직원 적용 여부에 따라 기획전 노출을 제한합니다. |
|
기획전 구분자 | 기획전 상세페이지에서 구분 영역을 나타내는 용어를 말합니다. 기획전 구분자 별로 구분자정보, 쿠폰배너, 상품리스트를 포함하고 있습니다. |
|
기타 참고사항
기획전 조회 API는 파라미터에 기획전번호가 있을 시 해당 기획전 번호들에 해당하는 정보를 조회합니다.
ex) https://beta-venus-api-display.x2bee.com/api/display/v1/plan/planWishList?dispMediaCd=20&mkdpNoList=14862,14952&pageNo=1&pageSize=20
해당 API로 조회할 시 기획전번호가 14862,14952인 기획전 정보를 조회합니다.