---
title: "Update delivery settings"
description: "Update back-in-stock delivery settings (batching, stock threshold, locations, any-variant, password-protected sending, alerts on publish). Market setup and market-based alerts are PATCH /account/markets."
url: https://docs.stoqapp.com/v2-reference/back-in-stock-settings/update-delivery-settings/
api: "API v2 reference"
method: PATCH
path: "/back_in_stock/settings/delivery"
---

# Update delivery settings

`PATCH https://app.stoqapp.com/api/v2/external/back_in_stock/settings/delivery`

Update back-in-stock delivery settings (batching, stock threshold, locations, any-variant, password-protected sending, alerts on publish). Market setup and market-based alerts are [`PATCH /account/markets`](https://docs.stoqapp.com/v2-reference/account-markets/update-market-settings/).

**Note:** Deep partial. Toggles set via this PATCH: batching.enabled, locations.filter_enabled, any_variant.enabled: e.g. { batching: { enabled: true } }. batching.mode is an enum: 'multiplier' (batch size = restocked quantity x batching.multiplier) or 'fixed' (batch size = batching.batch_size); batching.wait_hours is the wait between batches. stock_threshold is the minimum restocked quantity before notifications send (&gt;= 1). any_variant.all_products is a boolean: when true, any-variant alerts apply to every product and any_variant.product_ids is ignored; when false, only the listed products qualify. locations.shopify_location_ids and any_variant.shopify_product_ids are arrays of Shopify gids and are replaced wholesale when present. send_while_password_protected is a boolean: false (default) holds back-in-stock alerts while the storefront password is on (signups stay pending for the next restock); true sends anyway. alert_on_publish also alerts when a product is published.

## Headers

- `Idempotency-Key` (string): A fresh unique key for every write (a new UUID, say); reuse it only to retry that write. Keys are remembered for 1 hour: the same key and the same request within that hour returns the first result, with `Idempotent-Replayed: true`, without running again; the same key with a different method, path or body is refused (422 `idempotency_key_reused`); a retry while the first is still running gets 409 `idempotency_key_in_progress`. Keys are per store. Server errors and rate limits are not kept, so their retry runs.

## Request body

- `batching` (object): How a restock notifies the waitlist in batches.
  - `enabled` (boolean): Notify customers in batches when a product is restocked, rather than the whole waitlist at once.
  - `mode` (string): &quot;multiplier&quot; sends restocked quantity x multiplier per batch (&quot;Per unit of stock&quot;); &quot;fixed&quot; sends batch_size per batch. One of: `multiplier`, `fixed`.
  - `multiplier` (integer): Notification multiplier. Used while mode is &quot;multiplier&quot;.
  - `batch_size` (integer): How many customers each batch notifies. Used while mode is &quot;fixed&quot;.
  - `wait_hours` (integer): Hours to wait before sending the next batch.
- `stock_threshold` (integer): Minimum restock quantity before any alert sends. Must be 1 or more.
- `locations` (object): Location-based alerts.
  - `filter_enabled` (boolean): Location-based alerts: only count stock at the locations listed below.
  - `shopify_location_ids` (array of strings): Shopify location gids to count stock at, e.g. &quot;gid://shopify/Location/123&quot;. REPLACES the stored list.
- `any_variant` (object): Any-variant alerts.
  - `enabled` (boolean): Notify customers when any product option is restocked, not only the option they asked for.
  - `all_products` (boolean): True applies that to all products; false to the selected products only.
  - `shopify_product_ids` (array of strings): Shopify product gids it applies to, e.g. &quot;gid://shopify/Product/123&quot;. REPLACES the stored list. Ignored while all_products is true.
- `send_while_password_protected` (boolean): Send alerts while the store is password protected.
- `alert_on_publish` (boolean): Also alert customers when a product they wait for is published to the Online Store, not only when it restocks.

## Returns

- `batching` (object)
  - `enabled` (boolean): e.g. `true`
  - `mode` (string): e.g. `fixed`
  - `multiplier` (integer): e.g. `100`
  - `batch_size` (integer): e.g. `50`
  - `wait_hours` (integer): e.g. `2`
- `stock_threshold` (integer): e.g. `3`
- `locations` (object)
  - `filter_enabled` (boolean): e.g. `true`
  - `shopify_location_ids` (array of strings)
- `any_variant` (object)
  - `enabled` (boolean): e.g. `true`
  - `all_products` (boolean): e.g. `false`
  - `shopify_product_ids` (array of strings)
- `send_while_password_protected` (boolean): e.g. `false`
- `alert_on_publish` (boolean): e.g. `true`

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

## Example request

```sh
curl -X PATCH "https://app.stoqapp.com/api/v2/external/back_in_stock/settings/delivery" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "batching": {
      "enabled": true,
      "mode": "fixed",
      "batch_size": 50,
      "wait_hours": 2
    },
    "stock_threshold": 3
  }'
```

## 202

Success: example response shown.

```json
{
  "batching": {
    "enabled": true,
    "mode": "fixed",
    "multiplier": 100,
    "batch_size": 50,
    "wait_hours": 2
  },
  "stock_threshold": 3,
  "locations": {
    "filter_enabled": true,
    "shopify_location_ids": [
      "gid://shopify/Location/71234568281"
    ]
  },
  "any_variant": {
    "enabled": true,
    "all_products": false,
    "shopify_product_ids": [
      "gid://shopify/Product/8784906035384"
    ]
  },
  "send_while_password_protected": false,
  "alert_on_publish": true
}
```

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

## 409

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

```json
{
  "errors": [
    "A request with this Idempotency-Key is still running"
  ],
  "code": "idempotency_key_in_progress",
  "details": [
    {
      "code": "idempotency_key_in_progress",
      "message": "A request with this Idempotency-Key is still running",
      "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
    }
  ]
}
```

