disableProductVariants is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.


Disable a product variant

This page contains

    Authorization Rules

    This request requires authorization with at least one of the following scopes:






    input DisableProductVariantsInput! PREVIEW

    DisableProductVariantsInput fields

    productId ID!

    Id of the product to disable its variants

    configuration [ProductVariantConfigurationInput!]! PREVIEW

    List of option, value that will be computed to correspond to one or more product variants. Example configuration:

    • [] -> to update all the variants for that product.
    • [{optionCode: 'Colour', valueCode: 'Blue'}] -> to update all "blue" variants.
    • [{optionCode: 'Colour', valueCode: 'Blue'}, {optionCode: 'Colour', valueCode: 'Green'}] -> to update the variants that are Blue or Green.
    • [{optionCode: 'Colour', valueCode: 'Blue'}, {optionCode: 'Size', valueCode: 'M'}] -> to update the variants of colour Blue and size M.

    Return Fields

    product Product PREVIEW


    userErrors [DisableProductVariantsError!] PREVIEW

    Errors that occurred when disabling variants

    Interactive example

    This is an example mutation query. Use the embedded interactive tool below to edit the query.

    Hint: use Ctrl + Space for autocompleting fields.