productVariantAppendMedia - admin-graphql - MUTATION

Version: 2024-04

Description:

Appends media from a product to variants of the product.

Access Scopes

`write_products` access scope. Also: The user must have a permission to append media to variants.

Arguments

• productId: ID! - Specifies the product associated to the media.
• variantMedia: ProductVariantAppendMediaInput! - A list of pairs of variants and media to be attached to the variants.

Returns

• product: Product The product associated with the variants and media.
• productVariants: ProductVariant The product variants that were updated.
• userErrors: MediaUserError! The list of errors that occurred from executing the mutation.

Examples

• Append a product's media to variants of the product

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation productVariantAppendMedia($productId: ID!, $variantMedia: [ProductVariantAppendMediaInput!]!) { productVariantAppendMedia(productId: $productId, variantMedia: $variantMedia) { product { id } } }\",\n \"variables\": {\n    \"productId\": \"gid://shopify/Product/1072481072\",\n    \"variantMedia\": [\n      {\n        \"mediaIds\": [\n          \"gid://shopify/MediaImage/1072273216\"\n        ],\n        \"variantId\": \"gid://shopify/ProductVariant/1070325119\"\n      },\n      {\n        \"mediaIds\": [\n          \"gid://shopify/MediaImage/1072273217\"\n        ],\n        \"variantId\": \"gid://shopify/ProductVariant/1070325120\"\n      }\n    ]\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation productVariantAppendMedia($productId: ID!, $variantMedia: [ProductVariantAppendMediaInput!]!) {\n      productVariantAppendMedia(productId: $productId, variantMedia: $variantMedia) {\n        product {\n          id\n        }\n      }\n    }`,\n    \"variables\": {\n      \"productId\": \"gid://shopify/Product/1072481072\",\n      \"variantMedia\": [\n        {\n          \"mediaIds\": [\n            \"gid://shopify/MediaImage/1072273216\"\n          ],\n          \"variantId\": \"gid://shopify/ProductVariant/1070325119\"\n        },\n        {\n          \"mediaIds\": [\n            \"gid://shopify/MediaImage/1072273217\"\n          ],\n          \"variantId\": \"gid://shopify/ProductVariant/1070325120\"\n        }\n      ]\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation productVariantAppendMedia($productId: ID!, $variantMedia: [ProductVariantAppendMediaInput!]!) {\n    productVariantAppendMedia(productId: $productId, variantMedia: $variantMedia) {\n      product {\n        id\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"productId\": \"gid://shopify/Product/1072481072\",\n  \"variantMedia\": [{\"mediaIds\"=>[\"gid://shopify/MediaImage/1072273216\"], \"variantId\"=>\"gid://shopify/ProductVariant/1070325119\"}, {\"mediaIds\"=>[\"gid://shopify/MediaImage/1072273217\"], \"variantId\"=>\"gid://shopify/ProductVariant/1070325120\"}]\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/Product/1072481072\",\n  \"variantMedia\" => [{\"mediaIds\"=>[\"gid://shopify/MediaImage/1072273216\"], \"variantId\"=>\"gid://shopify/ProductVariant/1070325119\"}, {\"mediaIds\"=>[\"gid://shopify/MediaImage/1072273217\"], \"variantId\"=>\"gid://shopify/ProductVariant/1070325120\"}],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation productVariantAppendMedia($productId: ID!, $variantMedia: [ProductVariantAppendMediaInput!]!) {\n    productVariantAppendMedia(productId: $productId, variantMedia: $variantMedia) {\n      product {\n        id\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"productId\": \"gid://shopify/Product/1072481072\",\n      \"variantMedia\": [\n        {\n          \"mediaIds\": [\n            \"gid://shopify/MediaImage/1072273216\"\n          ],\n          \"variantId\": \"gid://shopify/ProductVariant/1070325119\"\n        },\n        {\n          \"mediaIds\": [\n            \"gid://shopify/MediaImage/1072273217\"\n          ],\n          \"variantId\": \"gid://shopify/ProductVariant/1070325120\"\n        }\n      ]\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation productVariantAppendMedia($productId: ID!, $variantMedia: [ProductVariantAppendMediaInput!]!) {\n  productVariantAppendMedia(productId: $productId, variantMedia: $variantMedia) {\n    product {\n      id\n    }\n  }\n}"
        

  input: {
    "productId": "gid://shopify/Product/1072481072",
    "variantMedia": [
      {
        "mediaIds": [
          "gid://shopify/MediaImage/1072273216"
        ],
        "variantId": "gid://shopify/ProductVariant/1070325119"
      },
      {
        "mediaIds": [
          "gid://shopify/MediaImage/1072273217"
        ],
        "variantId": "gid://shopify/ProductVariant/1070325120"
      }
    ]
  }

  response: {
    "data": {
      "productVariantAppendMedia": {
        "product": {
          "id": "gid://shopify/Product/1072481072"
        }
      }
    }
  }