UpdateProductDTO

The data to update in a product. The id is used to identify which product to update.

idstringRequired

The ID of the product to update.

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.

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.

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.

statusProductStatus

The status of the product.

typeCreateProductTypeDTO

The product type to create and associate with the product.

type_idnull | string

The product type to be associated with the product.

collection_idnull | string

The product collection to be associated with the product.

tagsCreateProductTagDTO[]

The product tags to be created and associated with the product.

categoriesobject[]

The product categories to associate with the product.

optionsCreateProductOptionDTO[]

The product options to be created and associated with the product.

variants(CreateProductVariantDTO | UpdateProductVariantDTO)[]

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.