metaobjectBulkDelete - admin-graphql - MUTATION

Version: 2024-01

Description:

Asynchronously delete metaobjects and their associated metafields in bulk.

Access Scopes

`write_metaobjects` access scope.

Arguments

• where: MetaobjectBulkDeleteWhereCondition! - Specifies the condition by which metaobjects are deleted. Exactly one field of input is required.

Returns

• job: Job The asynchronous job that deletes the metaobjects.
• userErrors: MetaobjectUserError! The list of errors that occurred from executing the mutation.

Examples

• Delete metaobjects and their associated fields in bulk by IDs

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation DeleteMetaobjects($where: MetaobjectBulkDeleteWhereCondition!) { metaobjectBulkDelete(where: $where) { job { id done } } }\",\n \"variables\": {\n    \"where\": {\n      \"ids\": [\n        \"gid://shopify/Metaobject/515107504\",\n        \"gid://shopify/Metaobject/129678104\"\n      ]\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation DeleteMetaobjects($where: MetaobjectBulkDeleteWhereCondition!) {\n      metaobjectBulkDelete(where: $where) {\n        job {\n          id\n          done\n        }\n      }\n    }`,\n    \"variables\": {\n      \"where\": {\n        \"ids\": [\n          \"gid://shopify/Metaobject/515107504\",\n          \"gid://shopify/Metaobject/129678104\"\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 DeleteMetaobjects($where: MetaobjectBulkDeleteWhereCondition!) {\n    metaobjectBulkDelete(where: $where) {\n      job {\n        id\n        done\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"where\": {\n    \"ids\": [\"gid://shopify/Metaobject/515107504\", \"gid://shopify/Metaobject/129678104\"]\n  }\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 DeleteMetaobjects($where: MetaobjectBulkDeleteWhereCondition!) {\n    metaobjectBulkDelete(where: $where) {\n      job {\n        id\n        done\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"where\" => [\n    \"ids\" => [\"gid://shopify/Metaobject/515107504\", \"gid://shopify/Metaobject/129678104\"],\n  ],\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 DeleteMetaobjects($where: MetaobjectBulkDeleteWhereCondition!) {\n    metaobjectBulkDelete(where: $where) {\n      job {\n        id\n        done\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"where\": {\n        \"ids\": [\n          \"gid://shopify/Metaobject/515107504\",\n          \"gid://shopify/Metaobject/129678104\"\n        ]\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation DeleteMetaobjects($where: MetaobjectBulkDeleteWhereCondition!) {\n  metaobjectBulkDelete(where: $where) {\n    job {\n      id\n      done\n    }\n  }\n}"
        

  input: {
    "where": {
      "ids": [
        "gid://shopify/Metaobject/515107504",
        "gid://shopify/Metaobject/129678104"
      ]
    }
  }

  response: {
    "data": {
      "metaobjectBulkDelete": {
        "job": {
          "id": "gid://shopify/Job/4d5319b7-71de-482e-b3c5-d11321c9ffca",
          "done": false
        }
      }
    }
  }

  Delete metaobjects and their associated fields in bulk by type

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation DeleteMetaobjects($where: MetaobjectBulkDeleteWhereCondition!) { metaobjectBulkDelete(where: $where) { job { id done } } }\",\n \"variables\": {\n    \"where\": {\n      \"type\": \"lookbook\"\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation DeleteMetaobjects($where: MetaobjectBulkDeleteWhereCondition!) {\n      metaobjectBulkDelete(where: $where) {\n        job {\n          id\n          done\n        }\n      }\n    }`,\n    \"variables\": {\n      \"where\": {\n        \"type\": \"lookbook\"\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 DeleteMetaobjects($where: MetaobjectBulkDeleteWhereCondition!) {\n    metaobjectBulkDelete(where: $where) {\n      job {\n        id\n        done\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"where\": {\n    \"type\": \"lookbook\"\n  }\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 DeleteMetaobjects($where: MetaobjectBulkDeleteWhereCondition!) {\n    metaobjectBulkDelete(where: $where) {\n      job {\n        id\n        done\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"where\" => [\n    \"type\" => \"lookbook\",\n  ],\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 DeleteMetaobjects($where: MetaobjectBulkDeleteWhereCondition!) {\n    metaobjectBulkDelete(where: $where) {\n      job {\n        id\n        done\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"where\": {\n        \"type\": \"lookbook\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation DeleteMetaobjects($where: MetaobjectBulkDeleteWhereCondition!) {\n  metaobjectBulkDelete(where: $where) {\n    job {\n      id\n      done\n    }\n  }\n}"
        

  input: {
    "where": {
      "type": "lookbook"
    }
  }

  response: {
    "data": {
      "metaobjectBulkDelete": {
        "job": {
          "id": "gid://shopify/Job/e439ccf6-01c1-49df-9411-985def30b4f8",
          "done": false
        }
      }
    }
  }