ProductVariantDTO

internal.ProductTypes.ProductVariantDTO

A product variant's data.

Properties

allow_backorderboolean

Whether the product variant can be ordered when it's out of stock.

barcodenull | string

The barcode of the product variant. It can possibly be null.

created_atstring | DateRequired

When the product variant was created.

deleted_atstring | DateRequired

When the product variant was deleted.

eannull | string

The EAN of the product variant. It can possibly be null.

heightnull | number

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

hs_codenull | string

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

idstringRequired

The ID of the product variant.

inventory_quantitynumberRequired

The inventory quantiy of the product variant.

lengthnull | number

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

manage_inventoryboolean

Whether the product variant's inventory should be managed by the core system.

materialnull | string

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

metadatanull | Record<string, unknown>

Holds custom data in key-value pairs.

mid_codenull | string

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

optionsProductOptionValueDTORequired

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

origin_countrynull | string

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

productProductDTORequired

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

product_idstringRequired

The ID of the associated product.

skunull | string

The SKU of the product variant. It can possibly be null.

titlestringRequired

The tile of the product variant.

upcnull | string

The UPC of the product variant. It can possibly be null.

updated_atstring | DateRequired

When the product variant was updated.

variant_ranknull | number

The ranking of the variant among other variants associated with the product. It can possibly be null.

weightnull | number

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

widthnull | number

The width of the product variant. It can possibly be null.