Skip to main content
POST
Search

Headers

string
required
Your API key for authorization.

Body Parameters

object
required
string
Optional ID of a profile to influence search results in a personalized way and provide checkout URLs with shipping forms pre-filled with the profile’s attached shipping address.
string
The ID of the store to search in.
string
The domain of the store to search in.
number
default:"1"
Weight to apply to the query which represents the text, image, or both (0-1).
When using a style profile, defaults to 0.7.
number
default:"0.3"
Weight to apply to the style profile (0-1).
Only applies if profile_id is provided and the profile has a style attached.
number
default:"0.25"
Minimum similarity threshold for matching products (0-1).
integer
default:"2"
Maximum number of results to return.
array
Array of variant IDs to exclude from results.
number
Minimum price filter for the search results.
number
Maximum price filter for the search results.

Response

array
An array of product details, each containing:
array
Array of product IDs returned in the results.
string
A code indicating the result of the search operation. Possible values:
  • SEARCH_SUCCESS: Search completed successfully with results
  • NO_RESULTS_FOUND: Search completed but no results found
  • INVALID_REQUEST: Invalid request parameters
  • STORE_NOT_FOUND: Store ID or brand not found
  • PROFILE_NOT_FOUND: Profile ID not found
  • INTERNAL_ERROR: Server error occurred
string
Error message if the request fails.
string
Additional details about the error if the request fails.