Error

A valid request URL is required to generate request examples

null

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

API Reference

Connect or release collections across the group's stores

Puts connect.collections into one cross-store connection (an existing group_collection_id, or a new one) and/or releases disconnect.collections from theirs (the mapping row stays, unlinked). Every merchant named must belong to the group. Side effects: writes mapping rows; if the group has auto-replicate on, new links are stamped to replicate from its source. Connecting requires multi-store in the caller’s plan (402 otherwise); releasing never does. Answers null.

POST

/

multi-store

/

collection-mappings

/

{group_id}

Error

A valid request URL is required to generate request examples

null

{
  "detail": "<string>"
}

{
  "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

group_id

string<uuid>

required

The multi-store group's uuid (the merchant's multi_store_group_id).

Body

application/json

connect

object | null

required

Show child attributes

disconnect

object | null

required

Collections to take out of their connection (their mapping row is kept, unlinked).

Show child attributes

Response

Written.