Sign InBook a Demo
Support

Product APIs

POSTCreate Product

Inserts new product data into the system.

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

Authorization

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

Query parameters

store_uuidstringrequired
Example: 67762d4ce590324df813bd8c

Headers

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

Body

application/json required

An array of objects. Each item:

parent_codestringrequired
product parent code
Example: CI001
Image URL 1string
Image URL 1
Example: https://assets-test.catalogix.ai/dee9c181338099b931cde78787df567a
statusstringdefault: "new"
Allowed: active new problem inactive draft under review
Example: inactive
product_codestringrequired
Unique identifier for the product (SKU code)
Example: CI001-BLU

Responses

200Insert successful
statusobjectrequired
Status of the operation
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
Information related to insertion of each products
Fields
store_uuidstringrequired
Unique identifier for the store
Example: 67762d4ce590324df813bd8c
failed_productsobject
Products that failed to insert. Keyed by product_code with error details as value.
successful_product_codesstring[]
existing_product_codesstring[]default: ["CI001"]
400Invalid data format
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
404Mapping profile not found
statusstringdefault: "error"
The status of the request, typically 'error'
detailstringrequired
A description of the error
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
502Downstream service unavailable
statusstringdefault: "error"
The status of the request, typically 'error'
detailstringrequired
A description of the error

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

esc