Skip to content

Get the fulfillments report

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

GET/preorders/reports/fulfillments

Costs 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

  • rangestring

    Send all_time for the shop's whole history instead of a from/to window; from and to are then ignored.

    One of all_timenull
  • group_bystring

    Return one row per variant or per product. Default variant.

    One of variantproduct
    Default "variant"
  • fromstring

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

  • tostring

    End 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_bystring

    Column to sort the rows by. Default outstanding.

    One of outstandingsoldfulfilledcancelledon_holdscheduledwaitingorder_countlast_order_date
    Default "outstanding"
  • directionstring

    Sort order of the rows. Default desc.

    One of ascdesc
    Default "desc"
  • pageinteger

    Page of rows to return, starting at 1.

    Default 1
  • per_pageinteger

    Rows per page, 1 to 100. Default 25.

    Default 25

Returns

  • windowobject, nullable

    The date range the figures cover. Null when range is all_time.

    Show 2 child attributesHide child attributes
    • fromstring

      Start of the range, ISO 8601.

    • tostring

      End of the range, ISO 8601.

  • group_bystring
    Example: variant
  • sort_bystring
    Example: outstanding
  • directionstring
    Example: desc
  • totalsobject
    Show 9 child attributesHide child attributes
    • soldinteger
      Example: 95
    • cancelledinteger
      Example: 4
    • fulfilledinteger
      Example: 12
    • on_holdinteger
      Example: 61
    • scheduledinteger
      Example: 10
    • waitinginteger
      Example: 8
    • outstandinginteger
      Example: 79
    • order_countinteger
      Example: 88
    • as_ofstring, nullable
      Example: 2026-06-25T15:00:00Z
  • rowsarray of objects
    Show 15 child attributesHide child attributes
    • shopify_product_idstring
      Example: gid://shopify/Product/8784906035384
    • shopify_variant_idstring
      Example: gid://shopify/ProductVariant/47284734423096
    • image_urlstring, nullable
      Example: https://cdn.shopify.com/s/files/1/0712/3456/7890/files/cl…
    • product_titlestring
      Example: Classic Sneaker
    • variant_titlestring
      Example: Blue / Medium
    • skustring
      Example: CS-BLU-M
    • order_countinteger
      Example: 58
    • soldinteger
      Example: 64
    • cancelledinteger
      Example: 3
    • fulfilledinteger
      Example: 8
    • on_holdinteger
      Example: 41
    • scheduledinteger
      Example: 7
    • waitinginteger
      Example: 5
    • outstandinginteger
      Example: 53
    • last_order_datestring
      Example: 2026-06-25T10:02:00Z
  • metaobject

    Pagination for the list.

    Show 4 child attributesHide child attributes
    • total_countinteger

      Items matching the filters, across all pages.

    • pageinteger

      Page returned, starting at 1.

    • per_pageinteger

      Most items per page.

    • total_pagesinteger

      Pages available at this per_page; 0 when nothing matches.

Errors

422
validation_failed

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

GET/preorders/reports/fulfillments
curl "https://app.stoqapp.com/api/v2/external/preorders/reports/fulfillments" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "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
  }
}