CreateProductDTO
A product to create.
title
stringRequiredThe title of the product.
subtitle
stringThe subttle of the product.
description
stringThe description of the product.
is_giftcard
booleanWhether the product is a gift card.
discountable
booleanWhether the product can be discounted.
thumbnail
stringThe URL of the product's thumbnail.
handle
stringThe 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.status
ProductStatusThe status of the product.
status
ProductStatusimages
UpsertProductImageDTO[]The associated images to created or updated.
images
UpsertProductImageDTO[]type_id
stringThe product type id to associate with the product.
collection_id
stringThe product collection to associate with the product.
tags
UpsertProductTagDTO[]The associated tags to be created or updated.
tags
UpsertProductTagDTO[]category_ids
string[]The product categories to associate with the product.
options
CreateProductOptionDTO[]The product options to be created and associated with the product.
options
CreateProductOptionDTO[]variants
CreateProductVariantDTO[]The product variants to be created and associated with the product.
variants
CreateProductVariantDTO[]width
numberThe width of the product.
height
numberThe height of the product.
length
numberThe length of the product.
weight
numberThe weight of the product.
origin_country
stringThe origin country of the product.
hs_code
stringThe HS Code of the product.
material
stringThe material of the product.
mid_code
stringThe MID Code of the product.
metadata
Record<string, unknown>Holds custom data in key-value pairs.
Was this section helpful?