metafieldsDelete - admin-graphql - MUTATION

Version: 2024-07

Description:

Deletes multiple metafields in bulk.

Access Scopes

access defined by each metafield input `ownerId` scalar's type in a `MetafieldsSetInput` field. For example, setting a metafield on a `PRODUCT` requires the same access as mutating a `PRODUCT`.

Arguments

• metafields: MetafieldIdentifierInput! - A list of identifiers specifying metafields to delete. At least one identifier must be specified.

Returns

• deletedMetafields: MetafieldIdentifier List of metafield identifiers that were deleted, null if the corresponding metafield isn't found.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Deletes a metafield by its ID

          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 MetafieldsDelete($metafields: [MetafieldIdentifierInput!]!) { metafieldsDelete(metafields: $metafields) { deletedMetafields { key namespace ownerId } userErrors { field message } } }\",\n \"variables\": {\n    \"metafields\": [\n      {\n        \"ownerId\": \"gid://shopify/Product/20995642\",\n        \"namespace\": \"inventory\",\n        \"key\": \"today\"\n      }\n    ]\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation MetafieldsDelete($metafields: [MetafieldIdentifierInput!]!) {\n      metafieldsDelete(metafields: $metafields) {\n        deletedMetafields {\n          key\n          namespace\n          ownerId\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"metafields\": [\n        {\n          \"ownerId\": \"gid://shopify/Product/20995642\",\n          \"namespace\": \"inventory\",\n          \"key\": \"today\"\n        }\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 MetafieldsDelete($metafields: [MetafieldIdentifierInput!]!) {\n    metafieldsDelete(metafields: $metafields) {\n      deletedMetafields {\n        key\n        namespace\n        ownerId\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"metafields\": [{\"ownerId\"=>\"gid://shopify/Product/20995642\", \"namespace\"=>\"inventory\", \"key\"=>\"today\"}]\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 MetafieldsDelete($metafields: [MetafieldIdentifierInput!]!) {\n    metafieldsDelete(metafields: $metafields) {\n      deletedMetafields {\n        key\n        namespace\n        ownerId\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"metafields\" => [{\"ownerId\"=>\"gid://shopify/Product/20995642\", \"namespace\"=>\"inventory\", \"key\"=>\"today\"}],\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 MetafieldsDelete($metafields: [MetafieldIdentifierInput!]!) {\n    metafieldsDelete(metafields: $metafields) {\n      deletedMetafields {\n        key\n        namespace\n        ownerId\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"metafields\": [\n        {\n          \"ownerId\": \"gid://shopify/Product/20995642\",\n          \"namespace\": \"inventory\",\n          \"key\": \"today\"\n        }\n      ]\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation MetafieldsDelete($metafields: [MetafieldIdentifierInput!]!) {\n  metafieldsDelete(metafields: $metafields) {\n    deletedMetafields {\n      key\n      namespace\n      ownerId\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "metafields": [
      {
        "ownerId": "gid://shopify/Product/20995642",
        "namespace": "inventory",
        "key": "today"
      }
    ]
  }

  response: {
    "data": {
      "metafieldsDelete": {
        "deletedMetafields": [
          {
            "key": "today",
            "namespace": "inventory",
            "ownerId": "gid://shopify/Product/20995642"
          }
        ],
        "userErrors": []
      }
    }
  }