A valid request URL is required to generate request examples{
"products": [
{
"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>"
}
]
}
]
}
],
"total": 123
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Search or page through a merchant's products
Finds products whose title, any variant SKU, product id or any tag contains query (case-insensitive); an exact product-id match sorts first. A blank query pages the whole catalogue, or one collection with collection_id (in the collection’s order unless sort is given), and also returns the scope’s total. Read-only. Use it to look up products by name/SKU/id before calling the per-product routes.
A valid request URL is required to generate request examples{
"products": [
{
"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>"
}
]
}
]
}
],
"total": 123
}{
"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.
Query Parameters
Lite merchant id, e.g. shopify-<shop id>.
Text to match; omit or leave blank to browse.
1 <= x <= 100x >= 0Limit to this Shopify collection's products; an empty value means no limit.
Order by title. Without it: collection order when scoped, else exact-id match then title.
title Was this page helpful?

