Sign InBook a Demo
Support

Product APIs

GETRetrieve Product

Retrieves product data.

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

Authorization

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

Query parameters

store_uuidstringrequired
Example: 67762d4ce590324df813bd8c
sku_codesstring[]
List of SKU Codes or Style codes based on selected type to be retrieved
Example: CI001
ontologystring
Ontology name for product taxonomy (e.g. SMP, amazon, brand). If not provided, auto-detected from store taxonomy settings.
Example: SMP
offsetintegerdefault: 0
Example: 0
limitintegerdefault: 100
Example: 100
statusstring
Filter by product status.
Allowed: active new problem inactive draft under review

Headers

X-Request-Idstring
Optional trace ID. If not provided, one is generated automatically

Responses

200Data retrieval successful. A search or product-lookup failure (e.g. a downstream timeout, or no matching product) is reported in the response body via status.code -1 and status.message, not as a non-200 status.
statusobjectrequired
Status of the operation, including code and message
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
Data including store UUID, marketplace, and associated SKU data
Fields
store_uuidstringrequired
Unique identifier for the store
productsobject[]default: []
List of products with their attributes and assets
totalinteger
Total count of matching products
Example: 42
400Store/ontology resolution rejected the request: the store doesn't exist, the requested ontology isn't one of the store's own channels, or the store has no taxonomy configured.
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
413Payload too large
statusstringdefault: "error"
The status of the request, typically 'error'
detailstringrequired
A description of the error
422Validation Error
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

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

esc