Skip to main content
POST
JavaScript

Authorizations

x-api-key
string
header
required

Body

application/json
type
string
required
Allowed value: "global"
filters
object
required
mode
enum<string>
default:async
Available options:
async,
sync
limit
number
default:20

Limit the number of results

Required range: 1 <= x <= 100
Example:

20

cursor
integer

Cursor returned from the previous response

Required range: 0 <= x <= 9007199254740991
Example:

0

skipCache
boolean
default:false

When true, bypass any cached response and force a fresh search. Fresh results still repopulate the cache. Applies to both text and image searches.

Example:

false

Response

Product search queued successfully, use refId to check status and retrieve results

refId
string
required
Pattern: ^[a-zA-Z]{3}-ref_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[0-9a-f]{4}$
status
enum<string>
required
Available options:
pending,
processing,
complete,
failed
result
object
error
object