Skip to content

Get an order's timeline

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

GET/preorders/orders/{id}/timeline

Costs 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

  • idstringRequired

    The order, by STOQ's order ID or the Shopify order ID.

Returns

  • idstring

    STOQ's id for the order.

  • shopify_order_idstring

    The Shopify order gid (gid://shopify/Order/<id>).

  • namestring

    The Shopify order name, such as #1001.

  • eventsarray of objects

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

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

    • tonestring

      How the dashboard colours the event: success, info, warning, critical, or base for a neutral one.

      One of successinfowarningcriticalbase
    • valuesobject

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

        The Shopify order name, on order_created.

      • emailstring

        The address the email went to.

    • descriptionstring

      The event as a sentence in English, as the dashboard shows it.

    • triggered_bystring

      What caused the event, such as automatic or manual.

    • occurred_atstring

      When the event happened (ISO 8601).

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

422
validation_failed

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

GET/preorders/orders/{id}/timeline
curl "https://app.stoqapp.com/api/v2/external/preorders/orders/5f0c8a3e-6b2d-4f1a-9c7e-2d8b1a4e6f30/timeline" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "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"
    }
  ]
}