Sign in
Equipment

Update an equipment item

Partially updates an Equipment record. Every field is optional; only fields you send are written. Requires the SETTINGS_MANAGE permission on the equipment's current site (and the target site too, if site_id is changed).

put/shop/equipment/{equipmentId}

Request body

namestring

Display name shown to staff in the admin UI. Plain text only — HTML tags are rejected.

descriptionstring nullable

Optional internal note about this equipment — model number, service schedule, location. Not surfaced to customers.

quantitynumber

Number of units. Must be greater than 0.

site_idstring uuid

Move the equipment to a different site. The caller's API key must have access to both the old and new site.

Example request

{
  "name": "Steam Machine A (refurbished)",
  "description": "Lucas Champion steam unit serviced 2026-04-15.",
  "quantity": 3,
  "site_id": "11111111-1111-1111-1111-111111111111"
}

Response

A single Equipment item.

Example response

{
  "data": {
    "id": "5f1234567890abcdef123456",
    "name": "Steam Machine A",
    "description": "Lucas Champion steam unit serviced annually.",
    "quantity": 2,
    "site_id": "11111111-1111-1111-1111-111111111111",
    "organisation_id": "22222222-2222-2222-2222-222222222222"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.