AdminPostProductsProductReq
constructor
Properties
Product categories to add the Product to.
collection_id
stringThe ID of the Product Collection the Product belongs to.
description
stringThe description of the Product.
discountable
booleanA flag to indicate if discounts can be applied to the Line Items generated from this Product
handle
stringA 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.
height
numberThe height of the Product.
hs_code
stringThe Harmonized System code of the product variant.
images
string[]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.
length
numberThe length of the Product.
material
stringThe material composition of the Product.
metadata
Record<string, unknown>An optional set of key-value pairs with additional information.
mid_code
stringThe Manufacturer Identification code of the Product.
origin_country
stringThe country of origin of the Product.
sales_channels
null | ProductSalesChannelReq[]Sales channels to associate the Product with.
status
ProductStatusThe status of the product. The product is shown to the customer only if its status is published
.
status
ProductStatuspublished
.subtitle
stringThe subtitle of the Product
tags
ProductTagReq[]Product Tags to associate the Product with.
tags
ProductTagReq[]thumbnail
stringThe 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.
title
stringThe title of the Product
type
ProductTypeReqThe Product Type to associate the Product with.
type
ProductTypeReqvariants
ProductVariantReq[]An array of Product Variants to create with the Product. Each product variant must have a unique combination of Product Option values.
variants
ProductVariantReq[]weight
numberThe weight of the Product.
width
numberThe width of the Product.
Was this section helpful?