Development Resources

ProductVariantDTO

A product variant's data.

idstring
The ID of the product variant.
titlestring
The tile of the product variant.
skunull | string
The SKU of the product variant.
barcodenull | string
The barcode of the product variant.
eannull | string
The EAN of the product variant.
upcnull | string
The UPC of the product variant.
allow_backorderboolean
Whether the product variant can be ordered when it's out of stock.
manage_inventoryboolean
Whether the product variant's inventory should be managed by the core system.
requires_shippingboolean
Whether the product variant's requires shipping.
hs_codenull | string
The HS Code of the product variant.
origin_countrynull | string
The origin country of the product variant.
mid_codenull | string
The MID Code of the product variant.
materialnull | string
The material of the product variant.
weightnull | number
The weight of the product variant.
lengthnull | number
The length of the product variant.
heightnull | number
The height of the product variant.
widthnull | number
The width of the product variant.
optionsProductOptionValueDTO[]
The associated product options.
metadatanull | Record<string, unknown>
Holds custom data in key-value pairs.
product_idnull | string
The associated product id.
created_atstring | Date
When the product variant was created.
updated_atstring | Date
When the product variant was updated.
deleted_atstring | Date
When the product variant was deleted.
productnull | ProductDTOOptional
The associated product.
variant_ranknull | numberOptional
he ranking of the variant among other variants associated with the product.
Was this page helpful?
Edit this page