Error

A valid request URL is required to generate request examples

{
  "auto_replicate_enabled": true,
  "auto_replicate_source_merchant_id": "<string>",
  "sync_publish_status": true,
  "replicate_recommendations": true
}

{
  "detail": "<string>",
  "error_code": "NOT_IN_GROUP"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "code": "product_required",
  "product": "search",
  "limit": 123
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

API Reference

Change the multi-store group's settings

Sets the toggles present in the body for merchant_id’s whole group and returns the resulting settings. Side effects: enabling auto_replicate_enabled makes the caller the replication source (if none is recorded) and stamps existing links to replicate from it; enabling sync_publish_status publishes every replica whose source is live and syncs those stores back to Shopify. Switching a toggle from off to on requires multi-store in the plan (402 otherwise); re-sending an unchanged toggle or switching one off never does.

PUT

multi-store

group-settings

{merchant_id}

Error

A valid request URL is required to generate request examples

{
  "auto_replicate_enabled": true,
  "auto_replicate_source_merchant_id": "<string>",
  "sync_publish_status": true,
  "replicate_recommendations": true
}

{
  "detail": "<string>",
  "error_code": "NOT_IN_GROUP"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "code": "product_required",
  "product": "search",
  "limit": 123
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Shopify App Bridge session token of the embedded Depict: Search & Merchandising app. The shop in the token determines the merchant; merchant_id parameters must belong to that shop.

Path Parameters

merchant_id

string

required

Lite merchant id, e.g. shopify-<shop id>.

Body

application/json

Only the toggles being changed; an absent or null toggle is left as it is.

auto_replicate_enabled

boolean | null

sync_publish_status

boolean | null

replicate_recommendations

boolean | null

Response

The group's settings after the change.

auto_replicate_enabled

boolean

required

New cross-store collection links are stamped to replicate from the source store.

auto_replicate_source_merchant_id

string | null

required

The store auto-replication copies from; null until set.

sync_publish_status

boolean

required

Publishing or unpublishing a source collection fans out to its replicas.

replicate_recommendations

boolean

required