Search APIs
GETText Search
Search products by text query.
Requests go to the live API through streamoid.com and act on your real data.
Authorization
AuthorizationstringrequiredheaderBearer token,
Bearer <token>. Create one under Tokens in your workspace.Query parameters
store_uuidstringrequiredStore identifier
Example:
69b3a770f5006c4b0be47c85textstringrequiredSearch query text
Example:
shirtoffsetintegerdefault: 0Pagination offset
limitintegerdefault: 10Maximum number of results
Headers
X-Request-IdstringOptional trace ID
Responses
200Successful response.
statusobjectFields
codeinteger0 = success, -1 = error
Example:
0messagestringExample:
SUCCESSrequest_idstringExample:
8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312dataobject[]List of matching products returned directly from upstream search API.
Item fields
product_codestringExample:
SKU001titlestringExample:
Blue ShirtscorenumberRelevance score
Example:
0.95401Unauthorized – Bearer token missing or invalid
statusobjectFields
codeintegerExample:
-1messagestringExample:
Unauthorized – invalid or missing Bearer token403The identity check rejected the caller: the token is not valid for this store
statusobjectrequiredFields
codeintegerAllowed:
1Example:
1messagestringExample:
Unable to verify caller identity404No store with this `store_uuid`
statusobjectrequiredcode is -1 and message explains the failureFields
codeintegerrequiredStatus code of the operation. 1 means success. -1 means failure. 0 means process moved to background
Example:
0messagestringrequiredMessage describing the status
Example:
successrequest_idstringUnique trace ID for the request. Echoed from X-Request-Id header or auto-generated.
Example:
8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312dataobjectrequiredEmpty, except on a
POST /v1/stores 502 where the store was created but a follow-up step failed: it then carries store_uuid and store_group so the store can be fixed with PUT or removed with DELETE.Fields
store_uuidstringExample:
699ec31355208b213e56059astore_groupstringExample:
linked_store_id_abc422A parameter is missing or invalid
detailobject[]Item fields
locstring | integer[]requireddefault: ["body",""]msgstringrequireddefault: "Field Required"typestringrequireddefault: "missing"500Internal server error
statusobjectFields
codeintegerExample:
-1messagestringExample:
Internal server error. Please contact support@catalogix.ai502The search service is unavailable or failed
statusobjectrequiredcode is -1 and message explains the failureFields
codeintegerrequiredStatus code of the operation. 1 means success. -1 means failure. 0 means process moved to background
Example:
0messagestringrequiredMessage describing the status
Example:
successrequest_idstringUnique trace ID for the request. Echoed from X-Request-Id header or auto-generated.
Example:
8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312dataobjectrequiredEmpty, except on a
POST /v1/stores 502 where the store was created but a follow-up step failed: it then carries store_uuid and store_group so the store can be fixed with PUT or removed with DELETE.Fields
store_uuidstringExample:
699ec31355208b213e56059astore_groupstringExample:
linked_store_id_abc503The store's search index is not built yet or is still being built (retry later), or the store has no usable taxonomy configured
statusobjectrequiredcode is -1 and message explains the failureFields
codeintegerrequiredStatus code of the operation. 1 means success. -1 means failure. 0 means process moved to background
Example:
0messagestringrequiredMessage describing the status
Example:
successrequest_idstringUnique trace ID for the request. Echoed from X-Request-Id header or auto-generated.
Example:
8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312dataobjectrequiredEmpty, except on a
POST /v1/stores 502 where the store was created but a follow-up step failed: it then carries store_uuid and store_group so the store can be fixed with PUT or removed with DELETE.Fields
store_uuidstringExample:
699ec31355208b213e56059astore_groupstringExample:
linked_store_id_abcSomething missing or unclear? Write to support@streamoid.com.