Sign InBook a Demo
Support

Collection APIs

GETGet Collections

Retrieve collections for a store, with optional status filtering.

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

Authorization

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

Query parameters

store_uuidstringrequired
Store identifier
Example: 69785f41c2c01fdb81c697b3
statusstring
Comma-separated status filter. Allowed values: active, inactive, hidden. Any other value is rejected with 422.
Example: active,inactive
limitinteger
Maximum number of collections to return (1 to 1000).

Headers

X-Request-Idstring
Optional trace ID

Responses

200Successful response.
statusobject
Fields
codeinteger
0 = success, -1 = error
Example: 0
messagestring
Example: SUCCESS
request_idstring
Example: 8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312
dataobject[]
Item fields
namestring
Example: Shirts
descriptionstring
thumbnailstring
statusstring
Allowed: active inactive hidden
Example: active
urlstring
Example: Shirts69b29578c653e5cf72206d77
displayPreferencestring
Example: product
autoRefreshboolean
minProductsinteger
totalProductsinteger
metaobject
Fields
titlestring
descriptionstring
sortByobject
Fields
staticobject
Fields
qualityScoreboolean
Example: false
trendScoreboolean
Example: false
personalizationboolean
Example: false
dynamicobject[]
filtersobject
heroProductsstring[]
groupsobject[]
bannerUrlstring
staticstring
401Unauthorized – Bearer token missing or invalid
statusobject
Fields
codeinteger
Example: -1
messagestring
Example: Unauthorized – invalid or missing Bearer token
403The identity check rejected the caller: the token is not valid for this store
statusobjectrequired
Fields
codeinteger
Allowed: 1
Example: 1
messagestring
Example: Unable to verify caller identity
404No store with this `store_uuid`
statusobjectrequired
code is -1 and message explains the failure
Fields
codeintegerrequired
Status code of the operation. 1 means success. -1 means failure. 0 means process moved to background
Example: 0
messagestringrequired
Message describing the status
Example: success
request_idstring
Unique trace ID for the request. Echoed from X-Request-Id header or auto-generated.
Example: 8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312
dataobjectrequired
Empty, 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_uuidstring
Example: 699ec31355208b213e56059a
store_groupstring
Example: linked_store_id_abc
422A parameter is missing or invalid
detailobject[]
Item fields
locstring | integer[]requireddefault: ["body",""]
msgstringrequireddefault: "Field Required"
typestringrequireddefault: "missing"
500Internal server error
statusobject
Fields
codeinteger
Example: -1
messagestring
Example: Internal server error. Please contact support@catalogix.ai
502The collection service is unavailable or failed
statusobjectrequired
code is -1 and message explains the failure
Fields
codeintegerrequired
Status code of the operation. 1 means success. -1 means failure. 0 means process moved to background
Example: 0
messagestringrequired
Message describing the status
Example: success
request_idstring
Unique trace ID for the request. Echoed from X-Request-Id header or auto-generated.
Example: 8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312
dataobjectrequired
Empty, 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_uuidstring
Example: 699ec31355208b213e56059a
store_groupstring
Example: linked_store_id_abc

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

esc