API GUIDE 페이지

상품 리스트 화면

이해하기

쇼핑몰에서 판매하는 상품의 리스트를 전시하는 화면입니다.

A전시 카테고리

어드민 [상품> 상품 분류 관리 > 전시 카테고리 관리]에 매핑된 상품 카테고리를 출력하는 영역입니다.
상위 depth의 카테고리의 경우 해당 카테고리 하위 카테고리에 매핑된 전체 상품을 출력합니다.

get전체 카테고리 조회
/categories

쇼핑몰의 모든 카테고리 정보를 조회합니다.

쇼핑몰 화면에서 카테고리란, 화면이 바뀌어도 대부분의 경우 화면에 상시 노출되는 요소입니다.
따라서 LocalStorage에 5분 주기로 캐싱하고 있습니다.

아래 2가지 형태의 카테고리 데이터를 제공합니다.

  • flatCategories : 모든 카테고리를 하나의 배열에 쭉 나열한 형태
  • multiLevelCategories : 계층을 가지는 카테고리 형태 (최대 5depth)

shop by pro 기본 스킨에서는 multiLevelCategories를 사용하고 있습니다.
따라서 카테고리는 아래와 같이 계층 구조로 구성되며, 최대 5depth까지 어드민에서 카테고리를 추가할 수 있습니다.

아래 GET /products/search 호출을 통해 리턴 값으로 받은 상품 리스트를 노출하는 영역입니다.

get상품 리스트 검색
/products/search

다양한 검색 옵션에 맞는 상품 리스트를 조회합니다.

선택 값인 파라미터(Parameters)에 어떤 값을 입력하느냐에 따라 카테고리, 정렬, 검색 등 다양한 조건의 상품 리스트를 가져올 수 있습니다.

  • ㉠ 정렬 조건 order.by
    • 판매량순 (디폴트): 주문건수 기준
    • 낮은/높은 가격 순: 할인 적용가 기준
    • 상품 후기 순
    • 등록일 순
  • ㉡ 카테고리 categoryNos
  • ㉢ 키워드 검색 filter.keywords

키워드를 검색 창(search engine)에 입력하여 검색 시, 기본 스킨에서는 '(검색어) 검색결과 N개' 라고 안내 문구가 출력 되며 검색된 결과가 없는 경우 '검색 결과가 없습니다'라고 상품 리스트 출력 영역에 안내 문구가 노출됩니다.

C찜하기 버튼

상품 리스트 화면에서, 기본 스킨의 상품 리스트 조회 영역은 상품 메인분류 관리(=섹션)의 디스플레이 유형 중 '갤러리형'으로 제공됩니다.
따라서 찜하기 버튼이 제공되며 장바구니 버튼은 제공되지 않습니다.

찜하기 기능은 쇼핑몰 회원(member)의 경우에만 사용 가능하므로, 찜하기 버튼 클릭 시 로그인 여부를 확인해야 합니다.
  • 비회원(guest)

    비회원의 경우 찜하기 기능을 지원하지 않습니다.

    찜하기 버튼 클릭 시 로그인 여부를 확인하여, 미로그인(비회원) 시 알럿 노출 후 로그인 기능을 제공해야 합니다.

  • 회원(member)

    로그인한 상태에서 찜하기 버튼 클릭 시, 아래 POST /profile/like-products 를 호출합니다.

    기본 스킨에서는 버튼 클릭 시 '찜하기'가 적용되며 한번 더 클릭할 경우 '찜하기'가 삭제됩니다.

    해당 API로 찜하기가 적용된 상품은 마이페이지_쇼핑정보 내 '찜 리스트'에 추가됩니다.

post찜하기 추가 및 삭제
/profile/like-products

로그인 회원이 특정 상품에 '찜하기'를 추가/삭제합니다.

좌측 API 확인하기 버튼 클릭시,
API 정보를 확인할 수 있습니다.

가이드 < 워크스페이스 | NHN커머스