---
title: "Get inventory settings"
description: "Read the inventory configuration for a preorder offer."
url: https://docs.stoqapp.com/v2-reference/preorders-offers/get-inventory-settings/
api: "API v2 reference"
method: GET
path: "/preorders/offers/{id}/inventory"
---

# Get inventory settings

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

Read the inventory configuration for a preorder offer.

**Note:** `stock_condition` decides when the Preorder button shows: `out_of_stock` (the default) once the variant is out of stock with Shopify's Continue selling on, `in_stock` only while it has stock, `any_stock_level` whenever it can be bought. `in_stock` and `any_stock_level` need `products.selection` `custom`; switching selection to a collection, tags or all products sets it back to `out_of_stock`. `reserve` only applies to `out_of_stock`; the other two always deduct stock at sale. Edit with [`PATCH /preorders/offers/:id/inventory`](https://docs.stoqapp.com/v2-reference/preorders-offers/update-inventory-settings/).

## Path parameters

- `id` (string, required): The offer's ID, from [`GET /preorders/offers`](https://docs.stoqapp.com/v2-reference/preorders-offers/list-offers/).

## Returns

- `stock_condition` (string): When the Preorder button shows: out_of_stock when the variant is out of stock with Continue selling on, in_stock only while it is in stock, any_stock_level whenever the variant can be bought. One of: `out_of_stock`, `in_stock`, `any_stock_level`.
- `reserve` (string): When inventory is deducted: on_sale at checkout, on_fulfillment at fulfillment. One of: `on_sale`, `on_fulfillment`.

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/offers/73a74948-2b57-4cc3-971f-2b441828c977/inventory" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

```json
{
  "stock_condition": "out_of_stock",
  "reserve": "on_sale"
}
```

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

