Skip to main content

상품 검색(search engine)하기

GET 
/products/search

부가설명 및 특이사항​

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

  • Paging 기능 제공합니다. (페이지당 조회가능한 최대 상품 개수는 500개 입니다.)
  • 아래 Parameters에 해당하는 검색조건들의 경우, 매 10초 마다 캐시가 됩니다.

화면 예시​

product-search-img-1

참고​

상세 상품 정렬 기준 (order.by 파라미터)

  • MD추천순(MD_RECOMMEND): [서비스어드민 > 전시관리 > 전시상품 우선순위 관리] 메뉴에서 설정하신 정렬 순서로 상품이 노출됩니다.

    • ASC: 우선순위가 높은(숫자가 낮은) 상품 순으로 정렬됩니다. (1순위 -> 2순위 -> 3순위...)
    • DESC: 우선순위가 낮은(숫자가 높은) 상품 순으로 정렬됩니다. (3순위 -> 2순위 -> 1순위...)

  • 총판매량순(SALE_CNT): 현재까지 해당 상품이 판매된 판매량 순서입니다.

    • ASC: 총 판매량 수가 낮은 상품 순으로 정렬됩니다. (1개 판매 -> 2개 판매 -> 3개 판매...)
    • DESC: 총 판매량 수가 높은 상품 순으로 정렬됩니다. (3개 판매 -> 2개 판매 -> 1개 판매...)
    • “결제완료” 시점에 상품 수량을 카운트(+)하며, “임금대기” 건은 카운트하지 않음.
    • 클레임 처리 시 환불 시점에 차감 (-)되며, 교환 처리 시, 교환 상품은 차감되고 교환추가상품은 카운트됨.

  • 판매인기순(POPULAR): 판매가 및 인기도(1주일간 구매수량, 상품후기점수, 좋아요 수 등)에 점수를 부여하여 산출한 순서로 점수 산정 기준은 아래와 같습니다.

    • ASC: 인기점수가 낮은 상품 순으로 정렬됩니다. (100점 -> 200점 -> 300점...)
    • DESC: 인기점수가 높은 상품 순으로 정렬됩니다. (300점 -> 200점 -> 100점...)
    • 점수 기준 
      • 25 * 최근 1주일 구매횟수 * 가격별포인트 +
        10 * 최근 1주일 장바구니(cart) 추가 횟수 +
        10 * 최근 1주일 상품 좋아요(like) 클릭 횟수 +
        10 * 최근 1주일 위시리스트(찜하기) 추가 횟수 +
        5  * 최근 1주일 리뷰점수 평균
    • 가격별 포인트 
      • 0~1,000         1점
        1,000~5,000     2점
        5,000~10,000    3점
        10,000~30,000   4점
        30,000~50,000   5점
        50,000~70,000   6점
        70,000~         7점

  • 판매일자(SALE_YMD), 판매종료일자(SALE_END_YMD): 판매시작/종료일 순으로 상품을 정렬합니다.

    • ASC: 판매시작/종료일자 과거순으로 상품이 정렬됩니다. (1월1일 -> 2월10일...)
    • DESC: 판매시작/종료일자 최신순으로 상품이 정렬됩니다. (2월10일 -> 1월1일...)

  • 최근상품순(RECENT_PRODUCT): 상품 등록일 기준으로 상품을 정렬합니다.

    • ASC: 상품 등록일이 과거순으로 상품이 정렬됩니다. (1월1일 -> 2월10일...)
    • DESC: 상품 등록일이 최신순으로 상품이 정렬됩니다. (2월10일 -> 1월1일...)

  • 유효일자(EXPIRATION_DATE): 상품 유효일자 기준으로 상품을 정렬합니다.

    • ASC: 현재 날짜 기준으로 유효일자가 과거순으로 정렬됩니다. (1월1일 -> 2월10일...)
    • DESC: 현재 날짜 기준으로 유효일자가 최신순으로 정렬됩니다. (2월10일 -> 1월1일...)
    • 유효일자 정렬의 경우, 유효일자가 설정된 상품이 우선으로 나옵니다. (유효일자 있는 상품 > 유효일자 없는 상품 + 유효일자 지난 상품 - 나머지 상품은 상품번호가 최신순으로 정렬)
    • 유효일자와 현재 날짜가 동일한 경우, 유효일자가 있는 상품으로 취급합니다.

