Search docs
Sign InDescription
Modify one or multiple variants.
Permission bit: "product_variants.modify"
Topic: Product Variants
Arguments
data: [ProductVariantModify!]!
Main argument for mutations.
List of product variant ids. See also: Unique Identifiers
Example: ["va_EQzGqWoY"]
Unique product identifier. See also: Unique Identifiers
Example: "pd_EQzGqWoY"
Unique shop identifier. See also: Unique Identifiers
Example: "sh_EQzGqWoY"
Data Argument Fields
Attachment file ID
Example: "fi_EQzGqWoY"
Valid when: attachment_id matches regexp pattern: ^fi_|^fc_
The barcode, UPC or ISBN number for the product
Example: "1234_pink"
Valid when: barcode's length doesn't exceed 250 characters
bundle_line_items: [BundleLineItemCreate!]
Items in the bundle
The cost price of the product variant
Example: 150
Valid when: cost_price is a non-negative integer
Country of origin (ISO 3166-1 alpha-2)
Example: "US"
currency_prices: [VariantCurrencyPrice!]
List of prices specific to currencies
custom_fields: [CustomFieldCreate!]
customer_group_prices: [VariantCustomerGroupPrice!]
List of prices specific to customer groups
Whether discount can be applied to this variant or not
Example: false
Amount of days the product is available for download after purchase (digital product), 0 if not limited
Example: 5
fulfillment_service: FulfillmentService
Service who is doing the fulfillment
The weight of the product variant in grams
Example: 200
Valid when: grams is a non-negative integer
Height of the product (in millimeters) used which can be used when calculating shipping costs
Example: 200
Valid when: height is a non-negative integer
Harmonized System (HS) Code
Example: "6404.19"
Valid when: hs_code's length doesn't exceed 250 characters
inventory_management: InventoryManagement
Specifies whether or not system tracks the number of items in stock for this product variant
inventory_policy: InventoryPolicy
Specifies whether or not customers are allowed to place an order for a product variant when it's out of stock
Whether this variant is a default variant of a product
Example: false
Length of the product (in millimeters) used which can be used when calculating shipping costs
Example: 200
Valid when: length is a non-negative integer
The minimum advertised price of the product variant
Example: 190
Valid when: map_price is a non-negative integer
Maximum number of downloads (digital product), 0 if not limited
Example: 10
media_files: [MediaFileCreate!]
Media files for this variant
Translatable
options: [VariantOptionCreate!]
List of options
The order of the product variant in the list of product variants
Example: 0
The price of the product variant
Example: 190
Valid when: price is a non-negative integer
The retail cost of the product variant
Example: 190
Valid when: retail_price is a non-negative integer
Special price for a product that can be active during a selected period of time
Example: 120
Valid when: sale_price is a non-negative integer
Lower date boundary when sale price is active
Example: "2014-09-04T12:23:34Z"
Timestamp (RFC 3339)
Upper date boundary when sale price is active
Example: "2014-09-04T12:23:34Z"
Timestamp (RFC 3339)
A unique identifier for the product variant in the shop (stock keeping unit)
Example: "IPOD2008PINK"
Valid when: sku is not empty
Valid when: sku's length doesn't exceed 250 characters
suppliers: [VariantSupplierCreate!]
List of suppliers for this variant
Tax class of this variant
Example: "default"
Valid when: tax_class is not empty
Valid when: tax_class's length doesn't exceed 250 characters
Specifies whether or not a tax is charged when the product variant is sold
Example: true
tiered_pricing: TieredPricingCreate
type: VariantType
Type of the variant
Width of the product (in millimeters) used which can be used when calculating shipping costs
Example: 200
Valid when: width is a non-negative integer
Result
Preview (typescript)
Loading module