A valid request URL is required to generate request examples[
{
"main_product_id": "<string>",
"title": "<string>",
"handle": "<string>",
"images": [
{
"id": "<string>",
"url": "<string>",
"width": 123,
"height": 123,
"alt": "<string>"
}
],
"tags": [
"<string>"
],
"price": 123,
"status": "ACTIVE",
"has_online_store_channel": true,
"in_stock": true,
"quantity": 123,
"badges": [
{
"type": "on_sale",
"sale_percentage": 123,
"markets_on_sale": [
{
"market_id": "<string>",
"display_name": "<string>"
}
],
"total_markets": 123,
"market_group_display_name": "<string>"
}
],
"skus": [
"<string>"
],
"created_at": "<string>",
"published_at": "<string>",
"variants": [
{
"id": "<string>",
"title": "<string>",
"sku": "<string>",
"quantity_available": 123,
"image_url": "<string>",
"selected_options": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"sort_index": 123,
"market_quantities": {},
"variant_ids_in_collection": [
"<string>"
],
"variants_in_collection": 123,
"variants_total": 123,
"applied_boost_bury_rule": {
"strength": 123,
"type": "badge",
"badge": "on_sale",
"top_n": 123
},
"metafield_sort_value": "<string>"
}
]{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Preview a collection's products under a sort
Returns the collection’s products ordered as sort_order (and the given version’s pins and rules) would order them on the storefront. The body previews unsaved rules, pins, groupings or a metafield sort; send {} (or null fields) to use the saved ones. Read-only despite POST.
A valid request URL is required to generate request examples[
{
"main_product_id": "<string>",
"title": "<string>",
"handle": "<string>",
"images": [
{
"id": "<string>",
"url": "<string>",
"width": 123,
"height": 123,
"alt": "<string>"
}
],
"tags": [
"<string>"
],
"price": 123,
"status": "ACTIVE",
"has_online_store_channel": true,
"in_stock": true,
"quantity": 123,
"badges": [
{
"type": "on_sale",
"sale_percentage": 123,
"markets_on_sale": [
{
"market_id": "<string>",
"display_name": "<string>"
}
],
"total_markets": 123,
"market_group_display_name": "<string>"
}
],
"skus": [
"<string>"
],
"created_at": "<string>",
"published_at": "<string>",
"variants": [
{
"id": "<string>",
"title": "<string>",
"sku": "<string>",
"quantity_available": 123,
"image_url": "<string>",
"selected_options": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"sort_index": 123,
"market_quantities": {},
"variant_ids_in_collection": [
"<string>"
],
"variants_in_collection": 123,
"variants_total": 123,
"applied_boost_bury_rule": {
"strength": 123,
"type": "badge",
"badge": "on_sale",
"top_n": 123
},
"metafield_sort_value": "<string>"
}
]{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
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
Numeric Shopify collection id.
Query Parameters
Lite merchant id, e.g. shopify-<shop id>.
How Depict sorts the collection. MANUAL keeps the pinned order; METAFIELD_ASC/DESC sort by the version's metafield_sort key.
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 The version whose saved settings apply; absent = main.
Body
Unsaved collection rules to preview; null = the saved ones.
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
Show child attributes
Unsaved pins to preview; null = the saved ones.
Unsaved groupings to preview; null = the saved ones.
Show child attributes
Show child attributes
Response
The products in grid order.
Shopify product id (numeric string).
Show child attributes
Show child attributes
ACTIVE, ARCHIVED, DRAFT, SCHEDULED, UNLISTED Whether the Online Store sales channel is enabled; null when ingestion has not stamped it.
Summed available quantity over variants.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Position in the collection's sort, ignoring pins.
Available quantity per market id.
Show child attributes
Show child attributes
The rule that moved this product, if any.
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
The sort metafield's value under a METAFIELD_* sort.
Was this page helpful?

