Skip to main content
GET
/
commerce
/
catalog
/
storefront
/
productsearch
/
visualsearch
Error
A valid request URL is required to generate request examples
{
  "pageId": "<string>",
  "results": [
    {}
  ],
  "trackingId": "<string>"
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

​
SearchTerm
string
required
Minimum string length: 2
​
Filters
object[]
​
Returnfields
string[]
​
Searchfields
string[]
​
Ignoregrouping
boolean
​
NumResults
integer<int32>
Required range: 1 <= x <= 10000
​
PageNumber
integer<int32>
Required range: 1 <= x <= 1000
​
ApplicationId
string
Required string length: 1 - 50
​
CatalogId
string
Required string length: 1 - 50
​
SessionId
string
Maximum string length: 100
​
TrackingId
string
Maximum string length: 100
​
ApiKey
string
​
Revision
string
​
Cip
string
​
DisplayDebug
boolean
​
responseFields
string

limits which fields are returned in the response body

Response

OK

​
pageId
string | null
​
results
object[] | null
​
trackingId
string | null