An access token is required to call this API. Refer to Authorization for more information about how to obtain the token.
The current interface is about to be discontinued, and new integrations will no longer be directly accessible. For applying for access permissions, please contact the platform through the ticketing system.
Arguments
id ● ID
The id of ProductVariant.
ids ● [ID]
The ids of ProductVariant.
Returns
availableForSale ● Boolean
Indicates if the product variant is available for sale.
barcode ● String
The barcode (for example, ISBN, UPC, or GTIN) associated with the variant.
compareAtPrice ● Money
The original price of the variant. This can be used to mark a variant as on sale, when compareAtPrice is higher than price.
createdAt ● Date
deprecated
Creation time
displayName ● String
deprecated
Display name of the variant
id ● ID!non-null
A globally-unique ID.
image ● Image
Image associated with the product variant.
inventoryPolicy ● ProductVariantInventoryPolicy
deprecated
Whether customers are allowed to place an order for the product variant when it's out of stock.
inventoryQuantity ● Int
The total sellable quantity of the variant.
inventoryTracker ● String
deprecated
Whether to track inventory
metafield ● Metafield
Metafield associated with the variant
metafields ● [Metafield]
Metafields associated with the variant
parentProduct ● Product
The parent product object of the variant.
price ● Money
The product variant’s price.
product ● String
Product ID
requiresShipping ● Boolean
Whether a customer needs to provide a shipping address when placing an order for the product variant.
selectedOptions ● [SelectedOption]
List of product options applied to the variant.
sku ● String
The SKU (stock keeping unit) associated with the variant.
taxable ● Boolean
Whether tax is charged when the product variant is sold
title ● String
The product variant’s title.
updatedAt ● Date
deprecated
Update time
weight ● String
The weight of the product variant in the unit system specified with weight_unit.
weightUnit ● String
Unit of measurement for weight.
  • g
  • kg
  • lb
  • oz
  • zh_kg
Error Code
For more information about common error codes, refer to Status and error codes.
Was this article helpful to you?