Error

A valid request URL is required to generate request examples

{
  "version": "<string>",
  "cards": [
    {
      "handle": "<string>",
      "index": 123,
      "span_rows": 123,
      "span_columns": 123,
      "aspect_ratio": 123,
      "content": {
        "type": "image",
        "gid": "<string>",
        "filename": "<string>",
        "alt_text": "<string>"
      },
      "metaobject_id": "<string>",
      "clicks_id": 123,
      "visibility": "desktop",
      "hover_image": {
        "type": "image",
        "gid": "<string>",
        "filename": "<string>",
        "alt_text": "<string>"
      },
      "text": {
        "header": {
          "html_tag": "<string>",
          "color_hex": "<string>",
          "bold": true,
          "italic": true,
          "underline": true,
          "text": "<string>",
          "translations": {}
        },
        "body": {
          "html_tag": "<string>",
          "color_hex": "<string>",
          "bold": true,
          "italic": true,
          "underline": true,
          "text": "<string>",
          "translations": {}
        },
        "horizontal_alignment": "start",
        "vertical_alignment": "start",
        "background_overlay": "<string>",
        "overlay_style": "solid",
        "text_shadow": true,
        "gap": "<string>"
      },
      "link": {
        "type": "collection",
        "gid": "<string>",
        "handle": "<string>",
        "url": "<string>",
        "article_handle": "<string>",
        "name": "<string>"
      },
      "image_url": "<string>",
      "hover_image_url": "<string>"
    }
  ],
  "reread_failed": true
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

API Reference

Add, change or remove some of a collection version's content cards

Merges changes into one collection version’s content cards: cards the body does not name are left exactly as they are. Read the cards first with GET /brand-features/{collection_id}, then send each card you change whole, as GET returned it with only your change applied: a field left out is cleared. A handle of this version’s cards updates that card in place; a card without a handle is created and placed first. A handle that belongs to a card outside this collection version is refused (409). delete_handles removes cards from this version. Versions of a collection can share a card, so an update shows in every version that lists it. Send one PATCH at a time per collection: a PATCH that races another is refused (409) and must be retried from a fresh GET. Media must be existing Shopify file gids (for example one another card uses); uploading new images or videos is not available. Side effects: Shopify metaobject writes, live on the storefront at once when the version is the collection’s published one. Returns the version’s resulting cards in GET’s shape, including generated handles. Give each new card a handle of your own (lowercase letters, digits, -, _), so resending a PATCH whose answer you lost updates the card instead of creating it twice.

PATCH

brand-features

{collection_id}

Error

A valid request URL is required to generate request examples

{
  "version": "<string>",
  "cards": [
    {
      "handle": "<string>",
      "index": 123,
      "span_rows": 123,
      "span_columns": 123,
      "aspect_ratio": 123,
      "content": {
        "type": "image",
        "gid": "<string>",
        "filename": "<string>",
        "alt_text": "<string>"
      },
      "metaobject_id": "<string>",
      "clicks_id": 123,
      "visibility": "desktop",
      "hover_image": {
        "type": "image",
        "gid": "<string>",
        "filename": "<string>",
        "alt_text": "<string>"
      },
      "text": {
        "header": {
          "html_tag": "<string>",
          "color_hex": "<string>",
          "bold": true,
          "italic": true,
          "underline": true,
          "text": "<string>",
          "translations": {}
        },
        "body": {
          "html_tag": "<string>",
          "color_hex": "<string>",
          "bold": true,
          "italic": true,
          "underline": true,
          "text": "<string>",
          "translations": {}
        },
        "horizontal_alignment": "start",
        "vertical_alignment": "start",
        "background_overlay": "<string>",
        "overlay_style": "solid",
        "text_shadow": true,
        "gap": "<string>"
      },
      "link": {
        "type": "collection",
        "gid": "<string>",
        "handle": "<string>",
        "url": "<string>",
        "article_handle": "<string>",
        "name": "<string>"
      },
      "image_url": "<string>",
      "hover_image_url": "<string>"
    }
  ],
  "reread_failed": true
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

The Shopify collection id (numeric, no gid prefix).

Query Parameters

merchant_id

string

required

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

version

string<uuid>

required

The collection version (UUID) the features belong to.

Body

application/json

upsert

object[]

Cards to create or update. Each is written whole: send the complete card as GET returned it with your change applied (omitting link, text, hover_image or visibility clears it). Read-only fields such as metaobject_id are ignored.

Show child attributes

delete_handles

string[]

Handles of this version's cards to remove from it. The card itself is deleted unless another version of the collection still lists it.

Pattern: ^[a-z0-9_-]+$

Response

Saved; the version's cards after the change.

version

string

required

The collection version (UUID) the cards belong to.

cards

object[]

required

The version's cards in stored order (when two cards claim the same grid slot, the earlier one wins).

Show child attributes

reread_failed

enum<boolean>

Present when the save succeeded but reading the cards back failed: cards then holds only the cards this PATCH wrote, as sent, with their handles and ids. Do not resend the PATCH; GET the version for its full list.

Available options:

true