Create a product

Add a product or service to your organization's catalog.

Endpoint

POST
/products

Body parameters

NameTypeRequiredDescription
organization_idintegerYesYour organization ID (the API key's organization).
namestringYesProduct name (up to 255 characters).
typestringYesproduct or service.
descriptionstring | nullNoDescription.
statusstringNoactive (default) or inactive.
pricenumberNoBase price, 0 or more. Default 0.
system_currency_idinteger | nullNoCurrency of price.
skustring | nullNoMust be unique among your organization's products.
product_category_idinteger | nullNoID of an existing product category of your organization.
parent_idinteger | nullNoParent product, for variants.
is_variantbooleanNoDefault false.
track_inventorybooleanNoDeduct stock_quantity on orders. Default false.
allow_backorderbooleanNoAllow selling beyond stock when tracking inventory. Default false.
stock_quantitynumber | nullNoUnits in stock, 0 or more.
billing_typestringNoone_time (default) or recurring.
billing_intervalstring | nullNoFor recurring: day, week, month (default), quarter, year or custom. Ignored for one_time.
billing_interval_countnumber | nullNoFor recurring: intervals per cycle, at least 1 (default 1). Ignored for one_time.
meta_dataobject | nullNoFree-form JSON.
is_embeddablebooleanNotrue indexes the product for AI assistant product search. Default false.
custom_fields_by_keyobjectNoCustom field values keyed by field key from GET /custom-fields?entity_type=product.

See the product object for every field.

Request

Response

json

Errors

StatusMessage / cause
400 Bad RequestA product with SKU '…' already exists in your organization. Please use a different SKU.
400 Bad RequestSchema validation failed (missing name, type or organization_id, unknown field, wrong type or enum value).
403 Forbiddenorganization_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.