Agent-readable docs index: /llms.txt. Download /docs.zip to grep all markdown files locally.

Fields

path idID!required
The unique identifier for the Shopify product variant. This field is required.
path titleString!required
The title of the Shopify product variant. This field is required.
path imageImage!required
The image associated with the Shopify product variant. This field is required.
path isAvailableBoolean!required
Indicates whether the variant is available to be sold or not. Note that variants with negative inventory may still be available for sale depending on the Shopify variant's inventory policy. This field is required.
path quantityAvailableInt
The quantity of this variant available for purchase. This field will only be populated for integrated Shopify product variants, otherwise it will be null.
path compareAtPriceString!required
The original price of the variant, which can be used to show the current price at a discount against this price.
path priceV2Price!required
The current price of the product variant.
path priceString!requireddeprecated
The current price of the product variant.
path priceCentsInt!required
Current price of the product in cents.
path isShippingRequiredBoolean!required
Indicates whether this product requires shipping, which can be used to distinguish between physical and digital products.
path SKUString!required
The product SKU (Stock Keeping Unit) of the variant.
path isTaxableBoolean!required
Indicates whether taxes can be applied to this product.
path weightInt!required
The weight of the product in grams.
path option1String
Additional options available for this product, usually representing extra customizations.
path option2String
Additional options available for this product, usually representing extra customizations.
path option3String
Additional options available for this product, usually representing extra customizations.
path barcodeString
Barcode of the product variant

Related types

Rye
Powered byHolocron