---
title: "List orders"
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/
api: "API v2 reference"
method: GET
path: "/back_in_stock/orders"
---

# List orders

`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` (string)
- `per_page` (string)
- `search` (string)
- `product_match_type` (string)
- `shopify_variant_id` (string)
- `shopify_product_id` (string)
- `customer_id` (string)
- `from` (string)
- `to` (string)

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

## Examples

### List orders

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

### List orders filtered by shopify_variant_id and shopify_product_id

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

## 200

Success: the requested resource.

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