Read one collection's Depict configuration

Error

A valid request URL is required to generate request examples

{
  "collection_id": "<string>",
  "title": "<string>",
  "handle": "<string>",
  "image_urls": [
    "<string>"
  ],
  "shopify_sort_order": "MANUAL",
  "sort_order": "ALPHA_ASC",
  "has_depict_configuration": true,
  "sync_back_to_shopify": true,
  "unpin_oos": true,
  "updated_at": "<string>",
  "shopify_updated_at": "<string>",
  "use_collection_specific_boost_bury": true,
  "main_version": "<string>",
  "n_products": 123,
  "description": "<string>",
  "pinned_main_product_ids": [
    "<string>"
  ],
  "collection_boost_rules": [
    {
      "strength": 123,
      "type": "badge",
      "badge": "on_sale",
      "top_n": 123
    }
  ],
  "version": "<string>",
  "tag_badges": [
    "<string>"
  ],
  "collection_badges": [
    "<string>"
  ],
  "metafield_badges": [
    "<string>"
  ],
  "metafield_sort": {
    "key": "<string>",
    "type": "number_integer"
  },
  "active_attachment_ids": [
    "<string>"
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

GET

collections

{collection_id}

Error

A valid request URL is required to generate request examples

{
  "collection_id": "<string>",
  "title": "<string>",
  "handle": "<string>",
  "image_urls": [
    "<string>"
  ],
  "shopify_sort_order": "MANUAL",
  "sort_order": "ALPHA_ASC",
  "has_depict_configuration": true,
  "sync_back_to_shopify": true,
  "unpin_oos": true,
  "updated_at": "<string>",
  "shopify_updated_at": "<string>",
  "use_collection_specific_boost_bury": true,
  "main_version": "<string>",
  "n_products": 123,
  "description": "<string>",
  "pinned_main_product_ids": [
    "<string>"
  ],
  "collection_boost_rules": [
    {
      "strength": 123,
      "type": "badge",
      "badge": "on_sale",
      "top_n": 123
    }
  ],
  "version": "<string>",
  "tag_badges": [
    "<string>"
  ],
  "collection_badges": [
    "<string>"
  ],
  "metafield_badges": [
    "<string>"
  ],
  "metafield_sort": {
    "key": "<string>",
    "type": "number_integer"
  },
  "active_attachment_ids": [
    "<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

Numeric Shopify collection id.

Query Parameters

merchant_id

string

required

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

version

string<uuid>

A version UUID (see GET /collections/{collection_id}/versions); omit for the main version.

Response

The collection.

collection_id

string

required

Numeric Shopify collection id.

title

string

required

Primary-locale title.

handle

string

required

image_urls

string[]

required

shopify_sort_order

enum<string>

required

The collection's own sort order in Shopify.

Available options:

MANUAL,

BEST_SELLING,

ALPHA_ASC,

ALPHA_DESC,

CREATED,

CREATED_DESC,

PRICE_ASC,

PRICE_DESC,

MOST_RELEVANT

sort_order

enum<string>

required

How Depict sorts the collection. MANUAL keeps the pinned order; METAFIELD_ASC/DESC sort by the version's metafield_sort key.

Available options:

ALPHA_ASC,

ALPHA_DESC,

BEST_SELLING,

BEST_SELLING_BY_REVENUE,

MOST_RELEVANT,

TRENDING,

TRENDING_BY_REVENUE,

CREATED,

CREATED_DESC,

PRICE_ASC,

PRICE_DESC,

STOCK_DESC,

CLICKS_DESC,

METAFIELD_ASC,

METAFIELD_DESC,

MANUAL

has_depict_configuration

boolean

required

Whether Depict has saved any configuration (sort, pins, content blocks…) for it.

sync_back_to_shopify

boolean

required

Active: Depict writes its order back to Shopify. False = the collection is not managed by Depict.

unpin_oos

boolean

required

Out-of-stock pinned products drop out of their pins.

updated_at

string | null

required

When the Depict configuration last changed (naive UTC); null on an inactive list row.

shopify_updated_at

string

required

Naive UTC.

use_collection_specific_boost_bury

boolean

required

True: the version's own boost/bury rules apply instead of the merchant-wide ones.

main_version

string | null

required

UUID of the published version; null on an inactive list row.

n_products

integer

required

description

string

required

pinned_main_product_ids

string[]

required

Product ids in the order they are pinned; for MANUAL sort, every product in its manual order.

collection_boost_rules

object[]

required

A merchant-wide rule that moves matching products up (boost) or down (bury) in every automatically sorted collection. type selects how products match.

Option 1
Option 2
Option 3
Option 4

Show child attributes

version

string | null

required

UUID of the version this DTO shows.

tag_badges

string[]

required

collection_badges

string[]

required

metafield_badges

string[]

required

metafield_sort

object | null

required

Show child attributes

active_attachment_ids

string[]

required

Product attachment ids active on this version, in order.