Products
Products and services in your organization's catalog. Use them in deals, orders, invoices, the public catalog and AI assistant product search.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /products | List products |
GET | /products/:id | Get a product |
POST | /products | Create a product |
PATCH | /products/:id | Update a product |
DELETE | /products/:id | Delete 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
| Field | Type | Description |
|---|---|---|
id | integer | Read-only. Unique ID. |
organization_id | integer | Organization that owns the product. Required on create; cannot be changed. |
name | string | Product name (up to 255 characters). Required. |
description | string | null | Free-text description. |
type | string | One of product, service. Required. |
status | string | One of active, inactive. Default active. |
price | number | Base price, 0 or more, with 2 decimals. Default 0. Responses return it as a decimal string (for example "999.99"). |
system_currency_id | integer | null | Currency of price (ID of a system currency). null uses the organization's default currency. |
sku | string | null | Stock keeping unit (up to 255 characters). Must be unique among the organization's non-deleted products. |
product_category_id | integer | null | ID of a product category of the same organization. |
parent_id | integer | null | Parent product ID, for variants. |
is_variant | boolean | Whether this product is a variant of parent_id. Default false. |
track_inventory | boolean | When true, orders deduct stock_quantity and the catalog checkout checks availability. Default false. |
allow_backorder | boolean | With track_inventory, allows selling when stock_quantity is not enough. Default false. |
stock_quantity | number | null | Units in stock, 0 or more. |
billing_type | string | One of one_time, recurring. Default one_time. |
billing_interval | string | null | For recurring: one of day, week, month, quarter, year, custom. Defaults to month for recurring products; always null for one_time. |
billing_interval_count | number | null | For recurring: number of intervals per billing cycle (at least 1, default 1). Always null for one_time. |
meta_data | object | null | Free-form JSON stored with the product. |
is_embeddable | boolean | When true, the product is indexed for AI assistant product search. Setting it to false removes it from the index. Default false. |
custom_fields_by_key | object | Product custom field values keyed by the field key (see GET /custom-fields?entity_type=product). Write custom fields with this object. |
custom_fields_by_name | object | Read-only. Same values keyed by the field name. Rebuilt by the API. |
custom_fields_meta_data | array | Read-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_at | string (date-time) | Read-only. Creation time. |
updated_at | string (date-time) | Read-only. Last update time. |
deleted_at | string (date-time) | null | Read-only. Set when the product is deleted. |
Related
Report an issue with this documentation
Please log in to report issues with our documentation.