---
title: "List orders from alerts"
description: "List orders placed after a back-in-stock alert, paginated. search matches order number/name, customer name, email, a Shopify order id (10+ digits), an order gid (gid://shopify/Order/<id>), or a Shopify admin order URL."
url: https://docs.stoqapp.com/v2-reference/back-in-stock-orders/list-orders-from-alerts/
api: "API v2 reference"
method: GET
path: "/back_in_stock/orders"
---

# List orders from alerts

`GET https://app.stoqapp.com/api/v2/external/back_in_stock/orders`

List orders placed after a back-in-stock alert, paginated. search matches order number/name, customer name, email, a Shopify order id (10+ digits), an order gid (gid://shopify/Order/&lt;id&gt;), or a Shopify admin order URL.

**Note:** Filters match Reports &gt; Back in stock &gt; Sales recovered and combine with AND. product_match_type same_as_notification keeps orders where the customer bought the exact variant they were alerted about (the dashboard's Order matching: Exact variant match only). shopify_variant_id and shopify_product_id (gids) keep orders containing that variant or product, like a product's Orders tab. A bare from/to date is that whole day in the shop's time zone.

## Query parameters

- `page` (integer): Page of results to return, starting at 1.
- `per_page` (integer): Orders per page, 1 to 200. Default 50.
- `search` (string): Only orders matching this order number or name, customer name, email, Shopify order id (10+ digits), order gid or Shopify admin order URL.
- `product_match_type` (string): Send same_as_notification to keep only orders where the customer bought the exact variant they were alerted about. One of: `same_as_notification`.
- `shopify_variant_id` (string): Only orders containing this Shopify variant, as a gid (gid://shopify/ProductVariant/&lt;id&gt;) or numeric id. One id only.
- `shopify_product_id` (string): Only orders containing this Shopify product, as a gid (gid://shopify/Product/&lt;id&gt;) or numeric id. One id only.
- `customer_id` (string): Only orders placed by this customer, by the customer's STOQ id.
- `from` (string): Only orders created at or after this ISO 8601 date or time. A bare date starts at midnight in the shop's time zone; a time without an offset is read as UTC.
- `to` (string): Only orders created at or before this ISO 8601 date or time. A bare date runs to the end of that day in the shop's time zone; a time without an offset is read as UTC.

## Returns

- `orders` (array of objects)
  - `id` (string): e.g. `string`
  - `type` (string): e.g. `string`
  - `shopify_order_id` (string): e.g. `string`
  - `name` (string): e.g. `string`
  - `customer` (object)
    - `id` (null)
    - `email` (string): e.g. `string`
    - `name` (string): e.g. `string`
  - `total_price` (string): e.g. `string`
  - `currency` (string): e.g. `string`
  - `financial_status` (string): e.g. `string`
  - `fulfillment_status` (string): e.g. `string`
  - `notified_product` (object, nullable)
    - `shopify_product_id` (string): e.g. `string`
    - `shopify_variant_id` (string): e.g. `string`
    - `title` (string): e.g. `string`
  - `notification` (object, nullable)
    - `channel` (string): e.g. `string`
    - `sent_at` (string, nullable): e.g. `string`
  - `created_at` (string): e.g. `2026-01-15T09:30:00Z`
- `meta` (object): Pagination for the list.
  - `total_count` (integer): Items matching the filters, across all pages.
  - `page` (integer): Page returned, starting at 1.
  - `per_page` (integer): Most items per page.
  - `total_pages` (integer): Pages available at this per_page; 0 when nothing matches.

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

## Examples

### List orders from alerts

```sh
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/orders" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

### List orders from alerts filtered by product_match_type, shopify_variant_id and shopify_product_id

```sh
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/orders?product_match_type=same_as_notification&shopify_variant_id=45000000001&shopify_product_id=78000000001" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

```json
{
  "orders": [
    {
      "id": "string",
      "type": "string",
      "shopify_order_id": "string",
      "name": "string",
      "customer": {
        "id": null,
        "email": "string",
        "name": "string"
      },
      "total_price": "string",
      "currency": "string",
      "financial_status": "string",
      "fulfillment_status": "string",
      "notified_product": {
        "shopify_product_id": "string",
        "shopify_variant_id": "string",
        "title": "string"
      },
      "notification": {
        "channel": "string",
        "sent_at": "string"
      },
      "created_at": "2026-01-15T09:30:00Z"
    }
  ],
  "meta": {
    "total_count": 1,
    "page": 1,
    "per_page": 1,
    "total_pages": 1
  }
}
```

## 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
    }
  ]
}
```

## 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
    }
  ]
}
```

