상품검색

상품 통합 검색

post

기능설명

  • 상품에 대한 통합 검색 결과를 보여줍니다.


상세설명

  • 검색 페이지에서 키워드 검색을 진행할 때 호출합니다.

  • 검색어에 대한 상품의 통합 정보를 보여줍니다.

  • 통합 검색 결과는 상품 목록, 카테고리 목록, 브랜드 목록, 연관검색어 목록입니다.


수정번호

  • Release v1.04_231120 : 검색페이지 통합 검색, 검색페이지 통합 검색 신규 추가

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
searchWordstringRequired

검색키워드

Header parameters
AuthorizationanyOptional

Access Token

Body

검색기본 Request

searchWordstringOptional

검색어

langCdstringOptional

다국어코드

siteNostringOptional

사이트번호

sortstringOptional

정렬구분코드

Example: asc
sortFieldstringOptional

정렬대상항목

Example: goodsRegDtm
sizestringOptional

페이지당 노출수

Example: 20
fromstringOptional

페이지 시작점

Example: 0
filtersstringOptional

필터값

Example: filters=brandNo:1001,brandNm:플래티어
filterstringOptional

필터값

Example: filters=brandNo:1001,brandNm:플래티어
minPrcinteger · int32Optional

최소가격

maxPrcinteger · int32Optional

최대가격

ctgNostringOptional

카테고리매장번호

vectorstring[]Optional

벡터 데이터

specialstringOptional

스페셜검색

Responses
chevron-right
200

상품 통합 검색 조회 성공

*/*

검색엔진 검색결과 DTO

sizestringOptional

페이지당 노출수

Example: 20
fromstringOptional

페이지 시작점

Example: 0
totalCountinteger · int32Optional

총건수

Example: 123
assocwordDataListstring[]Optional

연관검색어 목록

minPrcinteger · int32Optional

최소가격정보

maxPrcinteger · int32Optional

최대가격정보

post
/v1/search/search
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
AuthorizationanyOptional

Access Token

Body

검색기본 Request

searchWordstringOptional

검색어

langCdstringOptional

다국어코드

siteNostringOptional

사이트번호

sortstringOptional

정렬구분코드

Example: asc
sortFieldstringOptional

정렬대상항목

Example: goodsRegDtm
sizestringOptional

페이지당 노출수

Example: 20
fromstringOptional

페이지 시작점

Example: 0
filtersstringOptional

필터값

Example: filters=brandNo:1001,brandNm:플래티어
filterstringOptional

필터값

Example: filters=brandNo:1001,brandNm:플래티어
minPrcinteger · int32Optional

최소가격

maxPrcinteger · int32Optional

최대가격

ctgNostringOptional

카테고리매장번호

vectorstring[]Optional

벡터 데이터

specialstringOptional

스페셜검색

Responses
chevron-right
200

OK

*/*

검색엔진 검색결과 DTO

sizestringOptional

페이지당 노출수

Example: 20
fromstringOptional

페이지 시작점

Example: 0
totalCountinteger · int32Optional

총건수

Example: 123
assocwordDataListstring[]Optional

연관검색어 목록

minPrcinteger · int32Optional

최소가격정보

maxPrcinteger · int32Optional

최대가격정보

post
/v1/search/product-image
200

OK

기획전 검색

post

기능설명

  • 검색어와 관련된 기획전 정보를 검색합니다.


상세설명

  • 검색어를 입력하면 연관된 기획전 정보를 제공합니다.

  • 기획전 검색은 다국어를 지원하며 파라미터로 다국어 코드(langCd: ko, en 등)가 필수입니다.

  • 필요한 정보는 extraData 필드에 추가하여 사용할 수 있습니다.

  • 검색어, 카테고리, 필터 등의 값을 받아 해당 조건에 맞는 기획전을 검색합니다.


수정번호

  • Release v1.04_231120 : 검색페이지 기획전 검색 추가, 검색페이지 기획전 검색 신규 추가

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
searchWordstringRequired

검색키워드

langCdstringRequired

다국어 코드

Header parameters
AuthorizationanyOptional

Access Token

Body

검색기본 Request

searchWordstringOptional

검색어

langCdstringOptional

다국어코드

siteNostringOptional

사이트번호

sortstringOptional

정렬구분코드

Example: asc
sortFieldstringOptional

정렬대상항목

Example: goodsRegDtm
sizestringOptional

페이지당 노출수

Example: 20
fromstringOptional

페이지 시작점

Example: 0
filtersstringOptional

필터값

Example: filters=brandNo:1001,brandNm:플래티어
filterstringOptional

