Retrieve 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 and 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.

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

Query parameters

rangestring
fromstring
tostring

Errors

401

Missing or invalid X-Auth-Token.

422

The request failed validation.

429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Every error has the same shape: see Errors.

GET/preorders/reports/summary

curl "https://app.stoqapp.com/api/v2/external/preorders/reports/summary" \
  -H "X-Auth-Token: $STOQ_API_KEY"

const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/reports/summary", {
  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/summary",
    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/summary")
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)

Response

No body

{
  "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
    }
  ]
}