Skip to content

Variants

Inspect variants and work with spreadsheet editing sessions.

Fields

idstringUnique identifier of the resource.
namestringVariant name, up to 200 characters; defaults to the product name.
skustringStock keeping unit (SKU).
statusenumVariant status: active, inactive, outOfStock, discontinued, pendingMapping or withError.outOfStock · discontinued · pendingMapping · withError · active · inactive
pricenumberSelling price in currency.
currencystringThree-letter currency code of the product prices.
versioninteger
productNamestringName of the product.
See all 51 fields
productDescriptionstringDescription of the product.
productSlugstringURL slug of the product.
productTypeenumProduct type: product, service or bundle.product · service · bundle
productIsDigitalbooleanWhether the product is digital.
productStatusenumProduct status: draft, active, inactive, outOfStock, discontinued or archived.draft · active · inactive · outOfStock · discontinued · archived
productImagestringURL of the product's main image; empty when it has none.
thumbnailstringURL of the variant's main image, or productImage when it has none.
brandNamestringName of the product's brand; null when it has none.
categoryNamestringName of the product's category; null when it has none.
tagsarray<string>Tags of the product.
barcodestringBarcode of the variant, such as EAN or UPC.
isDigitalbooleanWhether the variant is digital and needs no shipping.
allowBackordersbooleanWhether buyers can order with no stock available.
onHandintegerUnits on hand across all locations.
committedintegerUnits reserved for unfulfilled orders across all locations.
availableintegerUnits available to sell across all locations.
orderintegerPosition among the product's variants; lower values come first.
isDefaultbooleanWhether this is the product's default variant.
countryOfOriginstringCountry of origin for customs, up to 10 characters.
hsCodestringHarmonized System code for customs, up to 50 characters.
compareAtPricenumberCompare-at price in currency; null when not set.
costPricenumberUnit cost in currency; null when not set.
lowStockThresholdintegerStock counts as low when available units are at or below this.
weightnumberWeight in unitOfMeasure.
widthnumberWidth in centimeters.
heightnumberHeight in centimeters.
lengthnumberLength in centimeters.
unitOfMeasureenumUnit for weight: kilogram, gram, pound or ounce.kilogram · gram · pound · ounce
requiresShippingbooleanWhether the variant must be shipped; false for digital items and service or bundle products.
trackInventorybooleanWhether stock is tracked; always false for service and bundle products.
imagesarray<object>Product images assigned to this variant.
optionsarray<object>Option values that define the variant, such as size or color.
inventoriesarray<object>Stock per location.
optionValuesobjectOption values keyed by option ID; same data as options.
createdOnstringTimestamp when the resource was created, in ISO 8601.
updatedOnstringTimestamp when the resource was last modified, in ISO 8601.
storeIdstringID of the store.
productIdstringID of the product the variant belongs to.
sellerIdstringThe seller of the sale. The store's own products use its internal seller.
packageIdstringID of the shipping package, or the product's when the variant has none.
shippingProfileIdstringID of the product's shipping profile; null when none is set.
brandIdstringID of the product's brand; null when it has none.
categoryIdstringID of the product's category; null when it has none.

Operations

MethodEndpointOperation
POST/v1/catalog/variants/sku-matchesFind the variants of a pasted SKU list
GET/v1/catalog/variants/{variantId}Get variant by ID
PATCH/v1/catalog/variants/{variantId}Update a product variant
DELETE/v1/catalog/variants/{variantId}Delete a product variant
POST/v1/catalog/products/{productId}/variantsCreate a product variant
GET/v1/catalog/products/{productId}/variantsList product variants

Last updated: