References

The following page lists available REST APIs for ICM 11 and their version dependencies:

Reference - Intershop Commerce Management 11 REST API

API Specification

Introduction

OpenAPI Version: 3.0.1

Search Version: 2.0.1

Search API

The Intershop Search REST API contains endpoints related to search and suggestions.

Notes

No results are returned if there is no search index.

Search API

/suggest

GET: Retrieves suggestions for a search term

Description

This operation retrieves search suggestions from the installed search engine for a search term.

If no search engine is active or there are no suggestions for the given search term, an empty collection is returned.

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.SuggestTermRO$SuggestCollectionRO com.intershop.sellside.rest.common.capi.resource.SearchSuggestResource.getSuggestTerms(java.lang.String)

Request Body

Request Parameters

Location	Name	Format	Default	Example	Description
in query	SearchTerm	string			Required \| Defines the search term to find suggestions for

Response

200 - OK

SuggestCollectionRO application/json

Request and Response Object Schemata

SuggestCollectionRO application/json

{

"pageable":
string
The pageable ID
"total":
integer
The pageable amount total | Format: int32
"offset":
integer
The pageable offset | Format: int32
"amount":
integer
The pageable amount | Format: int32
"elements":
array
An array of SuggestTermRO objects. The list of elements
[
SuggestTermRO: Search term suggestion
{
- "name":
  string
  The name of an element
- "type":
  string
  The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: SuggestTerm
- "term":
  string
  A suggested search term | Example: netbooks
}
]
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: SuggestTerms
"sortKeys":
array
An array of string literals. The keys to sort for
"name":
string
The name of an element

}

Disclaimer

The 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.