ProductDTO

A product's data.

Properties

categoriesnull | ProductCategoryDTO[]

The associated product categories.

collectionProductCollectionDTORequired

The associated product collection.

created_atstring | Date

When the product was created.

deleted_atstring | Date

When the product was deleted.

descriptionnull | string

The description of the product.

discountableboolean

Whether the product can be discounted.

external_idnull | string

The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain a reference to the ID in the integrated service.

handlenull | string

The handle of the product. The handle can be used to create slug URL paths.

heightnull | number

The height of the product.

hs_codenull | string

The HS Code of the product.

idstringRequired

The ID of the product.

imagesProductImageDTO[]Required

The associated product images.

is_giftcardbooleanRequired

Whether the product is a gift card.

lengthnull | number

The length of the product.

materialnull | string

The material of the product.

metadataRecord<string, unknown>

Holds custom data in key-value pairs.

mid_codenull | string

The MID Code of the product.

optionsProductOptionDTO[]Required

The associated product options.

origin_countrynull | string

The origin country of the product.

statusProductStatusRequired

The status of the product.

subtitlenull | string

The subttle of the product.

tagsProductTagDTO[]Required

The associated product tags.

thumbnailnull | string

The URL of the product's thumbnail.

titlestringRequired

The title of the product.

typeProductTypeDTO[]Required

The associated product type.

updated_atstring | Date

When the product was updated.

variantsProductVariantDTO[]Required

The associated product variants.

weightnull | number

The weight of the product.

widthnull | number

The width of the product.