Anchor to section titled 'undefined'

metaobjectBulkDelete
mutation

Requires write_metaobjects access scope.

Asynchronously delete metaobjects and their associated metafields in bulk.


Specifies the condition by which metaobjects are deleted. Exactly one field of input is required.


Was this section helpful?

The asynchronous job that deletes the metaobjects.

The list of errors that occurred from executing the mutation.


Was this section helpful?

Examples

Hide code
DescriptionCopy
mutation DeleteMetaobjects($where: MetaobjectBulkDeleteWhereCondition!) {
  metaobjectBulkDelete(where: $where) {
    job {
      id
      done
    }
  }
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation DeleteMetaobjects($where: MetaobjectBulkDeleteWhereCondition!) { metaobjectBulkDelete(where: $where) { job { id done } } }",
 "variables": {
    "where": {
      "ids": [
        "gid://shopify/Metaobject/515107504",
        "gid://shopify/Metaobject/129678104"
      ]
    }
  }
}'
const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation DeleteMetaobjects($where: MetaobjectBulkDeleteWhereCondition!) {
    metaobjectBulkDelete(where: $where) {
      job {
        id
        done
      }
    }
  }`,
  {
    variables: {
      "where": {
        "ids": [
          "gid://shopify/Metaobject/515107504",
          "gid://shopify/Metaobject/129678104"
        ]
      }
    },
  },
);

const data = await response.json();
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 DeleteMetaobjects($where: MetaobjectBulkDeleteWhereCondition!) {
    metaobjectBulkDelete(where: $where) {
      job {
        id
        done
      }
    }
  }
QUERY

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

response = client.query(query: query, variables: variables)
const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation DeleteMetaobjects($where: MetaobjectBulkDeleteWhereCondition!) {
      metaobjectBulkDelete(where: $where) {
        job {
          id
          done
        }
      }
    }`,
    "variables": {
      "where": {
        "ids": [
          "gid://shopify/Metaobject/515107504",
          "gid://shopify/Metaobject/129678104"
        ]
      }
    },
  },
});
use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$query = <<<QUERY
  mutation DeleteMetaobjects($where: MetaobjectBulkDeleteWhereCondition!) {
    metaobjectBulkDelete(where: $where) {
      job {
        id
        done
      }
    }
  }
QUERY;

$variables = [
  "where" => [
    "ids" => ["gid://shopify/Metaobject/515107504", "gid://shopify/Metaobject/129678104"],
  ],
];

$response = $client->query(["query" => $query, "variables" => $variables]);
Hide code
Input variables
Copy
{
  "where": {
    "ids": [
      "gid://shopify/Metaobject/515107504",
      "gid://shopify/Metaobject/129678104"
    ]
  }
}
Hide code
Response
JSON
{
  "metaobjectBulkDelete": {
    "job": {
      "id": "gid://shopify/Job/4d5319b7-71de-482e-b3c5-d11321c9ffca",
      "done": false
    }
  }
}