Store APIs
PUTUpdate Store
Requests go to the live API through streamoid.com and act on your real data.
Updates the given fields of a store; fields that are omitted keep their current value. At least one field is required.
Lists must be unique, non-blank and, for
channels and region, not empty. Channels and automations are checked only when they are part of the request. Sending default_automation replaces the store's default automation with exactly that list (an empty list clears it); omitting it leaves it unchanged.
Channels replace the current list and must be default marketplaces or ones the store already has; they cannot be changed on a brand store (422).
A store name already used in the workspace returns 422.Authorization
AuthorizationstringrequiredheaderBearer token,
Bearer <token>. Create one under Tokens in your workspace.Query parameters
store_uuidstringrequiredStore identifier
Example:
67762d4ce590324df813bd8cHeaders
X-Request-IdstringOptional trace ID. If not provided, one is generated automatically
Body
application/json required
store_namestringstore_websitestringAbsolute http or https URL; empty for none
regionstring[]Updated list of regions.
Allowed:
India Africa Asia Europe Global Middle East North America Oceania South Americachannelsstring[]Marketplace channels for the store; replaces the current list. Each must be a default channel available in the store's regions (the
region sent in the same request, otherwise the stored one) or one the store already has. Not allowed on a brand store, where it returns 422.default_automationstring[]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_upsertResponses
200The store was updated.
statusobjectrequiredStatus of the operation
Fields
codeintegerrequiredStatus code of the operation. 1 means success. -1 means failure. 0 means process moved to background
Example:
0messagestringrequiredMessage describing the status
Example:
successrequest_idstringUnique trace ID for the request. Echoed from X-Request-Id header or auto-generated.
Example:
8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312401Unauthorized – Bearer token missing or invalid
statusobjectFields
codeintegerExample:
-1messagestringExample:
Unauthorized – invalid or missing Bearer token403The caller has no access to the store
statusobjectrequiredcode is -1 and message explains the failureFields
codeintegerrequiredStatus code of the operation. 1 means success. -1 means failure. 0 means process moved to background
Example:
0messagestringrequiredMessage describing the status
Example:
successrequest_idstringUnique trace ID for the request. Echoed from X-Request-Id header or auto-generated.
Example:
8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312dataobjectrequiredEmpty, 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_uuidstringExample:
699ec31355208b213e56059astore_groupstringExample:
linked_store_id_abc404No store with this `store_uuid`
statusobjectrequiredcode is -1 and message explains the failureFields
codeintegerrequiredStatus code of the operation. 1 means success. -1 means failure. 0 means process moved to background
Example:
0messagestringrequiredMessage describing the status
Example:
successrequest_idstringUnique trace ID for the request. Echoed from X-Request-Id header or auto-generated.
Example:
8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312dataobjectrequiredEmpty, 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_uuidstringExample:
699ec31355208b213e56059astore_groupstringExample:
linked_store_id_abc413Request body over 10 MiB
statusobjectrequiredcode is -1 and message explains the failureFields
codeintegerrequiredStatus code of the operation. 1 means success. -1 means failure. 0 means process moved to background
Example:
0messagestringrequiredMessage describing the status
Example:
successrequest_idstringUnique trace ID for the request. Echoed from X-Request-Id header or auto-generated.
Example:
8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312dataobjectrequiredEmpty, 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_uuidstringExample:
699ec31355208b213e56059astore_groupstringExample:
linked_store_id_abc422Validation Error: an empty update, an invalid field, or an unknown channel or automation
detailobject[]Item fields
locstring | integer[]requireddefault: ["body",""]msgstringrequireddefault: "Field Required"typestringrequireddefault: "missing"500Internal server error
statusobjectFields
codeintegerExample:
-1messagestringExample:
Internal server error. Please contact support@catalogix.ai502The store service is unavailable
statusobjectrequiredcode is -1 and message explains the failureFields
codeintegerrequiredStatus code of the operation. 1 means success. -1 means failure. 0 means process moved to background
Example:
0messagestringrequiredMessage describing the status
Example:
successrequest_idstringUnique trace ID for the request. Echoed from X-Request-Id header or auto-generated.
Example:
8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312dataobjectrequiredEmpty, 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_uuidstringExample:
699ec31355208b213e56059astore_groupstringExample:
linked_store_id_abcSomething missing or unclear? Write to support@streamoid.com.