Developer Guide

Errors

Catalogix Platform uses HTTP status codes to indicate success or failure of an API call. In general, status codes in the 2xx range means success, 4xx range means there was an error in the provided information, and those in the 5xx range indicate server side errors. Every error response keeps the {status: {code, message}, data} body, so branch on the HTTP status rather than on status.code.

CodeDescription
200Success: The request was successfully completed.
400Bad request: The store or ontology could not be resolved, for example the store has no taxonomy set or the ontology is not enabled on it.
401Unauthorized: The bearer token is missing or invalid.
403Forbidden: The token is valid but has no access to the store or linked store.
404Resource Not Found: The store does not exist, or the URL is wrong.
405Method Not Allowed: The HTTP method is not supported for this API.
413Payload too large: The request carries more than 100 data items, the body is over 10 MiB, or an uploaded image is too large.
422Validation Error: A parameter or body field is invalid. The response lists each failing field.
429Too many requests: Too many requests within a certain time frame. Check API rate limits.
500Server error: An unexpected error occurred. If it persists, contact us at support@catalogix.ai.
502Bad gateway: A service the API depends on failed. Retrying later usually succeeds.
503Service unavailable: The feature is not available for this store yet, for example search before the store is indexed.

Each endpoint page lists the statuses that endpoint returns and what triggers them.

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

esc