productVariantDelete

mutationDeprecated

Requires write_products access scope. Also: The user must have a permission to delete a product variant.

Deletes a product variant. Use productVariantsBulkDelete instead.

Arguments

Anchor to idid • ID!required: The ID of the product variant to be deleted.

Was this section helpful?

Anchor to ProductVariantDeletePayload returnsProductVariantDeletePayload returns

Anchor to deletedProductVariantIddeletedProductVariantId • ID: The ID of the deleted product variant.
Anchor to productproduct • Product: The product associated with the deleted product variant.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Delete a product variant
Delete non-existing product variant
productVariantDelete reference

Examples

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

const response = await admin.graphql(

`#graphql

mutation productVariantDelete($id: ID!) {

productVariantDelete(id: $id) {

deletedProductVariantId

product {

title

}

userErrors {

field

message

}

}`,

{

variables: {

"id": "gid://shopify/ProductVariant/43729076"

);

const data = await response.json();

mutation productVariantDelete($id: ID!) {
  productVariantDelete(id: $id) {
    deletedProductVariantId
    product {
      id
      title
    }
    userErrors {
      field
      message
    }
  }
}

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 productVariantDelete($id: ID!) { productVariantDelete(id: $id) { deletedProductVariantId product { id title } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/ProductVariant/43729076"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation productVariantDelete($id: ID!) {
    productVariantDelete(id: $id) {
      deletedProductVariantId
      product {
        id
        title
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/ProductVariant/43729076"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation productVariantDelete($id: ID!) {
      productVariantDelete(id: $id) {
        deletedProductVariantId
        product {
          id
          title
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/ProductVariant/43729076"
    },
  },
});

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 productVariantDelete($id: ID!) {
    productVariantDelete(id: $id) {
      deletedProductVariantId
      product {
        id
        title
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/ProductVariant/43729076"
}

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

Input variables

JSON

{

"id": "gid://shopify/ProductVariant/43729076"

}

Response

JSON

{

"productVariantDelete": {

"deletedProductVariantId": "gid://shopify/ProductVariant/43729076",

"product": {

"id": "gid://shopify/Product/108828309",

"title": "Draft"

"userErrors": []

}