Apply one automated sort to many collections

Error

A valid request URL is required to generate request examples

{
  "updated": 123,
  "errors": [
    {
      "collection_id": "<string>",
      "error": "<string>"
    }
  ],
  "warnings": [
    "<string>"
  ],
  "published": 123
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

PUT

collections

bulk-automated-sorting

Error

A valid request URL is required to generate request examples

{
  "updated": 123,
  "errors": [
    {
      "collection_id": "<string>",
      "error": "<string>"
    }
  ],
  "warnings": [
    "<string>"
  ],
  "published": 123
}

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

Query Parameters

merchant_id

string

required

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

Body

application/json

collection_ids

string[]

required

1–100 numeric Shopify collection ids; duplicates are applied once.

Required array length: 1 - 100 elements

sort_order

enum<string>

required

An automated order. MANUAL (per-collection pins) and METAFIELD_* (a per-version key) cannot be applied in bulk.

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

use_collection_specific_boost_bury

boolean

required

collection_boost_rules

object[]

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

publish_non_live

boolean

default:false

Also activate the collections that are not live.

unpin_oos

boolean

default:false

Response

The rollup.

updated

integer

required

Collections the change was applied to.

errors

object[]

required

Per-collection failures; the rest still applied.

Show child attributes

warnings

string[]

required

published

integer

required

Collections activated by publish_non_live.