Skip to content

Update an asset lot

Assets module

PATCH/asset-lots/{id}assetLots.update

A quantity of an asset class at a place (lot grain). Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requires the capability assets.asset.write.
  • OAuth scopes: assets.
  • Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
  • Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

assetLots.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the asset lot.

Request body: AssetLotUpdate

assetLots.update: AssetLotUpdate
FieldTypeRequiredDescription
venue_idstring (uuid)NoIdentifier of the venue the lot sits at.
{
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Response 200: AssetLot

assetLots.update: AssetLot
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the asset lot.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
asset_class_idstring (uuid)YesIdentifier of the asset class.
venue_idstring (uuid)YesIdentifier of the venue the lot sits at.
quantitynumberYesQuantity on hand.
on_handnumberYesQuantity on hand: the opening count plus the lot ledger.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "asset_class_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "quantity": 36,
  "on_hand": 34
}

Code samples

curl -X PATCH "$XOS_BASE_URL/asset-lots/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'
const { data, etag } = await xos.assetLots.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  }, { ifMatch: etag });
response = xos.asset_lots.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}, if_match=etag)
xos asset-lots update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}' --if-match auto