Product
The input fields for specifying a product variant to create or update.
Anchor to FieldsFields
- barcodes ([BarcodeInput!])
- compareAtPrice (Money)
- file (FileSetInput)
- id (ID)
- inventoryItem (InventoryItemInput)
- inventoryPolicy (ProductVariantInventoryPolicy)
- inventoryQuantities ([ProductSetInventoryInput!])
- metafields ([MetafieldInput!])
- optionValues ([VariantOptionValueInput!]!)
- position (Int)
- price (Money)
- published (Boolean)
- requiresComponents (Boolean)
- showUnitPrice (Boolean)
- sku (String)
- taxable (Boolean)
- taxCode (String)
- unitPriceMeasurement (UnitPriceMeasurementInput)
- barcode (String): deprecated
- Anchor to barcodesbarcodes•[Barcode
Input!] The barcodes to associate with the product variant. Replaces the entire barcode set. A variant accepts up to 20 barcodes, and a given variant input can't set both
barcodeandbarcodes. Refer to theobject for how these barcodes are returned.Show input fields
- Anchor to compareAtPricecompare•Money
At Price The compare-at price of the variant.
- Anchor to filefile•File
Set Input The file to associate with the variant.
Complexity cost: 0.6 per variant file.
Any file specified here must also be specified in the
filesinput for the product.Show input fields
- •ID
Specifies the product variant to update or create a new variant if absent.
- Anchor to inventoryIteminventory•Inventory
Item Item Input The inventory item associated with the variant, used for unit cost.
Show input fields
- Anchor to inventoryPolicyinventory•Product
Policy Variant Inventory Policy Whether customers are allowed to place an order for the product variant when it's out of stock. Defaults to
DENY.Show enum values
- Anchor to inventoryQuantitiesinventory•[Product
Quantities Set Inventory Input!] The inventory quantities at each location where the variant is stocked. If you're updating an existing variant, then you can only update the quantities at locations where the variant is already stocked.
The total number of inventory quantities across all variants in the mutation can't exceed 50000.
Show input fields
- Anchor to metafieldsmetafields•[Metafield
Input!] Additional customizable information about the product variant.
Complexity cost: 0.4 per variant metafield.
Show input fields
- Anchor to optionValuesoption•[Variant
Values Option Value Input!]! required The custom properties that a shop owner uses to define product variants.
Show input fields
- Anchor to positionposition•Int
The order of the product variant in the list of product variants. The first position in the list is 1.
- Anchor to priceprice•Money
The price of the variant.
- Anchor to publishedpublished•Boolean
Indicates whether the product variant is created as published or unpublished. This option is only available for new product variants.
- Anchor to requiresComponentsrequires•Boolean
Components Whether a product variant requires components. The default value is
false. Iftrue, then the product variant can only be purchased as a parent bundle with components and it will be omitted from channels that don't support bundles.- Anchor to showUnitPriceshow•Boolean
Unit Price Whether or not unit price should be shown for this product variant.
- •String
The SKU for the variant. Case-sensitive string.
- Anchor to taxabletaxable•Boolean
Whether the variant is taxable.
- Anchor to taxCodetax•String
Code The tax code associated with the variant.
- Anchor to unitPriceMeasurementunit•Unit
Price Measurement Price Measurement Input The unit price measurement for the product variant.
Show input fields
- Anchor to barcodebarcode•StringDeprecated
Anchor to Input objects using this inputInput objects using this input
- •INPUT OBJECT
The input fields required to create or update a product via ProductSet mutation.