productVariantDetachMedia mutation

Deletes media from product variants.

Required access

write_products access scope.

On this page

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.

mutation productVariantDetachMedia($productId: ID!, $variantMedia: [ProductVariantDetachMediaInput!]!) { productVariantDetachMedia(productId: $productId, variantMedia: $variantMedia) { 
  1. <font style="color:#1F61A0;">product</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">productVariants</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">id</font>
  11. <font style="color:#555555;">}</font>
  13. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  15.   <font style="color:#1F61A0;">code</font>
  17.   <font style="color:#1F61A0;">field</font>
  19.   <font style="color:#1F61A0;">message</font>
  21. <font style="color:#555555;">}</font>
} } { “productId”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “variantMedia”: [ 
  1. <font style="color:#555555;">{</font>
  3.   <font style="color:#8B2BB9;">"variantId"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="</font><font style="color:#555555;">,</font>
  5.   <font style="color:#8B2BB9;">"mediaIds"</font><font style="color:#555555;">:</font> <font style="color:#555555;">[</font>
  7.     <font style="color:#D64292;">"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="</font>
  9.   <font style="color:#555555;">]</font>
  11. <font style="color:#555555;">}</font>
] }

Arguments

Argument Description
productId
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 Specifies the product to which the variants and media are associated.
variantMedia
(
[[ProductVariantDetachMediaInput!]!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productvariantdetachmediainput)

) REQUIRED		 A list of pairs of variants and media to be deleted from the variants.

ProductVariantDetachMediaInput fields

  • mediaIds ([[ID!]!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)) REQUIRED
    Specifies the media to detach from the variant.
  • variantId ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)) REQUIRED
    Specifies the variant from which media will be detached.

Return fields

  • product ([Product](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/product))
    The product associated with the variants and media.
  • productVariants ([[ProductVariant!]](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productvariant))
    The product variants that were updated.
  • userErrors ([[MediaUserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/mediausererror))
    List of errors that occurred executing the mutation.