상품항목추가정보 검색

  • 하나의 항목에서 여러개의 다중 항목 값을 검색할 경우 (SPACE 구분으로 검색) (아래 예시 참고)
    • filter.customProperties.propNos : 100
    • filter.customProperties.propValueNos : 1 2 3
  • 다중 항목에서 여러개의 다중 항목 값을 검색할 경우 (콤마(,) 구분으로 검색) (아래 예시 참고)
    • ※ 다중 항목으로 검색 시 콤마(,) 갯수를 맞춰줘야 합니다.
    • filter.customProperties.propNos : 100,101,102
    • filter.customProperties.propValueNos : 1 2 3,4 5 6,7 8 9
  • 항목 값(propNos, propValueNos)은 GET /products/custom-properties API를 참조하면됩니다.
  • filter.customProperties.propOperator : 상품항목 추가정보 조회 조건을 선택합니다.
    • AND: 항목값들을 모두 만족시키는 상품이 조회됩니다.
      • "propNo: 100, propValueNos: 1 2 3" 이 경우 propNo에 해당하는 propValueNos가 1 AND 2 AND 3으로 조회됩니다.
    • OR: 항목값 중 하나라도 만족되는 상품이 조회됩니다.
      • "propNo: 100, propValueNos: 1 2 3" 이 경우 propNo에 해당하는 propValueNos가 1 OR 2 OR 3으로 조회됩니다.

유효일자 검색

  • 유효일자 검색 시, expirationDate에 "2023-10-31"로 검색하는 경우 아래와 같이 검색됩니다.
    • 현재시간을 "2023-10-21"이라고 할 때, "2023-10-21 ~ 2023-10-31"에 해당하는 유효일자를 검색합니다.
    • 양 끝 범위에 해당하는 일자는 포함해서 검색합니다.

상품평점 검색

  • 입력된 리뷰 평점 범위의 상품들로 필터링되어 검색합니다.
  • minReviewRating, maxReviewRating 중 한개만 입력시 이상 또는 이하의 범위로 필터링 합니다.
    • 예) minReviewRating = 3.0일 경우, 3.0 이상의 리뷰 평점 상품 검색
    • 예) maxReviewRating = 5.0일 경우, 5.0 이하의 리뷰 평점 상품 검색
  • minReviewRating, maxReviewRating 모두 입력시 minReviewRating < x < maxReviewRating의 범위로 필터링 합니다.

OAUTH2 참고사항​

  • Oauth2 API 를 사용하여 토큰을 발급받은 경우,
  • 기존 accessToken 대신 Shop-By-Authorization 로 액세스 토큰을 전달해야합니다.
  • ex) Shop-By-Authorization : Bearer test-access-token

[상품 금액 적용]​

기본 상품 판매가​

  • 옵션이 없는 상품
    • 상품 등록 시, 기입한 판매가 그대로 적용
  • 옵션이 있는 상품
    • 상품 등록 시, 기입한 판매가 + 옵션가 적용
    • 예) A상품(판매가10000원)에 옵션 1(+0원) | 옵션2(+1000원) 인 경우|, 옵션1 구매가격은 10000원 옵션2 구매가격은 11000원
  • 세트 상품
    • 세트 상품의 옵션에 구성된 옵션(옵션있는 상품들의 옵션으로 세트 옵션 구성)의 구매가격의 합
    • 세트 옵션 구성이 달라질 수 있기때문에 당연히 옵션마다 가격 상이 함

즉시 할인​

  • 옵션이 없는 상품
    • 판매가에 즉시할인이 적용된 가격
  • 옵션있는 상품, 세트 상품
    • 판매가에 즉시할인이 적용된 가격 + 옵션가 가 최종 가격
    • 예) A상품(판매가10000원)에 옵션 1(+0원) | 옵션2(+1000원) | 옵션3(+2000원) 이고 즉시 할인율 10% 인 경우, 옵션별 가격은 판매가 *0.8 + 옵션가 이므로 따라서 옵션 1 의 판매가격은 9000원, 옵션 2의 판매가격은 10000원, 옵션3의 판매가격은 11000원

* 옵션가격에서 즉시 할인이 적용 되는 것이 아님

추가 할인​

  • 할인 적용 순서 : 즉시 할인 -> 추가 할인
  • 즉시 할인 적용 된 판매가격에 추가 할인 적용
    • 예) 10000원 상품에 즉시 할인으로 1000원일 할인된다면, 9000원에서 추가 할인 설정에 따라 할인 적용

즉시 할인과의 차이점이라면 적용되는 가격인데 즉시 할인의 경우 상품을 등록 할 때에 입력한 판매가 적용하지만, 추가 할인은 실제 해당 상품의 구매 가격에 적용 (상품등록 시에 판매가에 적용되는 것이 아닌 실제 구매 금액에 적용)

  • 예) A상품(판매가15000원)

    - 옵션 1(+0원) | 옵션2(+1000원) | 옵션3(+2000원)

    - 즉시 할인 : 5000원

    - 추가 할인 : 10%

    옵션 1 구매가격 : ((15000-5000) + 0)*0.9 = 9000

    옵션 2 구매가격 : ((15000-5000) + 1000)*0.9 = 9900

    옵션 2 구매가격 : ((15000-5000) + 2000)*0.9 = 10800

Request​

Responses​

200