productVariantAppendMedia

mutation

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

Appends media from a product to variants of the product.

Arguments

Anchor to productIdproductId • ID!required: Specifies the product associated to the media.
Anchor to variantMediavariantMedia • [ProductVariantAppendMediaInput!]!required: A list of pairs of variants and media to be attached to the variants.

Was this section helpful?

Anchor to ProductVariantAppendMediaPayload returnsProductVariantAppendMediaPayload returns

Anchor to productproduct • Product: The product associated with the variants and media.
Anchor to productVariantsproductVariants • [ProductVariant!]: The product variants that were updated.
Anchor to userErrorsuserErrors • [MediaUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Append a product's media to variants of the product
productVariantAppendMedia reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation productVariantAppendMedia($productId: ID!, $variantMedia: [ProductVariantAppendMediaInput!]!) {
6    productVariantAppendMedia(productId: $productId, variantMedia: $variantMedia) {
7      product {
8        id
9      }
10    }
11  }`,
12  {
13    variables: {
14      "productId": "gid://shopify/Product/1072481072",
15      "variantMedia": [
16        {
17          "mediaIds": [
18            "gid://shopify/MediaImage/1072273216"
19          ],
20          "variantId": "gid://shopify/ProductVariant/1070325119"
21        },
22        {
23          "mediaIds": [
24            "gid://shopify/MediaImage/1072273217"
25          ],
26          "variantId": "gid://shopify/ProductVariant/1070325120"
27        }
28      ]
29    },
30  },
31);
32
33const data = await response.json();
34

mutation productVariantAppendMedia($productId: ID!, $variantMedia: [ProductVariantAppendMediaInput!]!) {
  productVariantAppendMedia(productId: $productId, variantMedia: $variantMedia) {
    product {
      id
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation productVariantAppendMedia($productId: ID!, $variantMedia: [ProductVariantAppendMediaInput!]!) { productVariantAppendMedia(productId: $productId, variantMedia: $variantMedia) { product { id } } }",
 "variables": {
    "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"
      }
    ]
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation productVariantAppendMedia($productId: ID!, $variantMedia: [ProductVariantAppendMediaInput!]!) {
    productVariantAppendMedia(productId: $productId, variantMedia: $variantMedia) {
      product {
        id
      }
    }
  }`,
  {
    variables: {
      "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"
        }
      ]
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation productVariantAppendMedia($productId: ID!, $variantMedia: [ProductVariantAppendMediaInput!]!) {
      productVariantAppendMedia(productId: $productId, variantMedia: $variantMedia) {
        product {
          id
        }
      }
    }`,
    "variables": {
      "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"
        }
      ]
    },
  },
});

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 productVariantAppendMedia($productId: ID!, $variantMedia: [ProductVariantAppendMediaInput!]!) {
    productVariantAppendMedia(productId: $productId, variantMedia: $variantMedia) {
      product {
        id
      }
    }
  }
QUERY

variables = {
  "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 = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "productId": "gid://shopify/Product/1072481072",
3  "variantMedia": [
4    {
5      "mediaIds": [
6        "gid://shopify/MediaImage/1072273216"
7      ],
8      "variantId": "gid://shopify/ProductVariant/1070325119"
9    },
10    {
11      "mediaIds": [
12        "gid://shopify/MediaImage/1072273217"
13      ],
14      "variantId": "gid://shopify/ProductVariant/1070325120"
15    }
16  ]
17}

Response

JSON

1{
2  "productVariantAppendMedia": {
3    "product": {
4      "id": "gid://shopify/Product/1072481072"
5    }
6  }
7}