The data to update in a product. The
id is used to identify which product to update.
The ID of the product to update.
The title of the product.
The subttle of the product.
The description of the product.
Whether the product is a gift card.
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
The URL of the product's thumbnail.
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
statusProductStatusThe status of the product.
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.
categoriesobjectThe product categories to associate with the product.
optionsCreateProductOptionDTOThe product options to be created and associated with the product.
The product variants to be created and associated with the product. You can also update existing product variants associated with the product.
The width of the product.
The height of the product.
The length of the product.
The weight of the product.
The origin country of the product.
The HS Code of the product.
The material of the product.
The MID Code of the product.
Holds custom data in key-value pairs.
Was this section helpful?