quantityRulesDelete - admin-graphql - MUTATION

Version: 2024-07

Description:

Deletes specific quantity rules from a price list using a product variant ID. You can use the `quantityRulesDelete` mutation to delete a set of quantity rules from a price list.

Access Scopes

`write_products` access scope. Also: The user must have a permission to delete quantity rules from a price list.

Arguments

• priceListId: ID! - The ID of the price list from which the quantity rules will be deleted.
• variantIds: ID! - A list of product variant IDs whose quantity rules will be removed from the price list.

Returns

• deletedQuantityRulesVariantIds: ID A list of product variant IDs whose quantity rules were removed from the price list.
• userErrors: QuantityRuleUserError! The list of errors that occurred from executing the mutation.

Examples

• Delete multiple quantity rules from a price list

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation quantityRulesDelete($priceListId: ID!, $variantIds: [ID!]!) { quantityRulesDelete(priceListId: $priceListId, variantIds: $variantIds) { deletedQuantityRulesVariantIds userErrors { field code message } } }\",\n \"variables\": {\n    \"priceListId\": \"gid://shopify/PriceList/225060712\",\n    \"variantIds\": [\n      \"gid://shopify/ProductVariant/43729076\",\n      \"gid://shopify/ProductVariant/138327650\"\n    ]\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation quantityRulesDelete($priceListId: ID!, $variantIds: [ID!]!) {\n      quantityRulesDelete(priceListId: $priceListId, variantIds: $variantIds) {\n        deletedQuantityRulesVariantIds\n        userErrors {\n          field\n          code\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"priceListId\": \"gid://shopify/PriceList/225060712\",\n      \"variantIds\": [\n        \"gid://shopify/ProductVariant/43729076\",\n        \"gid://shopify/ProductVariant/138327650\"\n      ]\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation quantityRulesDelete($priceListId: ID!, $variantIds: [ID!]!) {\n    quantityRulesDelete(priceListId: $priceListId, variantIds: $variantIds) {\n      deletedQuantityRulesVariantIds\n      userErrors {\n        field\n        code\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"priceListId\": \"gid://shopify/PriceList/225060712\",\n  \"variantIds\": [\"gid://shopify/ProductVariant/43729076\", \"gid://shopify/ProductVariant/138327650\"]\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation quantityRulesDelete($priceListId: ID!, $variantIds: [ID!]!) {\n    quantityRulesDelete(priceListId: $priceListId, variantIds: $variantIds) {\n      deletedQuantityRulesVariantIds\n      userErrors {\n        field\n        code\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"priceListId\" => \"gid://shopify/PriceList/225060712\",\n  \"variantIds\" => [\"gid://shopify/ProductVariant/43729076\", \"gid://shopify/ProductVariant/138327650\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation quantityRulesDelete($priceListId: ID!, $variantIds: [ID!]!) {\n    quantityRulesDelete(priceListId: $priceListId, variantIds: $variantIds) {\n      deletedQuantityRulesVariantIds\n      userErrors {\n        field\n        code\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"priceListId\": \"gid://shopify/PriceList/225060712\",\n      \"variantIds\": [\n        \"gid://shopify/ProductVariant/43729076\",\n        \"gid://shopify/ProductVariant/138327650\"\n      ]\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation quantityRulesDelete($priceListId: ID!, $variantIds: [ID!]!) {\n  quantityRulesDelete(priceListId: $priceListId, variantIds: $variantIds) {\n    deletedQuantityRulesVariantIds\n    userErrors {\n      field\n      code\n      message\n    }\n  }\n}"
        

  input: {
    "priceListId": "gid://shopify/PriceList/225060712",
    "variantIds": [
      "gid://shopify/ProductVariant/43729076",
      "gid://shopify/ProductVariant/138327650"
    ]
  }

  response: {
    "data": {
      "quantityRulesDelete": {
        "deletedQuantityRulesVariantIds": [
          "gid://shopify/ProductVariant/43729076",
          "gid://shopify/ProductVariant/138327650"
        ],
        "userErrors": []
      }
    }
  }