Error

A valid request URL is required to generate request examples

{
  "status": "success"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

API Reference

Schedule a collection version to publish later

Sets when the version is published automatically (by a cron, within minutes of the time); replaces any earlier schedule. Records the caller as the scheduler. Nothing is published now. Scheduling the main version is the normal way to time a publish of the live configuration; it is valid even when that version is already the one the storefront shows. Requires scheduled publishing in the plan (402 otherwise); schedules already set still publish.

PUT

/

collections

/

{collection_id}

/

schedule_version

/

{version}

Error

A valid request URL is required to generate request examples

{
  "status": "success"
}

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

scheduled_publish_at

string<date-time>

required

ISO 8601 date-time with seconds and Z or an offset, e.g. 2026-10-01T08:00:00Z (what Date.toISOString() produces).

Response

Scheduled.

status

enum<string>

required

Available options:

success