Error

A valid request URL is required to generate request examples

{
  "status": "ok",
  "message": "<string>"
}

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

{
  "detail": "<string>"
}

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

{
  "detail": "<string>"
}

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

{
  "detail": "<string>"
}

API Reference

Connect another store to this merchant's multi-store group

Joins merchant_id and the store whose activation code is given into one multi-store group (creating the group if neither has one). Call it when a merchant enters another store’s activation code. Side effect: writes both merchants’ group. Follow with create-collection-mappings to link their collections by handle. Refused when both stores are already in groups. Requires multi-store in the plan of the caller and of every store it would put into a group (402 otherwise).

POST

/

multi-store

/

connect-store

/

{merchant_id}

Error

A valid request URL is required to generate request examples

{
  "status": "ok",
  "message": "<string>"
}

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

{
  "detail": "<string>"
}

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

{
  "detail": "<string>"
}

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

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

Query Parameters

activation_code

string

required

The OTHER store's multi-store activation code, as shown in its portal.

Response

Connected; message names the other store.

status

enum<string>

required

Available options:

ok

message

string

required

Shown to the merchant.