Products
Create Product
Create a new Product record.
POST
Create Product
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-Create role.Enums
eProductType — SystemProductType values
eProductType — SystemProductType values
eRecurrentProductOptions — AvailableAs values
eRecurrentProductOptions — AvailableAs values
Request Body
Required Fields
Category of the product: DayPass, CreditBundle, Stationery, BookingFeature, BookingProducts, or Other.
Controls whether the product can be sold as a one-off purchase, a recurring charge, or both (RecurrentOrOneOff, OnlyRecurrent, OnlyOneOff).
Optional Fields
Whether the product is visible to customers on the members portal and mobile app. Defaults to
true.Whether this product is available to any AI channels (Email, Chat or WhatsApp) for recommendations for day passes.
Additional notes about the product that are included in AI channel recommendations and responses to provide more context to customers.
Whether to show the price of this product in AI channel recommendations and responses based on users’ budget preferences.
Override price to show in AI channel recommendations and responses based on users’ budget preferences (if not set, the regular Price value is used).
Whether the product is archived. Archived products cannot be sold but existing charges remain active.
Whether to pro-rate the price when the product is added or removed part-way through a billing period.
Code Examples
Response
200
Example Response
400
Example Response