Resource
product
A priced catalogue entry — what a customer is sold and charged for. Referenced by estimate and order lines, which take their price, quantity and kinds from it. Distinct from product_template, which is the manufacturing blueprint describing how a job is built: a product says what to charge, a template says what to make.
Configuration
nameString!RequiredProduct name (required)
skuString!RequiredStock keeping unit code (required)
descriptionStringOptionalFree-text description of what is being sold; surfaced on quotes and orders.
productTypeProductType!OptionalWhether this is a STANDARD catalogue line, a CUSTOM one-off, or a TEMPLATE used as the basis for quick reorders.
Allowed values
STANDARD — Standard catalogue product
CUSTOM — Custom/bespoke product
TEMPLATE — Template product for quick reorders
basePriceFloatOptionalList price charged to the customer, before any per-customer override. Null when the product is always quoted bespoke.
currencyCurrencyISOOptionalISO currency that basePrice and costPrice are denominated in.
costPriceFloatOptionalWhat the product costs to produce or buy in. Used for margin reporting; never shown to a customer.
defaultProductionKindStringOptionalProduction kind seeded onto a line created from this product, so a quote starts with the right manufacturing route. Overridable per line.
defaultCommercialKindStringOptionalCommercial kind seeded onto a line created from this product. Overridable per line.
defaultQuantityIntOptionalQuantity pre-filled when this product is added to an estimate or order line.
categoryStringOptionalFree-text grouping used to organise the catalogue; not a managed resource.
tags[String!]OptionalFree-text labels for searching and filtering the catalogue.
isActiveBoolean!OptionalWhether the product is offered. Inactive products are kept for historical lines but are not selectable on new ones.
notesStringOptionalInternal notes about the product; not shown to customers.
Read-only values
Lifecycle
The CLI can create this resource. The platform assigns its id.
When replacement is needed, the existing resource is removed before its replacement is created.