Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Body

application/json
name
string
status
enum<string>

A product can't be set to active until it has at least one price variant. Create it as draft (or omit — draft is the default), add a price variant via POST /v1/price_variants, then PATCH the product to active.

Available options:
draft,
active,
archived
description
string
body_html
string
slug
string
button_cta
string | null
available_from
string<date-time> | null
available_until
string<date-time> | null
tax_code
string | null
images
string[]

MediaLibrary file ids (e.g. file_abc123) to set as the product gallery; the first is the cover. Replaces the existing gallery — an empty array clears it. Create files via POST /v1/files or POST /v1/images/generate.

Example:

Response

Product created

id
string
required
object
string
required
name
string
required
slug
string
required
status
enum<string>
required
Available options:
draft,
active,
archived
description
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
body_html
string
required
button_cta
string | null
required
url
string
required
available_from
string<date-time> | null
required
available_until
string<date-time> | null
required
published_at
string<date-time> | null
required
reviews_count
integer
required
average_rating
number | null
required
price_variants
object[]
required
seo

ID by default, full object when expanded

reviews
object[]