Choose a version:

productVariantDetachMedia

mutation

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

Detaches media from product variants.

Anchor to Arguments

Arguments

Anchor to productIdproductId

•ID!

required

Specifies the product to which the variants and media are associated.

Anchor to variantMediavariantMedia

•[ProductVariantDetachMediaInput!]!

required

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

Show input fields

Was this section helpful?

Anchor to ProductVariantDetachMediaPayload returnsProductVariantDetachMediaPayload returns

Anchor to productproduct •Product: The product associated with the variants and media.

Show fields
Anchor to productVariantsproductVariants •[ProductVariant!]: The product variants that were updated.

Show fields
Anchor to userErrorsuserErrors •[MediaUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

Detach a product variant's media from a product

Description

Detach media of a product from the product's variants

Query

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

Variables

{
  "productId": "gid://shopify/Product/1072481079",
  "variantMedia": [
    {
      "mediaIds": [
        "gid://shopify/MediaImage/1072273220"
      ],
      "variantId": "gid://shopify/ProductVariant/1070325128"
    },
    {
      "mediaIds": [
        "gid://shopify/MediaImage/1072273221"
      ],
      "variantId": "gid://shopify/ProductVariant/1070325129"
    }
  ]
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation productVariantDetachMedia($productId: ID!, $variantMedia: [ProductVariantDetachMediaInput!]!) { productVariantDetachMedia(productId: $productId, variantMedia: $variantMedia) { product { id } } }",
 "variables": {
    "productId": "gid://shopify/Product/1072481079",
    "variantMedia": [
      {
        "mediaIds": [
          "gid://shopify/MediaImage/1072273220"
        ],
        "variantId": "gid://shopify/ProductVariant/1070325128"
      },
      {
        "mediaIds": [
          "gid://shopify/MediaImage/1072273221"
        ],
        "variantId": "gid://shopify/ProductVariant/1070325129"
      }
    ]
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation productVariantDetachMedia($productId: ID!, $variantMedia: [ProductVariantDetachMediaInput!]!) {
    productVariantDetachMedia(productId: $productId, variantMedia: $variantMedia) {
      product {
        id
      }
    }
  }`,
  {
    variables: {
        "productId": "gid://shopify/Product/1072481079",
        "variantMedia": [
            {
                "mediaIds": [
                    "gid://shopify/MediaImage/1072273220"
                ],
                "variantId": "gid://shopify/ProductVariant/1070325128"
            },
            {
                "mediaIds": [
                    "gid://shopify/MediaImage/1072273221"
                ],
                "variantId": "gid://shopify/ProductVariant/1070325129"
            }
        ]
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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

variables = {
  "productId": "gid://shopify/Product/1072481079",
  "variantMedia": [
    {
      "mediaIds": [
        "gid://shopify/MediaImage/1072273220"
      ],
      "variantId": "gid://shopify/ProductVariant/1070325128"
    },
    {
      "mediaIds": [
        "gid://shopify/MediaImage/1072273221"
      ],
      "variantId": "gid://shopify/ProductVariant/1070325129"
    }
  ]
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation productVariantDetachMedia($productId: ID!, $variantMedia: [ProductVariantDetachMediaInput!]!) {
      productVariantDetachMedia(productId: $productId, variantMedia: $variantMedia) {
        product {
          id
        }
      }
    }`,
    "variables": {
        "productId": "gid://shopify/Product/1072481079",
        "variantMedia": [
            {
                "mediaIds": [
                    "gid://shopify/MediaImage/1072273220"
                ],
                "variantId": "gid://shopify/ProductVariant/1070325128"
            },
            {
                "mediaIds": [
                    "gid://shopify/MediaImage/1072273221"
                ],
                "variantId": "gid://shopify/ProductVariant/1070325129"
            }
        ]
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation productVariantDetachMedia($productId: ID!, $variantMedia: [ProductVariantDetachMediaInput!]!) {
  productVariantDetachMedia(productId: $productId, variantMedia: $variantMedia) {
    product {
      id
    }
  }
}' \
--variables \
'{
  "productId": "gid://shopify/Product/1072481079",
  "variantMedia": [
    {
      "mediaIds": [
        "gid://shopify/MediaImage/1072273220"
      ],
      "variantId": "gid://shopify/ProductVariant/1070325128"
    },
    {
      "mediaIds": [
        "gid://shopify/MediaImage/1072273221"
      ],
      "variantId": "gid://shopify/ProductVariant/1070325129"
    }
  ]
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation productVariantDetachMedia($productId: ID!, $variantMedia: [ProductVariantDetachMediaInput!]!) {
        productVariantDetachMedia(productId: $productId, variantMedia: $variantMedia) {
          product {
            id
          }
        }
      }
    `,
    variables: {
        "productId": "gid://shopify/Product/1072481079",
        "variantMedia": [
            {
                "mediaIds": [
                    "gid://shopify/MediaImage/1072273220"
                ],
                "variantId": "gid://shopify/ProductVariant/1070325128"
            },
            {
                "mediaIds": [
                    "gid://shopify/MediaImage/1072273221"
                ],
                "variantId": "gid://shopify/ProductVariant/1070325129"
            }
        ]
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "productVariantDetachMedia": {
    "product": {
      "id": "gid://shopify/Product/1072481079"
    }
  }
}

productVariantDetachMedia reference

Examples

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

mutation productVariantDetachMedia($productId: ID!, $variantMedia: [ProductVariantDetachMediaInput!]!) {

productVariantDetachMedia(productId: $productId, variantMedia: $variantMedia) {

product {

}

}`,

{

variables: {

"productId": "gid://shopify/Product/1072481079",

"variantMedia": [

{

"mediaIds": [

"gid://shopify/MediaImage/1072273220"

"variantId": "gid://shopify/ProductVariant/1070325128"

{

"mediaIds": [

"gid://shopify/MediaImage/1072273221"

"variantId": "gid://shopify/ProductVariant/1070325129"

}

]

);

const json = await response.json();

return json.data;

}

GQL

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

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation productVariantDetachMedia($productId: ID!, $variantMedia: [ProductVariantDetachMediaInput!]!) { productVariantDetachMedia(productId: $productId, variantMedia: $variantMedia) { product { id } } }",
 "variables": {
    "productId": "gid://shopify/Product/1072481079",
    "variantMedia": [
      {
        "mediaIds": [
          "gid://shopify/MediaImage/1072273220"
        ],
        "variantId": "gid://shopify/ProductVariant/1070325128"
      },
      {
        "mediaIds": [
          "gid://shopify/MediaImage/1072273221"
        ],
        "variantId": "gid://shopify/ProductVariant/1070325129"
      }
    ]
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation productVariantDetachMedia($productId: ID!, $variantMedia: [ProductVariantDetachMediaInput!]!) {
    productVariantDetachMedia(productId: $productId, variantMedia: $variantMedia) {
      product {
        id
      }
    }
  }`,
  {
    variables: {
        "productId": "gid://shopify/Product/1072481079",
        "variantMedia": [
            {
                "mediaIds": [
                    "gid://shopify/MediaImage/1072273220"
                ],
                "variantId": "gid://shopify/ProductVariant/1070325128"
            },
            {
                "mediaIds": [
                    "gid://shopify/MediaImage/1072273221"
                ],
                "variantId": "gid://shopify/ProductVariant/1070325129"
            }
        ]
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation productVariantDetachMedia($productId: ID!, $variantMedia: [ProductVariantDetachMediaInput!]!) {
      productVariantDetachMedia(productId: $productId, variantMedia: $variantMedia) {
        product {
          id
        }
      }
    }`,
    "variables": {
        "productId": "gid://shopify/Product/1072481079",
        "variantMedia": [
            {
                "mediaIds": [
                    "gid://shopify/MediaImage/1072273220"
                ],
                "variantId": "gid://shopify/ProductVariant/1070325128"
            },
            {
                "mediaIds": [
                    "gid://shopify/MediaImage/1072273221"
                ],
                "variantId": "gid://shopify/ProductVariant/1070325129"
            }
        ]
    },
  },
});

Ruby

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

variables = {
  "productId": "gid://shopify/Product/1072481079",
  "variantMedia": [
    {
      "mediaIds": [
        "gid://shopify/MediaImage/1072273220"
      ],
      "variantId": "gid://shopify/ProductVariant/1070325128"
    },
    {
      "mediaIds": [
        "gid://shopify/MediaImage/1072273221"
      ],
      "variantId": "gid://shopify/ProductVariant/1070325129"
    }
  ]
}

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

Shopify CLI

shopify app execute \
--query \
'mutation productVariantDetachMedia($productId: ID!, $variantMedia: [ProductVariantDetachMediaInput!]!) {
  productVariantDetachMedia(productId: $productId, variantMedia: $variantMedia) {
    product {
      id
    }
  }
}' \
--variables \
'{
  "productId": "gid://shopify/Product/1072481079",
  "variantMedia": [
    {
      "mediaIds": [
        "gid://shopify/MediaImage/1072273220"
      ],
      "variantId": "gid://shopify/ProductVariant/1070325128"
    },
    {
      "mediaIds": [
        "gid://shopify/MediaImage/1072273221"
      ],
      "variantId": "gid://shopify/ProductVariant/1070325129"
    }
  ]
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation productVariantDetachMedia($productId: ID!, $variantMedia: [ProductVariantDetachMediaInput!]!) {
        productVariantDetachMedia(productId: $productId, variantMedia: $variantMedia) {
          product {
            id
          }
        }
      }
    `,
    variables: {
        "productId": "gid://shopify/Product/1072481079",
        "variantMedia": [
            {
                "mediaIds": [
                    "gid://shopify/MediaImage/1072273220"
                ],
                "variantId": "gid://shopify/ProductVariant/1070325128"
            },
            {
                "mediaIds": [
                    "gid://shopify/MediaImage/1072273221"
                ],
                "variantId": "gid://shopify/ProductVariant/1070325129"
            }
        ]
    },
  }),
});

const { data } = await response.json();
console.log(data);

Input variables

JSON

{

"productId": "gid://shopify/Product/1072481079",

"variantMedia": [

{

"mediaIds": [

"gid://shopify/MediaImage/1072273220"

"variantId": "gid://shopify/ProductVariant/1070325128"

{

"mediaIds": [

"gid://shopify/MediaImage/1072273221"

"variantId": "gid://shopify/ProductVariant/1070325129"

}

]

}

Response

JSON

{

"productVariantDetachMedia": {

"product": {

"id": "gid://shopify/Product/1072481079"

}