POST
Create a product
Company space For: Manager · Permission: products.create Conditions
  • The unit-of-measure category (uom_category_id) and the category, when sent, must exist in the organization.
  • title, type, is_tracked, uom_category_id and variants are required; every variant needs at least one unit and each unit needs at least one price; options must be present (it may be an empty list).
  • The handle must be unique among the organization’s products when sent; when omitted it is built from the title.
  • Variant option combinations must be unique inside the request and against the product.
  • SKUs and barcodes (blank values become null) must not repeat inside the payload and are unique per organization when set.
  • A price is a decimal in major units with at most currency_exponent decimals and greater than zero.
  • Weight, volume and maximum sellable quantity need their unit sent together with the value, and the unit must match the right kind of measure (weight, volume) or the product’s unit category.
  • Custom tax configuration requires is_taxable; a VAT rate must be active and match the company’s country and fiscal status.
  • Tags are cleaned: split on semicolons, trimmed, empty tags dropped.
  • Images must be jpeg, png, jpg, gif or svg files of at most 2048 kilobytes.
What else happens
  • Creates the product with published_at left empty (not published) and description defaulting to an empty string.
  • Creates one item per variant (status draft, purchase nature goods, tracking copied from the product) and, for tracked items, a stock record.
  • Creates the options and option values, the variants, the units of sale with SKU and barcode, and the prices of each unit.
  • Initializes the tax configuration of each item.
  • Uploads the images to public storage.
Part of Create products and variants.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, handle, status_counts, type, tags, published_at, title, description, is_tracked, uom_category_id, created_at, updated_at, options, organization_id.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: variants, variants.vat_rate, variants.taxes, variants.image, variants.inventoryItem, variants.levels, variants.units, images, category, category.vat_rate, category.taxes.

Response

Resource (only with response=resource).

id

Identifier of the product (27-character KSUID).

handle

Short text identifier of the product, unique within the organization. Built from the title when it was not sent at creation.

status_counts
object

Number of variants of the product in each item status (active, draft, archived).

type

Kind of product: physical, digital or service.

tags

Tags as one text separated by semicolons, or null when none.

published_at

Publication date and time in ISO 8601, or null while the product is not published. It is left empty at creation.

title

Display name of the product.

description

Free text description; an empty string when none was given.

is_tracked
boolean

Whether stock is tracked for the variants of this product. Changing it also changes the tracking of all its variants.

uom_category_id

Identifier of the unit-of-measure category that defines the units the product's variants are sold and stocked in (27-character KSUID). It cannot be changed after creation.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).

options
any[]

Options of the product (for example size, colour; stored in lower case), each with its id, name and the list of values used by its variants. Present only when the product's option values are loaded.

variants
array

Variants of the product. Present only when requested with include=variants.

images
array

Pictures of the product. Present only when requested with include=images.

category
object | null

Catalog category of the product, or null when it has none. Present only when requested with include=category.

organization_id

Identifier of the organization the record belongs to.