POST
/
search

​
Headers

​
authorization
string
required

Your API key for authorization.

​
Body Parameters

​
q
string
required

The search query provided by your LLM tool call.

​
store_id
string
required

The ID of the store to search in.

​
user_id
string
required

The ID of the user performing the search.

​
price_min
integer

Minimum price filter for the search results. Must be at least 1.

​
price_max
integer

Maximum price filter for the search results. Must be at least 1.

​
Response

​
results
array

An array of product details, each containing:

  • id: The unique identifier of the product.
  • title: The product title.
  • description: The product description.
  • product_type: The type/category of the product.
  • tags: Array of tags associated with the product.
  • options: Available product options.
  • images: Array of product images.
  • variants: Array of product variants, each containing:
    • id: The variant ID.
    • title: The variant title.
    • price: The variant price.
​
code
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
  • AUTH_MISSING: No API key provided
  • INVALID_KEY: Invalid API key
  • BAD_REQUEST_ERROR: Invalid request parameters
  • STORE_NOT_FOUND: Store ID not found
  • FORBIDDEN: Not authorized to access store
  • INTERNAL_ERROR: Server error occurred
​
error
string

Error message if the request fails.

​
message
string

Additional details about the error if the request fails.

Buy Item