productVariantsBulkUpdate
mutation

Choose a version:

Requires write_products access scope. Also: The user must have a permission to update product variants.

Updates multiple variants in a single product. This mutation can be called directly or via the bulkOperation.

Anchor to section titled 'Arguments'

Arguments

Anchor to allowPartialUpdates allowPartialUpdates Boolean default:false: When partial updates are allowed, valid variant changes may be persisted even if some of the variants updated have invalid data and cannot be persisted. When partial updates are not allowed, any error will prevent all variants from updating.
Anchor to media media [CreateMediaInput!]: List of new media to be added to the product.
Anchor to productId productId ID! required: The ID of the product associated with the variants to update.
Anchor to variants variants [ProductVariantsBulkInput!]! required: An array of product variants to update.

Was this section helpful?

Anchor to section titled 'ProductVariantsBulkUpdatePayload returns'

ProductVariantsBulkUpdatePayload returns

Anchor to ProductVariantsBulkUpdatePayload.product product Product: The updated product object.
Anchor to ProductVariantsBulkUpdatePayload.productVariants productVariants [ProductVariant!]: The updated variants.
Anchor to ProductVariantsBulkUpdatePayload.userErrors userErrors [ProductVariantsBulkUpdateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

mutation productVariantsBulkUpdate($productId: ID!, $variants: [ProductVariantsBulkInput!]!) {
  productVariantsBulkUpdate(productId: $productId, variants: $variants) {
    product {
      id
    }
    productVariants {
      id
      metafields(first: 2) {
        edges {
          node {
            namespace
            key
            value
          }
        }
      }
    }
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation productVariantsBulkUpdate($productId: ID!, $variants: [ProductVariantsBulkInput!]!) { productVariantsBulkUpdate(productId: $productId, variants: $variants) { product { id } productVariants { id metafields(first: 2) { edges { node { namespace key value } } } } userErrors { field message } } }",
 "variables": {
    "productId": "gid://shopify/Product/20995642",
    "variants": [
      {
        "id": "gid://shopify/ProductVariant/1070325053",
        "metafields": [
          {
            "id": "gid://shopify/Metafield/1069228989",
            "value": "SYNTHETIC LEATHER"
          },
          {
            "namespace": "my_fields",
            "key": "sole_material",
            "value": "RUBBER",
            "type": "single_line_text_field"
          }
        ]
      },
      {
        "id": "gid://shopify/ProductVariant/1070325054",
        "metafields": [
          {
            "id": "gid://shopify/Metafield/1069228990",
            "value": "SYNTHETIC LEATHER"
          },
          {
            "namespace": "my_fields",
            "key": "sole_material",
            "value": "CREPE",
            "type": "single_line_text_field"
          }
        ]
      }
    ]
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation productVariantsBulkUpdate($productId: ID!, $variants: [ProductVariantsBulkInput!]!) {
    productVariantsBulkUpdate(productId: $productId, variants: $variants) {
      product {
        id
      }
      productVariants {
        id
        metafields(first: 2) {
          edges {
            node {
              namespace
              key
              value
            }
          }
        }
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "productId": "gid://shopify/Product/20995642",
      "variants": [
        {
          "id": "gid://shopify/ProductVariant/1070325053",
          "metafields": [
            {
              "id": "gid://shopify/Metafield/1069228989",
              "value": "SYNTHETIC LEATHER"
            },
            {
              "namespace": "my_fields",
              "key": "sole_material",
              "value": "RUBBER",
              "type": "single_line_text_field"
            }
          ]
        },
        {
          "id": "gid://shopify/ProductVariant/1070325054",
          "metafields": [
            {
              "id": "gid://shopify/Metafield/1069228990",
              "value": "SYNTHETIC LEATHER"
            },
            {
              "namespace": "my_fields",
              "key": "sole_material",
              "value": "CREPE",
              "type": "single_line_text_field"
            }
          ]
        }
      ]
    },
  },
);

const data = await response.json();

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation productVariantsBulkUpdate($productId: ID!, $variants: [ProductVariantsBulkInput!]!) {
    productVariantsBulkUpdate(productId: $productId, variants: $variants) {
      product {
        id
      }
      productVariants {
        id
        metafields(first: 2) {
          edges {
            node {
              namespace
              key
              value
            }
          }
        }
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "productId": "gid://shopify/Product/20995642",
  "variants": [{"id"=>"gid://shopify/ProductVariant/1070325053", "metafields"=>[{"id"=>"gid://shopify/Metafield/1069228989", "value"=>"SYNTHETIC LEATHER"}, {"namespace"=>"my_fields", "key"=>"sole_material", "value"=>"RUBBER", "type"=>"single_line_text_field"}]}, {"id"=>"gid://shopify/ProductVariant/1070325054", "metafields"=>[{"id"=>"gid://shopify/Metafield/1069228990", "value"=>"SYNTHETIC LEATHER"}, {"namespace"=>"my_fields", "key"=>"sole_material", "value"=>"CREPE", "type"=>"single_line_text_field"}]}]
}

response = client.query(query: query, variables: variables)

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation productVariantsBulkUpdate($productId: ID!, $variants: [ProductVariantsBulkInput!]!) {
      productVariantsBulkUpdate(productId: $productId, variants: $variants) {
        product {
          id
        }
        productVariants {
          id
          metafields(first: 2) {
            edges {
              node {
                namespace
                key
                value
              }
            }
          }
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "productId": "gid://shopify/Product/20995642",
      "variants": [
        {
          "id": "gid://shopify/ProductVariant/1070325053",
          "metafields": [
            {
              "id": "gid://shopify/Metafield/1069228989",
              "value": "SYNTHETIC LEATHER"
            },
            {
              "namespace": "my_fields",
              "key": "sole_material",
              "value": "RUBBER",
              "type": "single_line_text_field"
            }
          ]
        },
        {
          "id": "gid://shopify/ProductVariant/1070325054",
          "metafields": [
            {
              "id": "gid://shopify/Metafield/1069228990",
              "value": "SYNTHETIC LEATHER"
            },
            {
              "namespace": "my_fields",
              "key": "sole_material",
              "value": "CREPE",
              "type": "single_line_text_field"
            }
          ]
        }
      ]
    },
  },
});

use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$query = <<<QUERY
  mutation productVariantsBulkUpdate($productId: ID!, $variants: [ProductVariantsBulkInput!]!) {
    productVariantsBulkUpdate(productId: $productId, variants: $variants) {
      product {
        id
      }
      productVariants {
        id
        metafields(first: 2) {
          edges {
            node {
              namespace
              key
              value
            }
          }
        }
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY;

$variables = [
  "productId" => "gid://shopify/Product/20995642",
  "variants" => [{"id"=>"gid://shopify/ProductVariant/1070325053", "metafields"=>[{"id"=>"gid://shopify/Metafield/1069228989", "value"=>"SYNTHETIC LEATHER"}, {"namespace"=>"my_fields", "key"=>"sole_material", "value"=>"RUBBER", "type"=>"single_line_text_field"}]}, {"id"=>"gid://shopify/ProductVariant/1070325054", "metafields"=>[{"id"=>"gid://shopify/Metafield/1069228990", "value"=>"SYNTHETIC LEATHER"}, {"namespace"=>"my_fields", "key"=>"sole_material", "value"=>"CREPE", "type"=>"single_line_text_field"}]}],
];

$response = $client->query(["query" => $query, "variables" => $variables]);

Input variables

{
  "productId": "gid://shopify/Product/20995642",
  "variants": [
    {
      "id": "gid://shopify/ProductVariant/1070325053",
      "metafields": [
        {
          "id": "gid://shopify/Metafield/1069228989",
          "value": "SYNTHETIC LEATHER"
        },
        {
          "namespace": "my_fields",
          "key": "sole_material",
          "value": "RUBBER",
          "type": "single_line_text_field"
        }
      ]
    },
    {
      "id": "gid://shopify/ProductVariant/1070325054",
      "metafields": [
        {
          "id": "gid://shopify/Metafield/1069228990",
          "value": "SYNTHETIC LEATHER"
        },
        {
          "namespace": "my_fields",
          "key": "sole_material",
          "value": "CREPE",
          "type": "single_line_text_field"
        }
      ]
    }
  ]
}

productVariantsBulkUpdatemutation

Arguments

ProductVariantsBulkUpdatePayload returns

Examples

productVariantsBulkUpdate
mutation