Skip to main content
POST

Body

string
required
The search query string. Supports fuzzy matching and operators
array
Array of resource types to search. If empty, searches all resources. Options: [“orders”, “customers”, “products”, “inventory”, “returns”, “warranties”, “tickets”]
object
Advanced filters to narrow search results
array
Fields to generate facet counts for
object
Sort configuration
object
Pagination configuration
boolean
Whether to include highlighted snippets in results
boolean
Whether to include search suggestions for typos

Response

array
Array of search results
object
Facet counts for requested fields
array
Search suggestions for possible typos
number
Total number of results found
number
Current page number
number
Results per page
number
Time taken to execute the query in milliseconds