Skip to main content
POST
Find by details

Authorizations

X-API-KEY
string
header
required

Body

application/json

Request body for finding products. Each field is optional. However, you must provide at least one field to perform a valid search. The values a filter accepts can be listed with GET /v1/knowledge-graph/products/values/{filter}.

query
string

Text query to search for products by name or description. Examples: 'iPhone', 'Model 3'

Example:

"iPhone"

types
string[]

Product types, as published in the type field of results (e.g., 'Mobile Phones')

Example:
owners
string[]

Names of the owning company, as published in the owner field of results (e.g., 'Apple Inc.')

Example:

Response

200 - application/json

Successful response with products data

Response containing products results and metadata

results
object[]
required

Array of products results

metadata
object
required
usage
object

Optional. Present for token-billing accounts only. Reports the number of tokens consumed by this request.