Get an order's timeline
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/orders/{id}/timelineCosts 1 rate-limit point · Rate limits
Read an order's timeline: every event STOQ recorded for it, newest first, as the dashboard order page shows it.
Covers back-in-stock orders too.
Also searched asorder timelineorder historyorder activity logwhat happened to this orderorder events
Path parameters
idstringRequiredThe order, by STOQ's order ID or the Shopify order ID.
Returns
idstringSTOQ's id for the order.
shopify_order_idstringThe Shopify order gid (gid://shopify/Order/<id>).
namestringThe Shopify order name, such as #1001.
eventsarray of objectsThe order's activity, newest first, as the dashboard's Activity card shows it. Starts with the order being created.
Show 6 child attributesHide child attributes
event_typestringWhat happened, such as order_created, order_confirmation_email_sent, preorder_sms_sent, shipping_update_email_sent, fulfillment_hold_applied, payment_collection_success, payment_collection_failed, payment_rescheduled or order_split_success.
tonestringHow the dashboard colours the event: success, info, warning, critical, or base for a neutral one.
One ofsuccessinfowarningcriticalbasevaluesobjectThe event's details, keyed by name; which keys appear depends on event_type (for example email, phone, amount and currency, old_date and new_date, or the hold and split counts).
Show 2 child attributesHide child attributes
order_namestringThe Shopify order name, on order_created.
emailstringThe address the email went to.
descriptionstringThe event as a sentence in English, as the dashboard shows it.
triggered_bystringWhat caused the event, such as automatic or manual.
occurred_atstringWhen the event happened (ISO 8601).
Errors
not_foundThe path is valid but nothing with that id exists in this store.
validation_failedThe request failed validation.
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/orders/5f0c8a3e-6b2d-4f1a-9c7e-2d8b1a4e6f30/timeline" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/orders/5f0c8a3e-6b2d-4f1a-9c7e-2d8b1a4e6f30/timeline", {
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/orders/5f0c8a3e-6b2d-4f1a-9c7e-2d8b1a4e6f30/timeline",
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/orders/5f0c8a3e-6b2d-4f1a-9c7e-2d8b1a4e6f30/timeline")
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){
"id": "string",
"shopify_order_id": "string",
"name": "string",
"events": [
{
"event_type": "string",
"tone": "success",
"values": {
"order_name": "string",
"email": "string"
},
"description": "string",
"triggered_by": "string",
"occurred_at": "2026-01-15T09:30:00Z"
}
]
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Offer not found"
],
"code": "not_found",
"details": [
{
"code": "not_found",
"message": "Offer not found",
"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
}
]
}