ProductVariantDTO
A product variant's data.
Properties
allow_backorder
booleanWhether the product variant can be ordered when it's out of stock.
barcode
null | stringThe barcode of the product variant. It can possibly be
null
.created_at
string | DateRequiredWhen the product variant was created.
deleted_at
string | DateRequiredWhen the product variant was deleted.
ean
null | stringThe EAN of the product variant. It can possibly be
null
.height
null | numberThe height of the product variant. It can possibly be
null
.hs_code
null | stringThe HS Code of the product variant. It can possibly be
null
.id
stringRequiredThe ID of the product variant.
inventory_quantity
numberRequiredThe inventory quantiy of the product variant.
length
null | numberThe length of the product variant. It can possibly be
null
.manage_inventory
booleanWhether the product variant's inventory should be managed by the core system.
material
null | stringThe material of the product variant. It can possibly be
null
.metadata
null | Record<string, unknown>Holds custom data in key-value pairs.
mid_code
null | stringThe MID Code of the product variant. It can possibly be
null
.The associated product options. It may only be available if the options
relation is expanded.
options
relation is expanded.origin_country
null | stringThe origin country of the product variant. It can possibly be
null
.The associated product. It may only be available if the product
relation is expanded.
product
relation is expanded.product_id
stringRequiredThe ID of the associated product.
sku
null | stringThe SKU of the product variant. It can possibly be
null
.title
stringRequiredThe tile of the product variant.
upc
null | stringThe UPC of the product variant. It can possibly be
null
.updated_at
string | DateRequiredWhen the product variant was updated.
variant_rank
null | numberThe ranking of the variant among other variants associated with the product. It can possibly be
null
.weight
null | numberThe weight of the product variant. It can possibly be
null
.width
null | numberThe width of the product variant. It can possibly be
null
.Was this section helpful?