ProductDTO

internal.ProductTypes.ProductDTO

A product's data.

Properties

categoriesnull | ProductCategoryDTO[]

The associated product categories. It may only be available if the categories relation is expanded.

collectionProductCollectionDTORequired

The associated product collection. It may only be available if the collection relation is expanded.

created_atstring | Date

When the product was created.

deleted_atstring | Date

When the product was deleted.

descriptionnull | string

The description of the product. It can possibly be null.

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. It can possibly be null.

heightnull | number

The height of the product. It can possibly be null.

hs_codenull | string

The HS Code of the product. It can possibly be null.

idstringRequired

The ID of the product.

imagesProductImageDTO[]Required

The associated product images. It may only be available if the images relation is expanded.

is_giftcardbooleanRequired

Whether the product is a gift card.

lengthnull | number

The length of the product. It can possibly be null.

materialnull | string

The material of the product. It can possibly be null.

metadataRecord<string, unknown>

mid_codenull | string

The MID Code of the product. It can possibly be null.

optionsProductOptionDTO[]Required

The associated product options. It may only be available if the options relation is expanded.

origin_countrynull | string

The origin country of the product. It can possibly be null.

statusProductStatusRequired

The status of the product. Its value can be one of the values of the enum ProductStatus.

subtitlenull | string

The subttle of the product. It can possibly be null.

tagsProductTagDTO[]Required

The associated product tags. It may only be available if the tags relation is expanded.

thumbnailnull | string

The URL of the product's thumbnail. It can possibly be null.

titlestringRequired

The title of the product.

typeProductTypeDTO[]Required

The associated product type. It may only be available if the type relation is expanded.

updated_atstring | Date

When the product was updated.

variantsProductVariantDTO[]Required

The associated product variants. It may only be available if the variants relation is expanded.

weightnull | number

The weight of the product. It can possibly be null.

widthnull | number