Product

A product is a saleable item that holds general information such as name or description. It must include at least one Product Variant, where each product variant defines different options to purchase the product with (for example, different sizes or colors). The prices and inventory of the product are defined on the variant level.

Constructors

constructor

**new Product**()

A product is a saleable item that holds general information such as name or description. It must include at least one Product Variant, where each product variant defines different options to purchase the product with (for example, different sizes or colors). The prices and inventory of the product are defined on the variant level.

Properties

categoriesProductCategory[]Required

The details of the product categories that this product belongs to.

collectionProductCollectionRequired

The details of the product collection that the product belongs to.

collection_idnull | stringRequired

The ID of the product collection that the product belongs to.

created_atDateRequired

The date with timezone at which the resource was created.

deleted_atnull | DateRequired

The date with timezone at which the resource was deleted.

descriptionnull | stringRequired

A short description of the Product.

discountablebooleanRequired

Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to false.

Default: true

external_idnull | stringRequired

The external ID of the product

handlenull | stringRequired

A unique identifier for the Product (e.g. for slug structure).

heightnull | numberRequired

The height of the Product Variant. May be used in shipping rate calculations.

hs_codenull | stringRequired

The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.

idstringRequired

The product's ID

imagesImage[]Required

The details of the product's images.

is_giftcardbooleanRequired

Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.

Default: false

lengthnull | numberRequired

The length of the Product Variant. May be used in shipping rate calculations.

materialnull | stringRequired

The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.

metadatanull | Record<string, unknown>Required

An optional key-value map with additional details

mid_codenull | stringRequired

The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.

optionsProductOption[]Required

The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.

origin_countrynull | stringRequired

The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.

profileShippingProfileRequired

The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.

profile_idstringRequired

The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.

profilesShippingProfile[]Required

Available if the relation profiles is expanded.

sales_channelsSalesChannel[]Required

The details of the sales channels this product is available in.

statusProductStatusRequired

The status of the product

Default: draft

subtitlenull | stringRequired

An optional subtitle that can be used to further specify the Product.

tagsProductTag[]Required

The details of the product tags used in this product.

thumbnailnull | stringRequired

A URL to an image file that can be used to identify the Product.

titlestringRequired

A title that can be displayed for easy identification of the Product.

typeProductTypeRequired

The details of the product type that the product belongs to.

type_idnull | stringRequired

The ID of the product type that the product belongs to.

updated_atDateRequired

The date with timezone at which the resource was updated.

variantsProductVariant[]Required

The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.

weightnull | numberRequired

The weight of the Product Variant. May be used in shipping rate calculations.

widthnull | numberRequired

The width of the Product Variant. May be used in shipping rate calculations.

Methods

afterLoad

Private **afterLoad**(): void

Returns

void

voidvoid

---

beforeInsert

Private **beforeInsert**(): void

Returns

void

voidvoid

---

beforeUpdate

Private **beforeUpdate**(): void

Returns

void

voidvoid