Sign InBook a Demo
Support

Product APIs

GETRetrieve Product

Retrieves product data.

GEThttps://api.catalogix.ai/v1/products
Retrieves product data. With sku_codes and no status, those products are looked up directly. With a status, or with no sku_codes, the store's products for the ontology are listed page by page using offset and limit, and the response carries the total number of matching products. Each product is keyed by its product_code and carries the ontology's attributes, its status and its parent_code. Assets are attached only for catalogix-taxonomy stores.

Authorization

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

Query parameters

store_uuidstringrequired
Example: 67762d4ce590324df813bd8c
sku_codesstring[]
Product codes (SKU) to retrieve, at most 100. A blank or repeated code fails with 422. When omitted, the store's products are listed using offset and limit.
ontologystring
Ontology (marketplace) name, e.g. SMP or amazon. For a catalogix-taxonomy store it must be enabled on the store's channels, or the request fails with 400. For a brand-taxonomy store with a brand set it must equal that brand, or the request fails with 400; with no brand set it is ignored and the brand taxonomy decides. If not provided, auto-detected: catalogix stores use SMP, brand stores use the store's brand, or the first marketplace of the brand taxonomy when no brand is set.
Example: SMP
offsetintegerdefault: 0
Number of products to skip. Must be 0 or more.
Example: 0
limitintegerdefault: 100
Maximum number of products to return, from 1 to 100.
Example: 100
statusstring
Filter by product status. Case and surrounding spaces are ignored; any other value fails with 422.
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
Number of products matching the status filter and sku_codes across all pages, for paging with offset and limit. Returned only when listing (a status filter, or no sku_codes); omitted when looking up specific sku_codes or when the count is unavailable.
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
413More than 100 sku_codes
statusstringdefault: "error"
The status of the request, typically 'error'
detailstringrequired
A description of the error
422Validation error: a non-numeric or out-of-range offset or limit, an unknown status, or a blank or repeated sku_code
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