Product - Product Module Data Models Reference

This documentation provides a reference to the Product data model. It belongs to the Product Module.

idPrimaryKeyModifier<IdProperty>

The ID of the product.

titleTextProperty

The title of the product

handleTextProperty

The unique handle of the product

is_giftcardBooleanProperty

Whether the product is a giftcard.

statusEnumProperty<typeof ProductStatus>

The status of the product

discountableBooleanProperty

Whether the product is discountable.

variantsHasMany<ProductVariant>

The associated variants.

tagsManyToMany<ProductTag>

The associated tags.

optionsHasMany<ProductOption>

The associated options.

imagesHasMany<ProductImage>

The associated images.

categoriesManyToMany<ProductCategory>

The associated categories.

subtitleTextPropertyOptional

The subtitle of the product

descriptionTextPropertyOptional

The description of the product

thumbnailTextPropertyOptional

The thumbnail URL of the product

weightTextPropertyOptional

The weight of the product

lengthTextPropertyOptional

The length of the product

heightTextPropertyOptional

The height of the product

widthTextPropertyOptional

The width of the product

origin_countryTextPropertyOptional

The origin country of the product

hs_codeTextPropertyOptional

The HS code of the product

mid_codeTextPropertyOptional

The MID code of the product

materialTextPropertyOptional

The material of the product

external_idTextPropertyOptional

The external ID of the product, used to store the product's ID in an external system.

metadataJSONPropertyOptional

Holds custom data in key-value pairs.

typeBelongsTo<ProductType>Optional

The associated type.

collectionBelongsTo<ProductCollection>Optional

The associated collection.

Was this page helpful?