Products

Products and services in your organization's catalog. Use them in deals, orders, invoices, the public catalog and AI assistant product search.

Endpoints

MethodPathDescription
GET/productsList products
GET/products/:idGet a product
POST/productsCreate a product
PATCH/products/:idUpdate a product
DELETE/products/:idDelete a product

All requests use your API key in the x-api-key header. The key is scoped to one organization: reads only return that organization's products, and organization_id is required in the body when you create a product.

The product object

json

Fields

FieldTypeDescription
idintegerRead-only. Unique ID.
organization_idintegerOrganization that owns the product. Required on create; cannot be changed.
namestringProduct name (up to 255 characters). Required.
descriptionstring | nullFree-text description.
typestringOne of product, service. Required.
statusstringOne of active, inactive. Default active.
pricenumberBase price, 0 or more, with 2 decimals. Default 0. Responses return it as a decimal string (for example "999.99").
system_currency_idinteger | nullCurrency of price (ID of a system currency). null uses the organization's default currency.
skustring | nullStock keeping unit (up to 255 characters). Must be unique among the organization's non-deleted products.
product_category_idinteger | nullID of a product category of the same organization.
parent_idinteger | nullParent product ID, for variants.
is_variantbooleanWhether this product is a variant of parent_id. Default false.
track_inventorybooleanWhen true, orders deduct stock_quantity and the catalog checkout checks availability. Default false.
allow_backorderbooleanWith track_inventory, allows selling when stock_quantity is not enough. Default false.
stock_quantitynumber | nullUnits in stock, 0 or more.
billing_typestringOne of one_time, recurring. Default one_time.
billing_intervalstring | nullFor recurring: one of day, week, month, quarter, year, custom. Defaults to month for recurring products; always null for one_time.
billing_interval_countnumber | nullFor recurring: number of intervals per billing cycle (at least 1, default 1). Always null for one_time.
meta_dataobject | nullFree-form JSON stored with the product.
is_embeddablebooleanWhen true, the product is indexed for AI assistant product search. Setting it to false removes it from the index. Default false.
custom_fields_by_keyobjectProduct custom field values keyed by the field key (see GET /custom-fields?entity_type=product). Write custom fields with this object.
custom_fields_by_nameobjectRead-only. Same values keyed by the field name. Rebuilt by the API.
custom_fields_meta_dataarrayRead-only. One item per custom field value: custom_field_id, custom_field_key, custom_field_name, custom_field_value, last_updated. Rebuilt by the API.
created_atstring (date-time)Read-only. Creation time.
updated_atstring (date-time)Read-only. Last update time.
deleted_atstring (date-time) | nullRead-only. Set when the product is deleted.

Related

Report an issue with this documentation

Please log in to report issues with our documentation.