Products
Get one Product
Retrieve a single Product record by its Id.
GET
A Product represents an item that can be sold to customers. Products can be sold via contracts (
ContractProduct entity), added to bookings (BookingProduct entity), or purchased directly (CoworkerProduct entity).
Products support both one-off sales and recurring charges. Recurring charges can be set to daily, weekly, monthly, or yearly frequencies, or charged every time a contract is invoiced. For invoice-linked recurring charges, prefer using ContractProduct to associate the sale directly with a specific contract rather than relying on the customer’s MainContract.
Use AvailableAs to control whether a product can be sold as a one-off purchase, a recurring charge, or both. The SystemProductType field categorises the product (e.g. day pass, credit bundle, booking product, stationery, or other).
Products can optionally track stock levels, be restricted to specific pricing plans (tariffs), and be limited to members or contacts only.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the Product-Read role.Path Parameters
The Id of the Product record to retrieve.
Code Examples
Response
200
Business Id.
Business name.
Product name.
Category of the product: DayPass, CreditBundle, Stationery, BookingFeature, BookingProducts, or Other. See
eProductType enum values: 0 = None, 1 = DayPass, 2 = CreditBundle, 3 = Stationery, 4 = BookingFeature, 5 = BookingProducts, 99 = Other.Product description.
Custom text shown on the invoice line instead of the product name.
SKU code.
Tags.
Display order.
Product price.
Whether the product is visible to customers on the members portal and mobile app.
Sync to Square.
Currency Id.
Currency code.
Tax Rate Id.
Reduced Tax Rate Id.
Exempt Tax Rate Id.
Financial Account Id.
Controls whether the product can be sold as a one-off purchase, a recurring charge, or both (RecurrentOrOneOff, OnlyRecurrent, OnlyOneOff). See
eRecurrentProductOptions enum values: 0 = None, 1 = RecurrentOrOneOff, 2 = OnlyRecurrent, 3 = OnlyOneOff.Restrict purchase to contacts (customers without an active contract).
Restrict purchase to customers with an active contract (members).
Tariffs.
Whether the product is archived. Archived products cannot be sold but existing charges remain active.
Mark the product as featured or highlighted.
Enable stock tracking for this product. When enabled, each sale reduces the stock count.
Allow sales to continue even when stock reaches zero.
Current stock level.
Stock level at which a low-stock alert is triggered.
Whether to pro-rate the price when the product is added or removed part-way through a billing period.
Image File Name.
New Image Url.
Clear Image File.
Whether to invoice the customer directly rather than their company or team.
Sync to NexKiosk.
Automatically create a delivery record for the customer when this product is purchased.
Unique record identifier.
UUID of the record.
Date and time the record was created (ISO 8601).
Date and time the record was last updated (ISO 8601).
Email of the user who last updated this record.
Whether the record was recently created.
External system identifier.
Example Response