Get products in demand
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/back_in_stock/reports/products_in_demandCosts 1 rate-limit point · Rate limits
The Products in demand table: variants (or products) ranked by back-in-stock demand, with signups created in the window, how many of them are still waiting, and the last request.
The same rows as the dashboard table. total counts signups created in the window; pending counts those of them not yet notified. count_by=customers counts a shopper signed up on several channels once; omitted, it follows the dashboard default, and the response's count_by says which. group_by=product ranks products instead of variants. search matches product title or SKU; vendors, tags and shopify_market_ids are comma-separated lists, as the table's filters. Deleted variants are hidden when the shop's dashboard hides them. image_url is the variant's image, else the product's. Variant rows only: include_inventory=true adds inventory_available, the stock available in the locations the shop's market or location filter allows (summed, null when Shopify has no level), and include_prices=true adds price and compare_at_price in the shop's currency, as the table's Inventory and Price columns. Each asks Shopify once per page. include_totals=true adds totals { pending, total }, the pending and total columns summed over every row the filters keep, not just this page.
Also searched asdemand reportwhat should I restockmost wanted productstop requested variantsproducts in demandrestock priorities
Query parameters
group_bystringReturn a row per variant or per product. Default variant.
One ofvariantproductsort_bystringColumn to sort rows by. Default pending.
One ofpendingtotallast_requested_atDefault"pending"directionstringSort direction. Default desc.
One ofascdescDefault"desc"count_bystringCount a shopper signed up on several channels once (customers) or each signup (signups). Default is the shop's dashboard setting.
One ofcustomerssignupsinclude_inventorybooleanWhen true, variant rows include the available stock. Variant rows only.
Defaultfalseinclude_pricesbooleanWhen true, variant rows include price and compare-at price. Variant rows only.
Defaultfalseinclude_totalsbooleanWhen true, the response adds pending and total summed over every row the filters keep.
DefaultfalsefromstringStart of the window, an ISO 8601 date or date-time; a bare date starts at midnight in the shop's time zone. Default 30 days ago.
tostringEnd of the window, an ISO 8601 date or date-time; a bare date runs to the end of that day in the shop's time zone. Default today.
rangestringSet to all_time for the shop's whole history instead of from/to.
One ofall_timeshopify_market_idsstringComma-separated Shopify market gids or numeric ids to keep.
searchstringOnly rows whose product title or SKU contains this text.
vendorsstringComma-separated product vendors to keep.
tagsstringComma-separated product tags to keep.
pageintegerPage of results to return, starting at 1.
Default1per_pageintegerRows per page, 1 to 500. Default 25.
Default25
Returns
windowobject, nullableThe date range the figures cover. Null when range is all_time.
Show 2 child attributesHide child attributes
fromstringStart of the range, ISO 8601.
tostringEnd of the range, ISO 8601.
group_bystringExample:variantsort_bystringExample:pendingdirectionstringExample:desccount_bystringExample:customersrowsarray of objectsShow 14 child attributesHide child attributes
shopify_variant_idstringExample:gid://shopify/ProductVariant/47284734423096shopify_product_idstringExample:gid://shopify/Product/8784906035384variant_titlestring, nullableExample:Blue / Mediumproduct_titlestring, nullableExample:Classic Sneakerskustring, nullableExample:CS-BLU-Mimage_urlstring, nullabledeletedbooleanvariants_countintegerpendingintegerExample:47totalintegerExample:89last_requested_atstringExample:2026-06-25T11:30:00Zinventory_availableinteger, nullablepricestring, nullablecompare_at_pricestring, nullable
metaobjectPagination for the list.
Show 4 child attributesHide child attributes
total_countintegerItems matching the filters, across all pages.
pageintegerPage returned, starting at 1.
per_pageintegerMost items per page.
total_pagesintegerPages available at this per_page; 0 when nothing matches.
Errors
invalid_paramsOne or more fields failed the action's schema.
validation_failedThe action refused the request for a reason that is not a single bad field.
Any request can also fail with auth_invalid (401) or rate_limited (429).
Every error has the same shape: see Errors and the list of error codes.
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/reports/products_in_demand" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/reports/products_in_demand", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/back_in_stock/reports/products_in_demand",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/back_in_stock/reports/products_in_demand")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)curl "https://app.stoqapp.com/api/v2/external/back_in_stock/reports/products_in_demand?group_by=variant&sort_by=pending&direction=desc" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/reports/products_in_demand?group_by=variant&sort_by=pending&direction=desc", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/back_in_stock/reports/products_in_demand?group_by=variant&sort_by=pending&direction=desc",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/back_in_stock/reports/products_in_demand?group_by=variant&sort_by=pending&direction=desc")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"window": {
"from": "2026-05-26T00:00:00Z",
"to": "2026-06-25T23:59:59Z"
},
"group_by": "variant",
"sort_by": "pending",
"direction": "desc",
"count_by": "customers",
"rows": [
{
"shopify_variant_id": "gid://shopify/ProductVariant/47284734423096",
"shopify_product_id": "gid://shopify/Product/8784906035384",
"variant_title": "Blue / Medium",
"product_title": "Classic Sneaker",
"sku": "CS-BLU-M",
"pending": 47,
"total": 89,
"last_requested_at": "2026-06-25T11:30:00Z"
},
{
"shopify_variant_id": "gid://shopify/ProductVariant/47284734455864",
"shopify_product_id": "gid://shopify/Product/8784906035384",
"variant_title": "Red / Large",
"product_title": "Classic Sneaker",
"sku": "CS-RED-L",
"pending": 23,
"total": 56,
"last_requested_at": "2026-06-25T09:15:00Z"
}
],
"meta": {
"total_count": 287,
"page": 1,
"per_page": 50,
"total_pages": 6
}
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"name is required"
],
"code": "validation_failed",
"details": [
{
"code": "validation_failed",
"message": "name is required",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited",
"details": [
{
"code": "rate_limited",
"message": "Rate limit exceeded",
"path": null,
"value": null,
"expected": null
}
]
}