productUpdateMedia

mutationDeprecated

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

Updates media for a product. Use fileUpdate instead.

Arguments

Anchor to mediamedia • [UpdateMediaInput!]!required: A list of media updates.
Anchor to productIdproductId • ID!required: Specifies the product on which media will be updated.

Was this section helpful?

Anchor to ProductUpdateMediaPayload returnsProductUpdateMediaPayload returns

Anchor to mediamedia • [Media!]: The updated media object.
Anchor to mediaUserErrorsmediaUserErrors • [MediaUserError!]!non-null: The list of errors that occurred from executing the mutation.
Anchor to productproduct • Product: The product on which media was updated.
Anchor to userErrorsuserErrors • [UserError!]!non-nullDeprecated: The list of errors that occurred from executing the mutation.

Was this section helpful?

Modify an existing Product Image
Update a product's media fields
Update new media on a non-existent product
Update non-existent media on a non-existent product
Update non-existent media on a valid product
productUpdateMedia reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation ProductImageUpdate($id: ID!) {
6    productUpdateMedia(productId: $id, media: [{id: "gid://shopify/MediaImage/853695510", alt: "Updated alt text."}]) {
7      media {
8        id
9        alt
10        status
11        ... on MediaImage {
12          image {
13            url
14          }
15        }
16      }
17      mediaUserErrors {
18        field
19        message
20      }
21    }
22  }`,
23  {
24    variables: {
25      "id": "gid://shopify/Product/108828309"
26    },
27  },
28);
29
30const data = await response.json();
31

mutation ProductImageUpdate($id: ID!) {
  productUpdateMedia(productId: $id, media: [{id: "gid://shopify/MediaImage/853695510", alt: "Updated alt text."}]) {
    media {
      id
      alt
      status
      ... on MediaImage {
        image {
          url
        }
      }
    }
    mediaUserErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation ProductImageUpdate($id: ID!) { productUpdateMedia(productId: $id, media: [{id: \"gid://shopify/MediaImage/853695510\", alt: \"Updated alt text.\"}]) { media { id alt status ... on MediaImage { image { url } } } mediaUserErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/Product/108828309"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation ProductImageUpdate($id: ID!) {
    productUpdateMedia(productId: $id, media: [{id: "gid://shopify/MediaImage/853695510", alt: "Updated alt text."}]) {
      media {
        id
        alt
        status
        ... on MediaImage {
          image {
            url
          }
        }
      }
      mediaUserErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/Product/108828309"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation ProductImageUpdate($id: ID!) {
      productUpdateMedia(productId: $id, media: [{id: "gid://shopify/MediaImage/853695510", alt: "Updated alt text."}]) {
        media {
          id
          alt
          status
          ... on MediaImage {
            image {
              url
            }
          }
        }
        mediaUserErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/Product/108828309"
    },
  },
});

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 ProductImageUpdate($id: ID!) {
    productUpdateMedia(productId: $id, media: [{id: "gid://shopify/MediaImage/853695510", alt: "Updated alt text."}]) {
      media {
        id
        alt
        status
        ... on MediaImage {
          image {
            url
          }
        }
      }
      mediaUserErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Product/108828309"
}

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

Input variables

JSON

1{
2  "id": "gid://shopify/Product/108828309"
3}

Response

JSON

1{
2  "productUpdateMedia": {
3    "media": [
4      {
5        "id": "gid://shopify/MediaImage/853695510",
6        "alt": "Updated alt text.",
7        "status": "READY",
8        "image": {
9          "url": "https://cdn.shopify.com/s/files/1/2637/1970/products/draft58.jpg?v=1730761095"
10        }
11      }
12    ],
13    "mediaUserErrors": []
14  }
15}