필터값

Example: filters=brandNo:1001,brandNm:플래티어
minPrcinteger · int32Optional

최소가격

maxPrcinteger · int32Optional

최대가격

ctgNostringOptional

카테고리매장번호

vectorstring[]Optional

벡터 데이터

specialstringOptional

스페셜검색

Responses
chevron-right
200

기획전 검색 조회 성공

*/*
idstringOptional

기획전번호

mkdpNostringOptional

기획전번호

titlestringOptional

기획전명

descriptionstringOptional

기획전설명

schKwdNmstringOptional

키워드명

brandCodesstringOptional

브랜드번호들

brandImgPathNmstringOptional

배너이미지경로명

altContstringOptional

배너이미지 대체텍스트

dispStrDtmstring · date-timeOptional

기획전시작일시

dispEndDtmstring · date-timeOptional

기획전종료일시

extraDatastringOptional

추가데이터

langCdstringOptional

언어코드

post
/v1/search/marketing

이벤트 검색

post

기능설명

  • 검색어와 관련된 이벤트 정보를 검색합니다.


상세설명

  • 검색어를 입력하면 연관된 이벤트 정보를 제공합니다.

  • 필요한 정보는 extraData 필드에 추가하여 사용할 수 있습니다.

  • 검색어, 카테고리, 필터 등의 값을 받아 해당 조건에 맞는 이벤트를 검색합니다.


수정번호

  • Release v1.04_231120 : 검색페이지 이벤트 검색 추가, 검색페이지 이벤트 검색 신규 추가

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
searchWordstringRequired

검색키워드

Header parameters
AuthorizationanyOptional

Access Token

Body

검색기본 Request

searchWordstringOptional

검색어

langCdstringOptional

다국어코드

siteNostringOptional

사이트번호

sortstringOptional

정렬구분코드

Example: asc
sortFieldstringOptional

정렬대상항목

Example: goodsRegDtm
sizestringOptional

페이지당 노출수

Example: 20
fromstringOptional

페이지 시작점

Example: 0
filtersstringOptional

필터값

Example: filters=brandNo:1001,brandNm:플래티어
filterstringOptional

필터값

Example: filters=brandNo:1001,brandNm:플래티어
minPrcinteger · int32Optional

최소가격

maxPrcinteger · int32Optional

최대가격

ctgNostringOptional

카테고리매장번호

vectorstring[]Optional

벡터 데이터

specialstringOptional

스페셜검색

Responses
chevron-right
200

이벤트 검색 조회 성공

*/*
idstringOptional

이벤트번호

evtNostringOptional

이벤트번호

titlestringOptional

이벤트명

descriptionstringOptional

홍보문구내용

schKwdNmstringOptional

이벤트검색태그

sendGbstringOptional

전송구분코드

extraDatastringOptional

추가데이터

post
/v1/search/event
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

OK

*/*
totalCountinteger · int32Optional

총건수

Example: 123
get
/v1/search/searchRecommendWord
200

OK

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

OK

*/*
totalCountinteger · int32Optional

총건수

Example: 123
get
/v1/search/searchMarkupWord
200

OK

검색 기본문구 조회

get

기능설명

  • 검색기본문구를 조회하는 API입니다.


상세설명

  • 쿠키에 저장된 언어코드를 사용하여 조회합니다.

  • 추천검색어 중에 적용기간이 해당되며, 사용여부가 'Y'인 추천검색어를 조회합니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

검색기본문구 조회 성공

*/*

검색기본문구 DTO

langCdstringOptional

언어코드(CM009)

Example: ko
baseSchWrdWrdstringOptional

기본검색어문구

Example: 검색어
schWrdstringOptional

검색어

Example: 검색어
schBaseWrdSeqstringOptional

검색기본문구순번

Example: 1
aplyStrDtmstring · date-timeOptional

적용시작일시

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

적용종료일시

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

연결URL주소

Example: http://www.naver.com
useYnstringOptional

사용여부

Example: Y
get
/v1/search/schBaseWrdList

추천 검색어

get

기능설명

  • 입력한 검색어에 대한 추천 검색어를 반환합니다.


상세설명

  • 검색어를 입력하면 연관된 추천 검색어를 보여줄 때 사용합니다.

  • 키워드 입력시 실시간으로 연동하면 자동완성과 동일한 기능으로 구현이 가능합니다.

  • 최종 responses는 list 노드에 array 형태로 보내준다. ( {list:[{responses}]} )


수정번호

  • Release v1.04_231120 : 검색페이지 자동완성단어 추가, 검색페이지 자동완성단어 신규 추가

  • Release v2.00_240627 : 자동완성단어 대상을 상품, 기획전, 이벤트, 카테고리, 브랜드로 확장

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
searchWordstringRequired

검색키워드

Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

추천검색어 조회 성공

*/*
categorystringOptional

