priceListFixedPricesDelete
mutation

Choose a version:

Requires write_products access scope. Also: The shop has the international_price_overrides or Markets or B2B features enabled.

Deletes specific fixed prices from a price list using a product variant ID. You can use the priceListFixedPricesDelete mutation to delete a set of fixed prices from a price list. After deleting the set of fixed prices from the price list, the price of each product variant reverts to the original price that was determined by the price list adjustment.

Anchor to section titled 'Arguments'

Arguments

Anchor to priceListId priceListId ID! required: The ID of the price list from which the fixed prices will be removed.
Anchor to variantIds variantIds [ID!]! required: A list of product variant IDs whose fixed prices will be removed from the price list.

Was this section helpful?

Anchor to section titled 'PriceListFixedPricesDeletePayload returns'

PriceListFixedPricesDeletePayload returns

Anchor to PriceListFixedPricesDeletePayload.deletedFixedPriceVariantIds deletedFixedPriceVariantIds [ID!]: A list of product variant IDs whose fixed prices were removed from the price list.
Anchor to PriceListFixedPricesDeletePayload.userErrors userErrors [PriceListPriceUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: priceListFixedPricesDelete

Query Reference for MUTATION: priceListFixedPricesDelete

"mutation priceListFixedPricesDelete($priceListId: ID!, $variantIds: [ID!]!) {\n  priceListFixedPricesDelete(priceListId: $priceListId, variantIds: $variantIds) {\n    deletedFixedPriceVariantIds\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: priceListFixedPricesDelete

"{\n  \"priceListId\": \"gid://shopify/<objectName>/10079785100\",\n  \"variantIds\": [\n    \"gid://shopify/<objectName>/10079785100\"\n  ]\n}"

Schema Reference for MUTATION: priceListFixedPricesDelete

""

Display Examples for MUTATION: priceListFixedPricesDelete

[
  {
    "example": {
      "type_name": "pricelistfixedpricesdelete",
      "title": "Delete multiple fixed prices from a price list",
      "description": "Delete fixed prices for two product variants.",
      "query_string": "mutation priceListFixedPricesDelete($priceListId: ID!, $variantIds: [ID!]!) {\n  priceListFixedPricesDelete(priceListId: $priceListId, variantIds: $variantIds) {\n    deletedFixedPriceVariantIds\n    userErrors {\n      field\n      code\n      message\n    }\n  }\n}",
      "variables": {
        "priceListId": "gid://shopify/PriceList/294167858",
        "variantIds": [
          "gid://shopify/ProductVariant/498744621",
          "gid://shopify/ProductVariant/113711323"
        ]
      },
      "response": {
        "data": {
          "priceListFixedPricesDelete": {
            "deletedFixedPriceVariantIds": [
              "gid://shopify/ProductVariant/113711323",
              "gid://shopify/ProductVariant/498744621"
            ],
            "userErrors": []
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/merchandising/test/unit/merchandising/graph_api/admin/mutations/price_list_fixed_prices_delete_test.rb",
      "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 priceListFixedPricesDelete($priceListId: ID!, $variantIds: [ID!]!) { priceListFixedPricesDelete(priceListId: $priceListId, variantIds: $variantIds) { deletedFixedPriceVariantIds userErrors { field code message } } }\",\n \"variables\": {\n    \"priceListId\": \"gid://shopify/PriceList/294167858\",\n    \"variantIds\": [\n      \"gid://shopify/ProductVariant/498744621\",\n      \"gid://shopify/ProductVariant/113711323\"\n    ]\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation priceListFixedPricesDelete($priceListId: ID!, $variantIds: [ID!]!) {\n    priceListFixedPricesDelete(priceListId: $priceListId, variantIds: $variantIds) {\n      deletedFixedPriceVariantIds\n      userErrors {\n        field\n        code\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"priceListId\": \"gid://shopify/PriceList/294167858\",\n      \"variantIds\": [\n        \"gid://shopify/ProductVariant/498744621\",\n        \"gid://shopify/ProductVariant/113711323\"\n      ]\n    },\n  },\n);\n\nconst data = await response.json();\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 priceListFixedPricesDelete($priceListId: ID!, $variantIds: [ID!]!) {\n    priceListFixedPricesDelete(priceListId: $priceListId, variantIds: $variantIds) {\n      deletedFixedPriceVariantIds\n      userErrors {\n        field\n        code\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"priceListId\": \"gid://shopify/PriceList/294167858\",\n  \"variantIds\": [\"gid://shopify/ProductVariant/498744621\", \"gid://shopify/ProductVariant/113711323\"]\n}\n\nresponse = client.query(query: query, variables: variables)\n",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation priceListFixedPricesDelete($priceListId: ID!, $variantIds: [ID!]!) {\n      priceListFixedPricesDelete(priceListId: $priceListId, variantIds: $variantIds) {\n        deletedFixedPriceVariantIds\n        userErrors {\n          field\n          code\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"priceListId\": \"gid://shopify/PriceList/294167858\",\n      \"variantIds\": [\n        \"gid://shopify/ProductVariant/498744621\",\n        \"gid://shopify/ProductVariant/113711323\"\n      ]\n    },\n  },\n});\n",
      "php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation priceListFixedPricesDelete($priceListId: ID!, $variantIds: [ID!]!) {\n    priceListFixedPricesDelete(priceListId: $priceListId, variantIds: $variantIds) {\n      deletedFixedPriceVariantIds\n      userErrors {\n        field\n        code\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"priceListId\" => \"gid://shopify/PriceList/294167858\",\n  \"variantIds\" => [\"gid://shopify/ProductVariant/498744621\", \"gid://shopify/ProductVariant/113711323\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "priceListId",
          "description": "The ID of the price list from which the fixed prices will be removed.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "priceListId",
        "argValue": " \"gid://shopify/PriceList/294167858\"",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "variantIds",
          "description": "A list of product variant IDs whose fixed prices will be removed from the price list.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": true,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "[ID!]!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "variantIds",
        "argValue": " [\"gid://shopify/ProductVariant/498744621\",\"gid://shopify/ProductVariant/113711323\"]",
        "typeKind": "MUTATION"
      }
    ]
  }
]

priceListFixedPricesDeletemutation

Arguments

PriceListFixedPricesDeletePayload returns

priceListFixedPricesDelete
mutation