Skip to main content
Skip to main content

CreateProductDTO

A product to create.

categoriesobject[]
The product categories to associate with the product.
collection_idstring
The product collection to be associated with the product.
descriptionstring
The description of the product.
discountableboolean
Whether the product can be discounted.
handlestring
The 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.
heightnumber
The height of the product.
hs_codestring
The HS Code of the product.
imagesstring[] | 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_giftcardboolean
Whether the product is a gift card.
lengthnumber
The length of the product.
materialstring
The material of the product.
metadataRecord<string, unknown>
Holds custom data in key-value pairs.
mid_codestring
The MID Code of the product.
The product options to be created and associated with the product.
origin_countrystring
The origin country of the product.
The status of the product.
subtitlestring
The subttle of the product.
The product tags to be created and associated with the product.
thumbnailstring
The URL of the product's thumbnail.
titlestringRequired
The title of the product.
The product type to create and associate with the product.
type_idstring
The product type to be associated with the product.
The product variants to be created and associated with the product.
weightnumber
The weight of the product.
widthnumber
The width of the product.
Was this section helpful?