AdminPostProductsReq

The details of the product to create.

Properties

titlestringRequired

The title of the Product

is_giftcardbooleanRequired

A flag to indicate if the Product represents a Gift Card. Purchasing Products with this flag set to true will result in a Gift Card being created.

Default: false

discountablebooleanRequired

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

Default: true

subtitlestring

The subtitle of the Product

descriptionstring

The description of the Product.

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.

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.

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.

statusProductStatus

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

Default: ProductStatus.DRAFT

typeProductTypeReq

The Product Type to associate the Product with.

collection_idstring

The ID of the Product Collection the Product belongs to.

tagsProductTagReq[]

Product Tags to associate the Product with.

sales_channelsProductSalesChannelReq[]

Sales channels to associate the Product with.

categoriesProductProductCategoryReq[]

Product categories to add the Product to.

optionsProductOptionReq[]

The Options that the Product should have. A new product option will be created for every item in the array.

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.

lengthnumber

The length of the Product.

heightnumber

The height of the Product.

widthnumber

The width of the Product.

hs_codestring

The Harmonized System code of the Product.

origin_countrystring

The country of origin of the Product.

mid_codestring

The Manufacturer Identification code of the Product.

materialstring

The material composition of the Product.

metadataRecord<string, unknown>

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