Skip to content

Get sales by date

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

GET/preorders/reports/by_date

Costs 1 rate-limit point · Rate limits

The Preorders Overview charts per day, week or month: preorder orders and their sales, and preorder units sold and their line revenue.

The same points as the dashboard charts, counted live. Every series leaves cancelled orders out. units_sold and line_item_revenue count preorder lines. interval is daily up to 60 days, weekly up to 180, then monthly, and buckets are UTC days as on the charts. range=all_time is the dashboard's All time.

Also searched astime seriesdaily breakdowntrendover timepreorder trendshow trend

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.

  • intervalstring
    Example: string
  • 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.

  • seriesarray of objects
    Show 5 child attributesHide child attributes
    • datestring
      Example: 2026-01-15
    • ordersinteger
      Example: 1
    • revenuestring
      Example: string
    • units_soldinteger
      Example: 1
    • line_item_revenuestring
      Example: string

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/by_date
curl "https://app.stoqapp.com/api/v2/external/preorders/reports/by_date" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "window": {
    "from": "2026-01-15T09:30:00Z",
    "to": "2026-01-15T09:30:00Z"
  },
  "interval": "string",
  "currency": null,
  "series": [
    {
      "date": "2026-01-15",
      "orders": 1,
      "revenue": "string",
      "units_sold": 1,
      "line_item_revenue": "string"
    }
  ]
}