productDeleteMedia mutation

Deletes media for a product.

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 productDeleteMedia($productId: ID!, $mediaIds: [ID!]!) { productDeleteMedia(productId: $productId, mediaIds: $mediaIds) { 
  1. <font style="color:#1F61A0;">deletedMediaIds</font>
  3. <font style="color:#1F61A0;">deletedProductImageIds</font>
  5. <font style="color:#1F61A0;">mediaUserErrors</font> <font style="color:#555555;">{</font>
  7.   <font style="color:#1F61A0;">code</font>
  9.   <font style="color:#1F61A0;">field</font>
  11.   <font style="color:#1F61A0;">message</font>
  13. <font style="color:#555555;">}</font>
  15. <font style="color:#1F61A0;">product</font> <font style="color:#555555;">{</font>
  17.   <font style="color:#1F61A0;">id</font>
  19. <font style="color:#555555;">}</font>
} } { “productId”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “mediaIds”: [ 
  1. <font style="color:#D64292;">"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="</font>
] }

Arguments

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

) REQUIRED		 The media IDs to be deleted.
productId
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 The ID of the product on which to delete media.

Return fields

  • deletedMediaIds ([[ID!]](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    List of media IDs which were deleted.
  • deletedProductImageIds ([[ID!]](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    List of product image IDs which were deleted.
  • mediaUserErrors ([[MediaUserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/mediausererror))
    List of errors that occurred executing the mutation.
  • product ([Product](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/product))
    The product which media was deleted from.

Deprecated return fields

userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror)) DEPRECATED
List of errors that occurred executing the mutation.
Deprecation warning
Use mediaUserErrors instead