---
title: "Update a batch on an offer"
description: "Update any subset of the batch settings on a preorder offer, including the batches themselves."
url: https://docs.stoqapp.com/v2-reference/preorders-offers/update-a-batch-on-an-offer/
api: "API v2 reference"
method: PATCH
path: "/preorders/offers/{id}/batches"
---

# Update a batch on an offer

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

Update any subset of the batch settings on a preorder offer, including the batches themselves.

**Note:** Deep partial: absent fields are unchanged; items[].label is read-only.

## Path parameters

- `id` (string, required)

## 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

- `release_strategy` (string): sequential sells the batches one after another (needs at least two batches, a paid plan, and no market-specific offer); all_at_once turns batches off. Turning batches on uses one shipping timeline for every product and moves a Scheduled fulfillment status (shipping.delivery_timing exact_time) to Unfulfilled (asap), listed in also_changed, as the editor does. One of: `sequential`, `all_at_once`.
- `advance_schedule` (string): automatic moves to the next batch when one sells its quantity_limit (every batch then needs one); manual waits for the merchant. One of: `automatic`, `manual`.
- `label_format` (string): Batch name; {{ n }} is replaced by the position. null uses "Batch {{ n }}".
- `status_text` (object)
  - `past` (string): Word shown for a batch that has passed.
  - `live` (string): Word shown for the batch on sale now.
  - `upcoming` (string): Word shown for a batch still to come.
- `widget` (object)
  - `style` (string): Storefront batch widget layout. One of: `roadmap`, `stacked`, `compact`, `segmented`.
  - `progress` (string): counts shows units sold of the limit; percent shows a percentage. One of: `counts`, `percent`.
  - `show_other_ship_dates` (boolean): Show the other batches' ship dates on the storefront.
  - `show_names` (boolean): Show batch names on the storefront.
- `items` (array of anys): The batches. A list replaces them: entries with an id keep that batch, entries without one are created, and batches left out are archived. An object keyed by batch id edits those batches (quantity_limit, shipping_text) and keeps the rest. Kept batches stay in their current order and new ones go at the end; positions end up 1..N. Each batch needs shipping_text; quantity_limit is all or none across batches.

## Returns

- `release_strategy` (string): e.g. `sequential`
- `advance_schedule` (string): e.g. `automatic`
- `label_format` (string): e.g. `Batch {{ n }}`
- `status_text` (object)
  - `past` (string): e.g. `Sold out`
  - `live` (string): e.g. `Live`
  - `upcoming` (string): e.g. `Coming soon`
- `widget` (object)
  - `style` (string): e.g. `roadmap`
  - `progress` (string): e.g. `counts`
  - `show_other_ship_dates` (boolean): e.g. `true`
  - `show_names` (boolean): e.g. `false`
- `items` (array of objects)
  - `id` (string): e.g. `6f1c9e2a-0d4b-4c1e-9a57-2f0e8d3b7c11`
  - `position` (integer): e.g. `1`
  - `quantity_limit` (integer): e.g. `120`
  - `shipping_text` (string): e.g. `Ships in June`
  - `label` (string): e.g. `Batch 1`

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/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/batches" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "release_strategy": "sequential",
    "items": {
      "6f1c9e2a-0d4b-4c1e-9a57-2f0e8d3b7c11": {
        "quantity_limit": 120
      }
    }
  }'
```

## 200

Success: example response shown.

```json
{
  "release_strategy": "sequential",
  "advance_schedule": "automatic",
  "label_format": "Batch {{ n }}",
  "status_text": {
    "past": "Sold out",
    "live": "Live",
    "upcoming": "Coming soon"
  },
  "widget": {
    "style": "roadmap",
    "progress": "counts",
    "show_other_ship_dates": true,
    "show_names": false
  },
  "items": [
    {
      "id": "6f1c9e2a-0d4b-4c1e-9a57-2f0e8d3b7c11",
      "position": 1,
      "quantity_limit": 120,
      "shipping_text": "Ships in June",
      "label": "Batch 1"
    },
    {
      "id": "a3d8b5f0-7e21-4b9c-8f64-1c2d9e0a5b37",
      "position": 2,
      "quantity_limit": 200,
      "shipping_text": "Ships in July",
      "label": "Batch 2"
    }
  ]
}
```

## 202

Saved. Returns the updated section, with also_changed for cascades.

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

## 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

Invalid fields: one `details` entry per field error, its `path` the canonical section path. Nothing was saved.

```json
{
  "errors": [
    "widget.button.text_color must be a hex color"
  ],
  "code": "invalid_params",
  "details": [
    {
      "code": "invalid_params",
      "message": "must be a hex color",
      "path": "widget.button.text_color",
      "value": "blue",
      "expected": {
        "type": "string"
      }
    }
  ]
}
```

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