Get the fulfillments report
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/reports/fulfillmentsCosts 1 rate-limit point · Rate limits
What is still owed to preorder customers: units sold, cancelled, fulfilled and outstanding (waiting, on hold, scheduled) per variant or product, as the dashboard's fulfillment table.
Units, not orders. cancelled counts every unit on a cancelled order plus units refunded or split off from an open order. sold = cancelled + fulfilled + outstanding, and outstanding = waiting + on_hold + scheduled. Statuses are as of now; the window selects when the units were sold. range=all_time is the dashboard's All time. image_url is the variant's stored image, else the product's (null if none is stored).
Also searched asfulfillment reportwhat do I still oweoutstanding preordersunfulfilled preorder unitspreorders left to ship
Query parameters
rangestringSend all_time for the shop's whole history instead of a from/to window; from and to are then ignored.
One ofall_timenullgroup_bystringReturn one row per variant or per product. Default variant.
One ofvariantproductDefault"variant"fromstringStart of the window, as an ISO 8601 date or time. A bare date starts at midnight in the shop's time zone. Default 30 days ago.
tostringEnd of the window, as an ISO 8601 date or time. A bare date runs to the end of that day in the shop's time zone. Default today.
sort_bystringColumn to sort the rows by. Default outstanding.
One ofoutstandingsoldfulfilledcancelledon_holdscheduledwaitingorder_countlast_order_dateDefault"outstanding"directionstringSort order of the rows. Default desc.
One ofascdescDefault"desc"pageintegerPage of rows to return, starting at 1.
Default1per_pageintegerRows per page, 1 to 100. 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:outstandingdirectionstringExample:desctotalsobjectShow 9 child attributesHide child attributes
soldintegerExample:95cancelledintegerExample:4fulfilledintegerExample:12on_holdintegerExample:61scheduledintegerExample:10waitingintegerExample:8outstandingintegerExample:79order_countintegerExample:88as_ofstring, nullableExample:2026-06-25T15:00:00Z
rowsarray of objectsShow 15 child attributesHide child attributes
shopify_product_idstringExample:gid://shopify/Product/8784906035384shopify_variant_idstringExample:gid://shopify/ProductVariant/47284734423096image_urlstring, nullableExample:https://cdn.shopify.com/s/files/1/0712/3456/7890/files/cl…product_titlestringExample:Classic Sneakervariant_titlestringExample:Blue / MediumskustringExample:CS-BLU-Morder_countintegerExample:58soldintegerExample:64cancelledintegerExample:3fulfilledintegerExample:8on_holdintegerExample:41scheduledintegerExample:7waitingintegerExample:5outstandingintegerExample:53last_order_datestringExample:2026-06-25T10:02:00Z
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
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/preorders/reports/fulfillments" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/reports/fulfillments", {
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/preorders/reports/fulfillments",
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/preorders/reports/fulfillments")
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/preorders/reports/fulfillments?range=all_time&group_by=variant&sort_by=outstanding" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/reports/fulfillments?range=all_time&group_by=variant&sort_by=outstanding", {
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/preorders/reports/fulfillments?range=all_time&group_by=variant&sort_by=outstanding",
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/preorders/reports/fulfillments?range=all_time&group_by=variant&sort_by=outstanding")
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:00-04:00",
"to": "2026-06-25T23:59:59-04:00"
},
"group_by": "variant",
"sort_by": "outstanding",
"direction": "desc",
"totals": {
"sold": 95,
"cancelled": 4,
"fulfilled": 12,
"on_hold": 61,
"scheduled": 10,
"waiting": 8,
"outstanding": 79,
"order_count": 88,
"as_of": "2026-06-25T15:00:00Z"
},
"rows": [
{
"shopify_product_id": "gid://shopify/Product/8784906035384",
"shopify_variant_id": "gid://shopify/ProductVariant/47284734423096",
"image_url": "https://cdn.shopify.com/s/files/1/0712/3456/7890/files/classic-sneaker-blue.jpg",
"product_title": "Classic Sneaker",
"variant_title": "Blue / Medium",
"sku": "CS-BLU-M",
"order_count": 58,
"sold": 64,
"cancelled": 3,
"fulfilled": 8,
"on_hold": 41,
"scheduled": 7,
"waiting": 5,
"outstanding": 53,
"last_order_date": "2026-06-25T10:02:00Z"
},
{
"shopify_product_id": "gid://shopify/Product/8784906035384",
"shopify_variant_id": "gid://shopify/ProductVariant/47284734455864",
"image_url": "https://cdn.shopify.com/s/files/1/0712/3456/7890/files/classic-sneaker-red.jpg",
"product_title": "Classic Sneaker",
"variant_title": "Red / Large",
"sku": "CS-RED-L",
"order_count": 30,
"sold": 31,
"cancelled": 1,
"fulfilled": 4,
"on_hold": 20,
"scheduled": 3,
"waiting": 3,
"outstanding": 26,
"last_order_date": "2026-06-24T18:40:00Z"
}
],
"meta": {
"total_count": 2,
"page": 1,
"per_page": 25,
"total_pages": 1
}
}{
"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
}
]
}