CreateProductDTO
A product to create.
categories
object[]The product categories to associate with the product.
categories
object[]collection_id
stringThe product collection to be associated with the product.
description
stringThe description of the product.
discountable
booleanWhether the product can be discounted.
handle
stringThe handle of the product. The handle can be used to create slug URL paths.
If not supplied, the value of the
handle
attribute of the product is set to the slug version of the title
attribute.height
numberThe height of the product.
hs_code
stringThe HS Code of the product.
images
string[] | object[]The product's images. If an array of strings is supplied, each string will be a URL and a
ProductImage
will be created
and associated with the product. If an array of objects is supplied, you can pass along the ID of an existing ProductImage
.is_giftcard
booleanWhether the product is a gift card.
length
numberThe length of the product.
material
stringThe material of the product.
metadata
Record<string, unknown>Holds custom data in key-value pairs.
mid_code
stringThe MID Code of the product.
options
CreateProductOptionDTO[]The product options to be created and associated with the product.
options
CreateProductOptionDTO[]origin_country
stringThe origin country of the product.
status
ProductStatusThe status of the product.
status
ProductStatussubtitle
stringThe subttle of the product.
tags
CreateProductTagDTO[]The product tags to be created and associated with the product.
tags
CreateProductTagDTO[]thumbnail
stringThe URL of the product's thumbnail.
title
stringRequiredThe title of the product.
The product type to create and associate with the product.
type_id
stringThe product type to be associated with the product.
variants
CreateProductVariantDTO[]The product variants to be created and associated with the product.
variants
CreateProductVariantDTO[]weight
numberThe weight of the product.
width
numberThe width of the product.
Was this section helpful?