Skip to main content
POST
Generic Search

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Path Parameters

name
string
required

Name of a search configured for the product. An unconfigured name fails with INVALID_SEARCH_CONFIG.

Query Parameters

productId
string
required

The productId

Body

application/json

Response

200 - application/json
pageInfo
object
required

the page info

totalCount
number
required

the total number of items

currentPage
number
required

the current page

totalPages
number
required

the total number of pages

data
object[]
required

Array of generic search result objects