Update a batch number

Operation ID: updateBatchNumber

Group: Inventory › Batch Numbers

Open in the interactive reference

PATCH /inventory/batch-numbers/{id}

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Updates a batch number with the fields you send. A field you leave out keeps its current value. You cannot remove a field's value, because null is not accepted.

The manufactureDate and bestBeforeDate cannot be after the expirationDate.

The response contains the batch's id and its batchStatus after the update.

Parameters

Name In Type Required Description
Api-Version header string · 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 of the batch number you want to update. Format: UUID.

Request body

Required, application/json: updateBatchNumberInput.

Field Type Required Description
manufacturerBatchNumber string no The manufacturer's batch number.
expirationDate date no The date the batch expires. Format: YYYY-MM-DD.
manufactureDate date no The date the manufacturer made the batch. Format: YYYY-MM-DD.
bestBeforeDate date no The best-before date of the batch. Format: YYYY-MM-DD.
entryDate date no The date the batch's age is counted from. Format: YYYY-MM-DD. The date you send applies to all of the batch's stock. If a receipt or inventory increase for the batch comes after your update, it sets a new date and replaces the date you sent.
batchStatus string no The status of the batch. Changing the status does not change the batch's quantity, inStock, or cost. Accepted values: 'ACTIVE', 'QUARANTINED', 'EXPIRED', 'DISPOSED'. Example: "QUARANTINED".
temperatureBreach boolean no Whether the batch has been outside its storage temperature range.
qcStatus string no The quality-control status of the batch, as free text. Example: "Awaiting lab result".
active boolean no Whether the batch is active. 
{
  "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 number. Format: UUID. Example: "7a4e91c3-2b58-4d06-9f31-c85e207a4b19".
batchStatus string no The status of the batch after the update. Possible values: 'ACTIVE', 'QUARANTINED', 'EXPIRED', 'DISPOSED'. Example: "QUARANTINED". 
{
  "data": {
    "id": "7a4e91c3-2b58-4d06-9f31-c85e207a4b19",
    "batchStatus": "QUARANTINED"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
NOT_FOUND 400
UNKNOWN_STATUS 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses