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>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

API Reference

Read a collection version's content cards

Returns the content cards (image, video and text tiles placed in the collection’s product grid) of one collection version, in stored order, read from Shopify. Each card is in the shape PATCH /brand-features/{collection_id} accepts, plus read-only fields PATCH ignores (metaobject_id, clicks_id, image_url, hover_image_url, link.name). Read the cards before changing them: PATCH replaces a card’s settings with the card it is sent. Version ids come from GET /collections/{collection_id}/versions. Read-only.

GET

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>"
    }
  ]
}

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

Response

The version's cards; cards is empty when it has none.

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