Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

CreateProductDTO

A product to create.

titlestring
The title of the product.
idstringOptional
Optionally pass an ID when creating a product.
subtitlestringOptional
The subttle of the product.
descriptionstringOptional
The description of the product.
is_giftcardbooleanOptional
Whether the product is a gift card.
discountablebooleanOptional
Whether the product can be discounted.
thumbnailstringOptional
The URL of the product's thumbnail.
handlestringOptional
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.
statusProductStatusOptional
The status of the product.
imagesUpsertProductImageDTO[]Optional
The associated images to created or updated.
external_idstringOptional
The id of the product in an external system
type_idstringOptional
The product type id to associate with the product.
collection_idstringOptional
The product collection to associate with the product.
tag_idsstring[]Optional
The tags to be associated with the product.
category_idsstring[]Optional
The product categories to associate with the product.
optionsCreateProductOptionDTO[]Optional
The product options to be created and associated with the product.
variantsCreateProductVariantDTO[]Optional
The product variants to be created and associated with the product.
widthnumberOptional
The width of the product.
heightnumberOptional
The height of the product.
lengthnumberOptional
The length of the product.
weightnumberOptional
The weight of the product.
origin_countrystringOptional
The origin country of the product.
hs_codestringOptional
The HS Code of the product.
materialstringOptional
The material of the product.
mid_codestringOptional
The MID Code of the product.
metadataMetadataTypeOptional
Holds custom data in key-value pairs.
Was this page helpful?
Edit this page