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

Publish a collection version to the storefront

Makes body.version live: as the collection’s main version, or for its market / market group (retiring that market’s previously live version). Writes the version’s content blocks, product duplicates and image settings to Shopify metafields/metaobjects, then triggers the order sync-back. The path’s must equal body.version. An unknown version is a 404 and writes nothing. Requires collection versions in the plan (402 otherwise). Returns null.

PUT

/

collections

/

{collection_id}

/

publish_version

/

{version}

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

collection_id

string

required

Numeric Shopify collection id.

version

string<uuid>

required

The version's UUID.

Query Parameters

merchant_id

string

required

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

Body

application/json

version

string<uuid>

required

content_blocks

string[]

required

Content block ids enabled on this version.

product_duplicates

string[]

required

image_settings

string[]

required

Response

Published.