Sign InBook a Demo
Support

Store APIs

GETRetrieve Store Details

GEThttps://api.catalogix.ai/v1/stores
Returns the settings of one store. enabled_automations lists the names of the automations enabled for it.

Authorization

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

Query parameters

store_uuidstringrequired
Store identifier
Example: 67762d4ce590324df813bd8c

Headers

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

Responses

200The store settings.
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
store UUID, marketplace, and associated store info
Fields
store_namestring
Example: Sample store
workspace_idstring
Example: 63cf68de170652cc42382d5a
linked_store_idstring
Example: linked store
store_websitestring
Example: https://test.com
countrystring[]
channelsobject
Channel name to its marketplace id
store_taxonomystring
Example: catalogix
enabled_automationsstring[]
Names of the automations enabled for the store
401Unauthorized – Bearer token missing or invalid
statusobject
Fields
codeinteger
Example: -1
messagestring
Example: Unauthorized – invalid or missing Bearer token
403The caller has no access to the store
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
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
422`store_uuid` is missing or blank
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 store service is unavailable
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