Create a product
Add a product or service to your organization's catalog.
Endpoint
POST/products
Body parameters
| Name | Type | Required | Description |
|---|---|---|---|
organization_id | integer | Yes | Your organization ID (the API key's organization). |
name | string | Yes | Product name (up to 255 characters). |
type | string | Yes | product or service. |
description | string | null | No | Description. |
status | string | No | active (default) or inactive. |
price | number | No | Base price, 0 or more. Default 0. |
system_currency_id | integer | null | No | Currency of price. |
sku | string | null | No | Must be unique among your organization's products. |
product_category_id | integer | null | No | ID of an existing product category of your organization. |
parent_id | integer | null | No | Parent product, for variants. |
is_variant | boolean | No | Default false. |
track_inventory | boolean | No | Deduct stock_quantity on orders. Default false. |
allow_backorder | boolean | No | Allow selling beyond stock when tracking inventory. Default false. |
stock_quantity | number | null | No | Units in stock, 0 or more. |
billing_type | string | No | one_time (default) or recurring. |
billing_interval | string | null | No | For recurring: day, week, month (default), quarter, year or custom. Ignored for one_time. |
billing_interval_count | number | null | No | For recurring: intervals per cycle, at least 1 (default 1). Ignored for one_time. |
meta_data | object | null | No | Free-form JSON. |
is_embeddable | boolean | No | true indexes the product for AI assistant product search. Default false. |
custom_fields_by_key | object | No | Custom field values keyed by field key from GET /custom-fields?entity_type=product. |
See the product object for every field.
Request
Response
json
Errors
| Status | Message / cause |
|---|---|
400 Bad Request | A product with SKU '…' already exists in your organization. Please use a different SKU. |
400 Bad Request | Schema validation failed (missing name, type or organization_id, unknown field, wrong type or enum value). |
403 Forbidden | organization_id is missing or is not the API key's organization. |
Report an issue with this documentation
Please log in to report issues with our documentation.