Sign InBook a Demo
Support

Search APIs

GETText Search

Search products by text query.

GEThttps://api.catalogix.ai/v1/search

Authorization

Authorizationstringrequiredheader
Bearer token, Bearer <token>. Create one under Tokens in your workspace.

Query parameters

store_uuidstringrequired
Store identifier
Example: 69b3a770f5006c4b0be47c85
textstringrequired
Search query text
Example: shirt
offsetintegerdefault: 0
Pagination offset
limitintegerdefault: 10
Maximum number of results

Headers

X-Request-Idstring
Optional trace ID

Responses

200Search results
statusobject
Fields
codeinteger
0 = success, -1 = error
Example: 0
messagestring
Example: SUCCESS
request_idstring
Example: 8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312
dataobject[]
List of matching products returned directly from upstream search API.
Item fields
product_codestring
Example: SKU001
titlestring
Example: Blue Shirt
scorenumber
Relevance score
Example: 0.95
400Validation error
statusstringdefault: "error"
The status of the request, typically 'error'
detailstringrequired
A description of the error
401Unauthorized – Bearer token missing or invalid
statusobject
Fields
codeinteger
Example: -1
messagestring
Example: Unauthorized – invalid or missing Bearer token
500Internal server error
statusobject
Fields
codeinteger
Example: -1
messagestring
Example: Internal server error. Please contact support@catalogix.ai
502Downstream service unavailable
statusstringdefault: "error"
The status of the request, typically 'error'
detailstringrequired
A description of the error

Something missing or unclear? Write to support@streamoid.com.

esc