Skip to main content
GET
Error

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

Response

The products in grid order.

main_product_id
string
required

Shopify product id (numeric string).

title
string
required
handle
string
required
images
object[]
required
tags
string[]
required
price
number | null
required
status
enum<string>
required
Available options:
ACTIVE,
ARCHIVED,
DRAFT,
SCHEDULED,
UNLISTED
has_online_store_channel
boolean | null
required

Whether the Online Store sales channel is enabled; null when ingestion has not stamped it.

in_stock
boolean
required
quantity
integer
required

Summed available quantity over variants.

badges
object[]
required
skus
string[]
required
created_at
string
required
published_at
string | null
required
variants
object[]
required
sort_index
integer
required

Position in the collection's sort, ignoring pins.

market_quantities
object | null
required

Available quantity per market id.

variant_ids_in_collection
string[] | null
required
variants_in_collection
integer | null
required
variants_total
integer | null
required
applied_boost_bury_rule
object

The rule that moved this product, if any.

metafield_sort_value
string | null

The sort metafield's value under a METAFIELD_* sort.