Skip to content

Get the report summary

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

GET/preorders/reports/summary

Costs 1 rate-limit point · Rate limits

The Preorders Overview tiles over a date window: orders, units sold, revenue (total sales), preorder line item revenue, average order value, unpaid orders and the balance they owe, unfulfilled orders and unique customers.

The same numbers as the dashboard tiles and the Home analytics card, summed from the shop's daily totals. Every total leaves cancelled orders out, units_sold and line_item_revenue included. range=all_time reads orders and revenue from the shop's lifetime totals, as Home's All time does. unpaid_orders and unpaid_balance are read live from the orders placed in the window (every order for all_time): the orders that still owe a balance now and the sum still to collect. Cancelled, refunded and voided orders are left out; a partially refunded order that still owes counts. unfulfilled_orders and unique_customers are read live from the same orders: unfulfilled_orders is how many still have preorder items to ship (on hold, scheduled or ready to ship), and unique_customers is how many different customers placed them.

Also searched assummaryoverviewhow is preorder doingpreorder summarydashboard statswhat's happening with preorders

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

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.

  • currencynull

    ISO 4217 code of the currency the money amounts in this response are in: the order's for an order, else the shop's. Null when it is not known.

  • totalsobject
    Show 9 child attributesHide child attributes
    • ordersinteger
      Example: 1
    • units_soldinteger
      Example: 1
    • revenuestring
      Example: string
    • line_item_revenuestring
      Example: string
    • average_order_valuestring
      Example: string
    • unpaid_ordersinteger
      Example: 1
    • unpaid_balancestring
      Example: string
    • unfulfilled_ordersinteger
      Example: 1
    • unique_customersinteger
      Example: 1

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/summary
curl "https://app.stoqapp.com/api/v2/external/preorders/reports/summary" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "window": {
    "from": "2026-01-15T09:30:00Z",
    "to": "2026-01-15T09:30:00Z"
  },
  "currency": null,
  "totals": {
    "orders": 1,
    "units_sold": 1,
    "revenue": "string",
    "line_item_revenue": "string",
    "average_order_value": "string",
    "unpaid_orders": 1,
    "unpaid_balance": "string",
    "unfulfilled_orders": 1,
    "unique_customers": 1
  }
}