Sign InBook a Demo
Support

Store APIs

POSTCreate Store

POSThttps://api.catalogix.ai/v1/stores
Creates a store in the caller's workspace and applies its default automation. image_upload is always enabled in addition to the automations listed in default_automation. Every entry in region, channels and default_automation must be unique and non-blank, channels are checked against the default marketplaces, and region and channels must not be empty. store_website, when given and not empty, must be an absolute http or https URL. linked_store_id joins the new store to the group of that store and requires access to it. With copy_taxonomy=true the brand taxonomy of the linked store is also copied: this needs linked_store_id, store_taxonomy of brand, and a linked store that has a brand taxonomy. If the store was created but copying the taxonomy or applying the default automation failed, the response is a 502 whose data carries the new store_uuid and store_group. A brand store needs either exactly one channel, which must be a custom marketplace enabled for the caller's workspace and not a default channel (it becomes the store's brand), or copy_taxonomy=true with linked_store_id and no channels, in which case the copied taxonomy becomes the brand; with neither it is refused. SMP is added to every brand store. A catalogix store requires channels and is limited to the default channels.

Authorization

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

Query parameters

copy_taxonomybooleandefault: false
Copy the brand taxonomy of linked_store_id into the new store. Requires linked_store_id and store_taxonomy of brand.
linked_store_idstring
Store whose group the new store joins. The caller needs access to it.

Headers

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

Body

application/json required

store_namestringrequired
store_taxonomystringrequired
Allowed: catalogix brand
store_websitestring
Absolute http or https URL; empty for none
regionstring[]required
List of regions for the store.
Allowed: India Africa Asia Europe Global Middle East North America Oceania South America
channelsstring[]
Marketplace channels for the store. A catalogix store requires it and uses the default channels available in the store's region values (Global channels are always included). A brand store takes either exactly one custom marketplace enabled for the caller's workspace, which becomes its brand, or no channels together with copy_taxonomy=true and linked_store_id. A default channel on a brand store, or any other invalid channel, returns 422 listing the allowed ones. SMP is always added to a brand store.
default_automationstring[]required
Allowed: color_distribution analyze_attribute analyze_image mask_computation product_listing_audit image_automation bulk_actions uniqueness_checker product_quality_score detail_shot_generator infographic_creator video_generation size_chart_creator data_sync_to_external delete_product_images bulk_edit data_export text_classifier optical_character_recognition image_classifier image_classifier_express image_classifier_precise conditional_attribution product_description product_title_generation SEO_Automations swatch_generation image_type image_upload bulk_image_upload hotspot_generation unique_content_generator master_automation multimedia_visibility background_removal face_swap service-1 service-2 service-3 service-4 service-5 metadata_translation image_translation update_availability smp_upgrade SMP_image_upsert

Responses

200The store was created and its default automation applied.
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
Created store identifiers
Fields
store_uuidstring
Example: 699ec31355208b213e56059a
store_groupstring
Example: linked_store_id_abc
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 `linked_store_id`, or the store service refused the caller's token when creating 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
413Request body over 10 MiB
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
422Validation Error: a missing or invalid field, an unknown channel or automation, a taxonomy copy that is not allowed, or a store rejected by the store service (for example a name already in use)
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 was not created, access to `linked_store_id` could not be verified, or the store was created but copying the taxonomy, setting its brand or applying the default automation failed (then `data` carries `store_uuid` and `store_group`)
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