AdminPostProductsProductReq

Properties

categoriesProductProductCategoryReq[]

Product categories to add the Product to.

collection_idstring

The ID of the Product Collection the Product belongs to.

descriptionstring

The description of the Product.

discountableboolean

A flag to indicate if discounts can be applied to the Line Items generated from this Product

handlestring

A unique handle to identify the Product by. If not provided, the kebab-case version of the product title will be used. This can be used as a slug in URLs.

heightnumber

The height of the Product.

hs_codestring

The Harmonized System code of the product variant.

imagesstring[]

An array of images of the Product. Each value in the array is a URL to the image. You can use the upload API Routes to upload the image and obtain a URL.

lengthnumber

The length of the Product.

materialstring

The material composition of the Product.

metadataRecord<string, unknown>

An optional set of key-value pairs with additional information.

mid_codestring

The Manufacturer Identification code of the Product.

origin_countrystring

The country of origin of the Product.

sales_channelsnull | ProductSalesChannelReq[]

Sales channels to associate the Product with.

statusProductStatus

The status of the product. The product is shown to the customer only if its status is published.

subtitlestring

The subtitle of the Product

tagsProductTagReq[]

Product Tags to associate the Product with.

thumbnailstring

The thumbnail to use for the Product. The value is a URL to the thumbnail. You can use the upload API Routes to upload the thumbnail and obtain a URL.

titlestring

The title of the Product

typeProductTypeReq

The Product Type to associate the Product with.

variantsProductVariantReq[]

An array of Product Variants to create with the Product. Each product variant must have a unique combination of Product Option values.

weightnumber

The weight of the Product.

widthnumber

The width of the Product.