productOptionsDelete

mutation

Requires write_products access scope. Also: The user must have a permission to edit products and delete product variants.

Deletes the specified options.

Arguments

Anchor to optionsoptions • [ID!]!required: IDs of the options to delete from the product.
Anchor to productIdproductId • ID!required: ID of the product from which to delete the options.
Anchor to strategystrategy • ProductOptionDeleteStrategyDefault:DEFAULT: The strategy defines which behavior the mutation should observe,such as how to handle a situation where deleting an option would result in duplicate variants.

Was this section helpful?

Anchor to ProductOptionsDeletePayload returnsProductOptionsDeletePayload returns

Anchor to deletedOptionsIdsdeletedOptionsIds • [ID!]: IDs of the options deleted.
Anchor to productproduct • Product: The updated product object.
Anchor to userErrorsuserErrors • [ProductOptionsDeleteUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Delete an option
Delete an option with the POSITION delete strategy
Trying to delete an option with multiple option values linked to variants with no option delete strategy returns an error
productOptionsDelete reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) {
6    productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) {
7      userErrors {
8        field
9        message
10        code
11      }
12      deletedOptionsIds
13      product {
14        id
15        options {
16          id
17          name
18          values
19          position
20          optionValues {
21            id
22            name
23            hasVariants
24          }
25        }
26      }
27    }
28  }`,
29  {
30    variables: {
31      "productId": "gid://shopify/Product/20995642",
32      "options": [
33        "gid://shopify/ProductOption/1064576514"
34      ]
35    },
36  },
37);
38
39const data = await response.json();
40

mutation deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) {
  productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) {
    userErrors {
      field
      message
      code
    }
    deletedOptionsIds
    product {
      id
      options {
        id
        name
        values
        position
        optionValues {
          id
          name
          hasVariants
        }
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) { productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) { userErrors { field message code } deletedOptionsIds product { id options { id name values position optionValues { id name hasVariants } } } } }",
 "variables": {
    "productId": "gid://shopify/Product/20995642",
    "options": [
      "gid://shopify/ProductOption/1064576514"
    ]
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) {
    productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) {
      userErrors {
        field
        message
        code
      }
      deletedOptionsIds
      product {
        id
        options {
          id
          name
          values
          position
          optionValues {
            id
            name
            hasVariants
          }
        }
      }
    }
  }`,
  {
    variables: {
      "productId": "gid://shopify/Product/20995642",
      "options": [
        "gid://shopify/ProductOption/1064576514"
      ]
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) {
      productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) {
        userErrors {
          field
          message
          code
        }
        deletedOptionsIds
        product {
          id
          options {
            id
            name
            values
            position
            optionValues {
              id
              name
              hasVariants
            }
          }
        }
      }
    }`,
    "variables": {
      "productId": "gid://shopify/Product/20995642",
      "options": [
        "gid://shopify/ProductOption/1064576514"
      ]
    },
  },
});

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 deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) {
    productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) {
      userErrors {
        field
        message
        code
      }
      deletedOptionsIds
      product {
        id
        options {
          id
          name
          values
          position
          optionValues {
            id
            name
            hasVariants
          }
        }
      }
    }
  }
QUERY

variables = {
  "productId": "gid://shopify/Product/20995642",
  "options": ["gid://shopify/ProductOption/1064576514"]
}

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

Input variables

JSON

1{
2  "productId": "gid://shopify/Product/20995642",
3  "options": [
4    "gid://shopify/ProductOption/1064576514"
5  ]
6}

Response

JSON

1{
2  "productOptionsDelete": {
3    "userErrors": [],
4    "deletedOptionsIds": [
5      "gid://shopify/ProductOption/1064576514"
6    ],
7    "product": {
8      "id": "gid://shopify/Product/20995642",
9      "options": [
10        {
11          "id": "gid://shopify/ProductOption/328272167",
12          "name": "Title",
13          "values": [
14            "151cm",
15            "155cm",
16            "158cm"
17          ],
18          "position": 1,
19          "optionValues": [
20            {
21              "id": "gid://shopify/ProductOptionValue/141051426",
22              "name": "151cm",
23              "hasVariants": true
24            },
25            {
26              "id": "gid://shopify/ProductOptionValue/258076414",
27              "name": "155cm",
28              "hasVariants": true
29            },
30            {
31              "id": "gid://shopify/ProductOptionValue/129596849",
32              "name": "158cm",
33              "hasVariants": true
34            }
35          ]
36        }
37      ]
38    }
39  }
40}