---
title: "Retrieve availability"
description: "Resolve which preorder offer applies to Shopify variants for a buyer country, with its stock condition and schedule. Beta."
url: https://docs.stoqapp.com/v2-reference/preorders-product-variants/retrieve-availability/
api: "API v2 reference"
method: GET
path: "/preorders/product_variants/availability"
---

# Retrieve availability

`GET https://app.stoqapp.com/api/v2/external/preorders/product_variants/availability`

Resolve which preorder offer applies to Shopify variants for a buyer country, with its stock condition and schedule. Beta.

**Note:** country is the buyer's ISO 3166-1 alpha-2 country. status live means an offer applies and its limit is not reached, sold_out that its limit is reached; the caller still checks live inventory per `stock_condition` (in_stock: quantity above 0; out_of_stock: 0 or below with continue selling; any_stock_level: either). Unknown or deleted variants are `not_enrolled`; malformed ids are listed in `errors`. include[]=offer_details adds the offer's shipping_text, max_count, quantity_limit, preorder_count and quantity_limit_reached to `preorder`, as [`GET /preorders/products`](https://docs.stoqapp.com/v2-reference/preorders-products/list-products/) lists them; shipping_text is the text the buyer sees.

## Query parameters

- `country` (string, required)
- `shopify_variant_ids` (array)
- `include` (string)

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

## Examples

### Retrieve availability

```sh
curl "https://app.stoqapp.com/api/v2/external/preorders/product_variants/availability?country=US" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

### Retrieve availability filtered by shopify_variant_ids

```sh
curl "https://app.stoqapp.com/api/v2/external/preorders/product_variants/availability?country=US&shopify_variant_ids=45000000001" \
  -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
    }
  ]
}
```