This API specification is available for download as an Open API 3.0 YAML file:
/filters
This operation returns a collection of all defined filters with their related facets and products.
If optional parameters CategoryName
and/or CategoryDomainName
are defined, the related filters are returned.
public com.intershop.sellside.rest.common.capi.resourceobject.SearchIndexFilterRO$SearchIndexFilterCollectionRO com.intershop.sellside.rest.common.capi.resource.SearchIndexFilterListResource.getFilters(java.lang.String,java.lang.String)
Location | Name | Format | Description |
---|---|---|---|
in query | CategoryDomainName | string | The domain in which the category "lives" |
in query | CategoryName | string | The category name which defines the category search context |
200 - OK
400 - Bad Request
404 - Not Found
/filters/{SearchIndexFilterResourceKey}
This operation returns a collection of all defined filters with their related facets and products, based on a selected filter.
SearchParameter
is a matrix parameter. URI part 'filter id' and 'SearchParameter' specify the superordinate / already selected filter.
public com.intershop.sellside.rest.common.capi.resourceobject.SearchIndexFilterRO$SearchIndexFilterCollectionRO com.intershop.sellside.rest.common.capi.resource.SearchIndexFilterResource.getFilter()
Location | Name | Format | Description |
---|---|---|---|
in path | SearchIndexFilterResourceKey | string | Required | ID of filter |
in path | SearchIndexFilterResourceKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
in query | SearchParameter | string | Required | Search parameters as matrix parameter after SearchIndexFilterResourceKey |
200 - OK
400 - Bad Request
404 - Not Found
/filters/{SearchIndexFilterResourceKey}/hits
This operation returns a list of product links for a facet/filter. SearchParameter
is a matrix parameter.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.SearchIndexFilterResource.getHits(java.lang.Integer,java.lang.Integer)
Location | Name | Format | Description |
---|---|---|---|
in path | SearchIndexFilterResourceKey | string | Required | ID of filter |
in path | SearchIndexFilterResourceKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
in query | SearchParameter | string | Required | Search parameters as matrix parameter after SearchIndexFilterResourceKey |
in query | offset | integer | The result number (product number) the response will start with | Format: int32 | Default: 0 |
in query | amount | integer | The amount of returned products | Format: int32 | Default: 100 |
200 - OK
400 - Bad Request
/suggest
This operation retrieves search suggestions from the installed search engine for a search term.
If no search engine is active or the are no suggestions for the given search term, an empty collection is returned.
public com.intershop.sellside.rest.common.capi.resourceobject.SuggestTermRO$SuggestCollectionRO com.intershop.sellside.rest.common.capi.resource.SearchSuggestResource.getSuggestTerms(java.lang.String)
Location | Name | Format | Description |
---|---|---|---|
in query | SearchTerm | string | Required | Defines the search term to find suggestions for |
200 - OK
int32
int32
int32
LinkRO
objects. the list of elementsLinkRO
: A Link pointing to a resourceLink
ResourceAttribute
objects. the list of attributesResourceAttribute
: An attributeResourceAttribute
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
ResourceAttribute
object. An attributeResourceAttribute
ResourceCollection
string
literals. the keys to sort forint32
int32
int32
SearchIndexFilterRO
objects. The list of elementsSearchIndexFilterRO
: Represents a filterTaxonomic Filter
SearchIndexFilter
CategoryUUIDLevelMulti
FacetRO
objects. Facets | Example: Object of type FacetRO
FacetRO
: Facetsint32
LinkRO
object. A Link pointing to a resourceLink
ResourceAttribute
objects. the list of attributesResourceAttribute
: An attributeResourceAttribute
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
ResourceAttribute
object. An attributeResourceAttribute
int32
LinkRO
object. A Link pointing to a resourceLink
ResourceAttribute
objects. the list of attributesResourceAttribute
: An attributeResourceAttribute
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
ResourceAttribute
object. An attributeResourceAttribute
text_clear
taxonomic
int32
| Example: -1
int32
| Example: 1
Map that contains maping information for facets
Global
string
literals. The keys to sort forfilters
int32
int32
int32
SuggestTermRO
objects. The list of elementsSuggestTermRO
: Search term suggestionSuggestTerm
netbooks
SuggestTerms
string
literals. The keys to sort forThe information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.