Skip to main content
Skip to main content

UpdateProductDTO

The data to update in a product.

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