추천 항목

Example: recommend
get
/v1/search/recommendation

검색창 마크업 및 추천검색어

get

기능설명

  • BO 에서 등록한 검색창 마크업 및 추천 검색어 단어 정보를 제공합니다.


상세설명

  • BO 연관 메뉴 : 상품 > 검색어관리 > 추천검색어, BO 상품 > 검색어관리 > 마크업 검색어

  • 추천검색어, 마크업 검색어 중에서 가장 최근에 수정된 내용을 제공합니다.

  • 제공된 내용은 검색 페이지 진입 시 검색창에 기본으로 노출하여 의도하는 상품이나 기획 페이지로의 유인에 사용할 수 있습니다.


수정번호

  • Release v1.04_231120 : 검색창 마크업 및 추천검색어 추가, 검색창 마크업 및 추천검색어 신규 추가

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

이벤트 검색 조회 성공

*/*
recommWordstringOptional
schWordstringOptional
siteLinkstringOptional
recommTypestringOptional
get
/v1/search/recommendWord

추천 검색어 조회

get

기능설명

  • 추천검색어를 조회하는 API입니다.


상세설명

  • 쿠키에 저장된 언어코드를 사용하여 조회합니다.

  • 추천검색어 중에 적용기간이 해당되며, 사용여부가 'Y'인 추천검색어를 조회합니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

추천검색어 조회 성공

*/*

추천검색어 DTO

langCdstringOptional

언어코드(CM009)

Example: ko
recomSchWrdstringOptional

추천검색어

Example: 빨강
recomSchWrdSeqstringOptional

추천검색어순번

Example: 1
aplyStrDtmstring · date-timeOptional

적용시작일시

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

적용종료일시

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

정렬순서

Example: 1
useYnstringOptional

사용여부

Example: Y
get
/v1/search/recomSchWrdList

상품 조건 검색

get

기능설명

  • 검색어에 조건을 추가하여 상품 목록을 검색한다.


상세설명

  • 검색 페이지의 정렬 조건, 필터 조건등을 추가하여 상품 목록을 검색할 수 있다.

  • 정렬 조건은 코드가 약속되어 있다. (10:판매순, 20:낮은가격순, 30:높은가격순, 40:할인율순, 50:최신순, 60:상품평많은순)

  • 필터 조건은 다양하게 추가가 가능하며 Search Swagger의 /goods를 참고하여 필요한 조건을 추가하여 사용한다.


수정번호

  • Release v1.04_231120 : 상품 조건 검색 추가, 상품 조건 검색 신규 추가

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

상품 조건 검색 성공

*/*

검색엔진 검색결과 DTO

sizestringOptional

페이지당 노출수

Example: 20
fromstringOptional

페이지 시작점

Example: 0
totalCountinteger · int32Optional

총건수

Example: 123
assocwordDataListstring[]Optional

연관검색어 목록

minPrcinteger · int32Optional

최소가격정보

maxPrcinteger · int32Optional

최대가격정보

get
/v1/search/product
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

OK

*/*

검색엔진 검색결과 DTO

sizestringOptional

페이지당 노출수

Example: 20
fromstringOptional

페이지 시작점

Example: 0
totalCountinteger · int32Optional

총건수

Example: 123
assocwordDataListstring[]Optional

연관검색어 목록

minPrcinteger · int32Optional

최소가격정보

maxPrcinteger · int32Optional

최대가격정보

get
/v1/search/product-semantic
200

OK

인기 검색어

get

기능설명

  • 현재부터 24시간 전까지 가장 많이 검색된 키워드 목록 상위 10개를 가져옵니다.


상세설명

  • 검색 페이지에서 인기 검색어를 보여줄 때 호출합니다.

  • 해당 기능은 파라미터를 필요로 하지 않습니다.

  • 검색된 키워드를 클릭할 경우 해당 키워드로 검색할 수 있게 구성할 수 있습니다.


수정번호

  • Release v1.04_231120 : 검색페이지 인기검색어 추가, 검색페이지 인기검색어 신규 추가

  • Release v1.05_240621 : 인기검색어 순위 증감 추가

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

인기검색어 조회 성공

*/*
keywordstringOptional

키워드

changeTypeinteger · int32Optional

인기순위 증감

get
/v1/search/popularKeword

Last updated