metaobjectDefinitionDelete

mutation

Requires write_metaobject_definitions access scope.

Deletes the specified metaobject definition. Also deletes all related metafield definitions, metaobjects, and metafields asynchronously.

Arguments

Anchor to idid • ID!required: The ID of the metaobjects definition to delete.

Was this section helpful?

Anchor to MetaobjectDefinitionDeletePayload returnsMetaobjectDefinitionDeletePayload returns

Anchor to deletedIddeletedId • ID: The ID of the deleted metaobjects definition.
Anchor to userErrorsuserErrors • [MetaobjectUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Delete a metaobject definition
metaobjectDefinitionDelete reference

Examples

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation DeleteMetaobjectDefinition($id: ID!) {

metaobjectDefinitionDelete(id: $id) {

deletedId

userErrors {

field

message

code

}

}`,

{

variables: {

"id": "gid://shopify/MetaobjectDefinition/578408816"

);

const data = await response.json();

mutation DeleteMetaobjectDefinition($id: ID!) {
  metaobjectDefinitionDelete(id: $id) {
    deletedId
    userErrors {
      field
      message
      code
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation DeleteMetaobjectDefinition($id: ID!) { metaobjectDefinitionDelete(id: $id) { deletedId userErrors { field message code } } }",
 "variables": {
    "id": "gid://shopify/MetaobjectDefinition/578408816"
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation DeleteMetaobjectDefinition($id: ID!) {
    metaobjectDefinitionDelete(id: $id) {
      deletedId
      userErrors {
        field
        message
        code
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/MetaobjectDefinition/578408816"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation DeleteMetaobjectDefinition($id: ID!) {
      metaobjectDefinitionDelete(id: $id) {
        deletedId
        userErrors {
          field
          message
          code
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/MetaobjectDefinition/578408816"
    },
  },
});

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 DeleteMetaobjectDefinition($id: ID!) {
    metaobjectDefinitionDelete(id: $id) {
      deletedId
      userErrors {
        field
        message
        code
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/MetaobjectDefinition/578408816"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"id": "gid://shopify/MetaobjectDefinition/578408816"

}

Response

JSON

{

"metaobjectDefinitionDelete": {

"deletedId": "gid://shopify/MetaobjectDefinition/578408816",

"userErrors": []

}