Sign in
Equipment

Create equipment

Creates a new Equipment record at a site. Once created, the equipment can be assigned to appointment types — bookings then only offer slots when at least one unit is free.

Requires the SETTINGS_MANAGE permission on the target site.

post/shop/equipment

Request body

namestring required

Display name. Plain text only.

descriptionstring nullable

Optional internal note (model, service schedule, location).

quantitynumber required

Number of units of this equipment the site has. Used by the availability engine to enforce concurrency limits. Must be greater than 0.

site_idstring uuid required

ID of the site to create this equipment under. The caller's API key must have access to the site.

organisation_idstring uuid

Optional organisation to attribute this equipment to. Defaults to the caller's primary organisation if omitted.

Example request

{
  "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"
}

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.