← All resources

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.

GraphQL reference →

Configuration

nameString!Required

Product name (required)

skuString!Required

Stock keeping unit code (required)

descriptionStringOptional

Free-text description of what is being sold; surfaced on quotes and orders.

productTypeProductType!Optional

Whether 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

basePriceFloatOptional

List price charged to the customer, before any per-customer override. Null when the product is always quoted bespoke.

currencyCurrencyISOOptional

ISO currency that basePrice and costPrice are denominated in.

costPriceFloatOptional

What the product costs to produce or buy in. Used for margin reporting; never shown to a customer.

defaultProductionKindStringOptional

Production kind seeded onto a line created from this product, so a quote starts with the right manufacturing route. Overridable per line.

defaultCommercialKindStringOptional

Commercial kind seeded onto a line created from this product. Overridable per line.

defaultQuantityIntOptional

Quantity pre-filled when this product is added to an estimate or order line.

categoryStringOptional

Free-text grouping used to organise the catalogue; not a managed resource.

tags[String!]Optional

Free-text labels for searching and filtering the catalogue.

isActiveBoolean!Optional

Whether the product is offered. Inactive products are kept for historical lines but are not selectable on new ones.

notesStringOptional

Internal notes about the product; not shown to customers.

Read-only values

Show values
idProductID!Read only

Unique identifier

computed by the platform

createdAtString!Read only

Creation timestamp (ISO8601)

computed by the platform

updatedAtString!Read only

Last update timestamp (ISO8601)

computed by the platform

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.