# Update Batch Number

`PATCH /inventory/batch-numbers/{id}`

Group: Inventory › Batch Numbers · Operation ID: `updateBatchNumber`

Updates the batch with the given identifier. Only the manufacturer batch reference, the dates, the batch status, the temperature-breach flag, the quality-control state and the active flag can be changed.

Only the fields present in the request are written. The cost fields, the quantity, the stock on hand and the location are written by the documents that move and value the stock and cannot be sent here. Changing batchStatus does not change the quantity: 'QUARANTINED', 'EXPIRED' and 'DISPOSED' each stop the batch being picked, and the stock stays on hand and valued until a document takes it away.

[Open in the interactive reference](https://docs.api.lensing.ai/?op=updateBatchNumber)

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Api-Version` | header | `"v1"` | yes | The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`. |
| `Idempotency-Key` | header | string | no | An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with `400 IDEMPOTENCY_NOT_SUPPORTED` rather than silently ignored. |
| `id` | path | string | yes | The unique identifier for the batch to update. |

## Request body

Required, `application/json`: updateBatchNumberInput.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `manufacturerBatchNumber` | string | no | The manufacturer's own batch reference. |
| `expirationDate` | string (date) | no | The date the batch expires. Use format YYYY-MM-DD. |
| `manufactureDate` | string (date) | no | The date the batch was made. Use format YYYY-MM-DD. |
| `bestBeforeDate` | string (date) | no | The best-before date printed on the batch. Use format YYYY-MM-DD. |
| `entryDate` | string (date) | no | The date the batch entered the warehouse. Use format YYYY-MM-DD. |
| `batchStatus` | string | no | The status of the batch. Accepted values: 'ACTIVE', 'QUARANTINED', 'EXPIRED', 'DISPOSED'. Only 'ACTIVE' stock can be picked, and none of the other three reduces the quantity on hand. |
| `temperatureBreach` | boolean | no | Whether the batch has been outside its storage temperature range. |
| `qcStatus` | string | no | The tenant's own quality-control state for the batch. This is free text. |
| `active` | boolean | no | Whether the batch can be selected on new documents. |

Example:

```json
{
  "manufacturerBatchNumber": "<manufacturerBatchNumber>",
  "expirationDate": "2026-01-15",
  "manufactureDate": "2026-01-15",
  "bestBeforeDate": "2026-01-15",
  "entryDate": "2026-01-15",
  "batchStatus": "QUARANTINED",
  "temperatureBreach": true,
  "qcStatus": "Awaiting lab result",
  "active": true
}
```

## Response

`200` Success

Under `data` (updateBatchNumberOutput):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | yes | The unique identifier for the batch. |
| `batchStatus` | string | no | The status of the batch after the update. Possible values: 'ACTIVE', 'QUARANTINED', 'EXPIRED', 'DISPOSED'. |

## Response headers

- `Idempotency-Replayed` — Present and `true` only when this response replays a previously stored one for the same Idempotency-Key, rather than reflecting a live execution. Absent on a live response - never sent as `false`.

## Errors

| Code | Status |
| --- | --- |
| `NOT_FOUND` | 400 |
| `UNKNOWN_STATUS` | 400 |
| `IDEMPOTENCY_KEY_CONFLICT` | 409 |
| `IDEMPOTENCY_PAYLOAD_MISMATCH` | 422 |

## Statuses

- `400` — Invalid request or business failure. Codes: NOT_FOUND, UNKNOWN_STATUS
- `401` — Missing or invalid access token
- `403` — Not authorized
- `404` — Not found
- `409` — The Idempotency-Key is still being processed by another request.
- `422` — The Idempotency-Key was already used with a different request payload.
- `429` — Too many requests
- `500` — Internal server error