---
title: "Get an order's timeline"
description: "Read an order's timeline: every event STOQ recorded for it, newest first, as the dashboard order page shows it."
url: https://docs.stoqapp.com/v2-reference/preorders-orders/get-an-orders-timeline/
api: "API v2 reference"
method: GET
path: "/preorders/orders/{id}/timeline"
---

# Get an order's timeline

`GET https://app.stoqapp.com/api/v2/external/preorders/orders/{id}/timeline`

Read an order's timeline: every event STOQ recorded for it, newest first, as the dashboard order page shows it.

**Note:** Covers back-in-stock orders too.

## Path parameters

- `id` (string, required): The order, by STOQ's order ID or the Shopify order ID.

## Returns

- `id` (string): STOQ's id for the order.
- `shopify_order_id` (string): The Shopify order gid (gid://shopify/Order/&lt;id&gt;).
- `name` (string): The Shopify order name, such as #1001.
- `events` (array of objects): The order's activity, newest first, as the dashboard's Activity card shows it. Starts with the order being created.
  - `event_type` (string): 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.
  - `tone` (string): How the dashboard colours the event: success, info, warning, critical, or base for a neutral one. One of: `success`, `info`, `warning`, `critical`, `base`.
  - `values` (object): 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).
    - `order_name` (string): The Shopify order name, on order_created.
    - `email` (string): The address the email went to.
  - `description` (string): The event as a sentence in English, as the dashboard shows it.
  - `triggered_by` (string): What caused the event, such as automatic or manual.
  - `occurred_at` (string): When the event happened (ISO 8601).

Rate limit: this call costs 1 point ([rate limits](https://docs.stoqapp.com/docs/rate-limits/)).

## Example request

```sh
curl "https://app.stoqapp.com/api/v2/external/preorders/orders/5f0c8a3e-6b2d-4f1a-9c7e-2d8b1a4e6f30/timeline" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

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

## 401

Missing or invalid `X-Auth-Token`.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 404

The resource does not exist for this shop, or the action path is not registered.

```json
{
  "errors": [
    "Offer not found"
  ],
  "code": "not_found",
  "details": [
    {
      "code": "not_found",
      "message": "Offer not found",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 422

The request failed validation.

```json
{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 429

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

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

