Choose a version:

collectionDelete

mutation

Requires write_products access scope. Also: The store must not be on the Starter or Retail plans and user must have a permission to delete collection.

Deletes a collection and removes it permanently from the store. This operation cannot be undone and will remove the collection from all sales channels where it was published.

For example, when merchants discontinue seasonal promotions or reorganize their catalog structure, they can delete outdated collections like "Back to School 2023" to keep their store organized.

Use CollectionDelete to:

Remove outdated or unused collections from stores
Clean up collection structures during catalog reorganization
Implement collection management tools with deletion capabilities

Products within the deleted collection remain in the store but are no longer grouped under that collection.

Learn more about collection management.

Anchor to Arguments

Arguments

Anchor to inputinput •CollectionDeleteInput! required: The collection to delete.

Was this section helpful?

Anchor to CollectionDeletePayload returnsCollectionDeletePayload returns

Anchor to deletedCollectionIddeletedCollectionId •ID: The ID of the collection that was deleted. Returns null if the collection doesn't exist.
Anchor to shopshop •Shop! non-null: The shop associated with the collection.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Delete a collection

Description

Deletes the collection with the specified ID.

Query

mutation collectionDelete($input: CollectionDeleteInput!) {
  collectionDelete(input: $input) {
    deletedCollectionId
    shop {
      id
      name
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "input": {
    "id": "gid://shopify/Collection/1009501285"
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation collectionDelete($input: CollectionDeleteInput!) { collectionDelete(input: $input) { deletedCollectionId shop { id name } userErrors { field message } } }",
 "variables": {
    "input": {
      "id": "gid://shopify/Collection/1009501285"
    }
  }
}'

Remix

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

const response = await admin.graphql(
  `#graphql
  mutation collectionDelete($input: CollectionDeleteInput!) {
    collectionDelete(input: $input) {
      deletedCollectionId
      shop {
        id
        name
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "input": {
            "id": "gid://shopify/Collection/1009501285"
        }
    },
  },
);

const data = await response.json();

Ruby

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 collectionDelete($input: CollectionDeleteInput!) {
    collectionDelete(input: $input) {
      deletedCollectionId
      shop {
        id
        name
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "id": "gid://shopify/Collection/1009501285"
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation collectionDelete($input: CollectionDeleteInput!) {
      collectionDelete(input: $input) {
        deletedCollectionId
        shop {
          id
          name
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "input": {
            "id": "gid://shopify/Collection/1009501285"
        }
    },
  },
});

Response

{
  "collectionDelete": {
    "deletedCollectionId": "gid://shopify/Collection/1009501285",
    "shop": {
      "id": "gid://shopify/Shop/26371970",
      "name": "Snowdevil"
    },
    "userErrors": []
  }
}

Delete a collection that doesn't exist

Description

If a collection with the specified ID doesn't exist, then the mutation returns an error.

Query

mutation collectionDelete($input: CollectionDeleteInput!) {
  collectionDelete(input: $input) {
    deletedCollectionId
    shop {
      id
      name
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "input": {
    "id": "gid://shopify/Collection/-1"
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation collectionDelete($input: CollectionDeleteInput!) { collectionDelete(input: $input) { deletedCollectionId shop { id name } userErrors { field message } } }",
 "variables": {
    "input": {
      "id": "gid://shopify/Collection/-1"
    }
  }
}'

Remix

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

const response = await admin.graphql(
  `#graphql
  mutation collectionDelete($input: CollectionDeleteInput!) {
    collectionDelete(input: $input) {
      deletedCollectionId
      shop {
        id
        name
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "input": {
            "id": "gid://shopify/Collection/-1"
        }
    },
  },
);

const data = await response.json();

Ruby

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 collectionDelete($input: CollectionDeleteInput!) {
    collectionDelete(input: $input) {
      deletedCollectionId
      shop {
        id
        name
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "id": "gid://shopify/Collection/-1"
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation collectionDelete($input: CollectionDeleteInput!) {
      collectionDelete(input: $input) {
        deletedCollectionId
        shop {
          id
          name
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "input": {
            "id": "gid://shopify/Collection/-1"
        }
    },
  },
});

Response

{
  "collectionDelete": {
    "deletedCollectionId": null,
    "shop": {
      "id": "gid://shopify/Shop/26371970",
      "name": "Snowdevil"
    },
    "userErrors": [
      {
        "field": [
          "id"
        ],
        "message": "Collection does not exist"
      }
    ]
  }
}

Delete collection fails if call to CollectionsAccess returns false

Description

Restrict ability to delete a collection if the Shop is on Starter Plan.

Query

mutation collectionDelete($input: CollectionDeleteInput!) {
  collectionDelete(input: $input) {
    deletedCollectionId
    shop {
      id
      name
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "input": {
    "id": "gid://shopify/Collection/1009501285"
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation collectionDelete($input: CollectionDeleteInput!) { collectionDelete(input: $input) { deletedCollectionId shop { id name } userErrors { field message } } }",
 "variables": {
    "input": {
      "id": "gid://shopify/Collection/1009501285"
    }
  }
}'

Remix

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

const response = await admin.graphql(
  `#graphql
  mutation collectionDelete($input: CollectionDeleteInput!) {
    collectionDelete(input: $input) {
      deletedCollectionId
      shop {
        id
        name
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "input": {
            "id": "gid://shopify/Collection/1009501285"
        }
    },
  },
);

const data = await response.json();

Ruby

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 collectionDelete($input: CollectionDeleteInput!) {
    collectionDelete(input: $input) {
      deletedCollectionId
      shop {
        id
        name
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "id": "gid://shopify/Collection/1009501285"
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation collectionDelete($input: CollectionDeleteInput!) {
      collectionDelete(input: $input) {
        deletedCollectionId
        shop {
          id
          name
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "input": {
            "id": "gid://shopify/Collection/1009501285"
        }
    },
  },
});

Response

{
  "collectionDelete": null
}

Deletes a custom collection

Query

mutation CollectionDelete($id: ID!) {
  collectionDelete(input: {id: $id}) {
    deletedCollectionId
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/Collection/1009501285"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation CollectionDelete($id: ID!) { collectionDelete(input: {id: $id}) { deletedCollectionId userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/Collection/1009501285"
  }
}'

Remix

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

const response = await admin.graphql(
  `#graphql
  mutation CollectionDelete($id: ID!) {
    collectionDelete(input: {id: $id}) {
      deletedCollectionId
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Collection/1009501285"
    },
  },
);

const data = await response.json();

Ruby

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 CollectionDelete($id: ID!) {
    collectionDelete(input: {id: $id}) {
      deletedCollectionId
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Collection/1009501285"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation CollectionDelete($id: ID!) {
      collectionDelete(input: {id: $id}) {
        deletedCollectionId
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/Collection/1009501285"
    },
  },
});

Response

{
  "collectionDelete": {
    "deletedCollectionId": "gid://shopify/Collection/1009501285",
    "userErrors": []
  }
}

Removes a smart collection

Query

mutation CollectionDelete($id: ID!) {
  collectionDelete(input: {id: $id}) {
    deletedCollectionId
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/Collection/1009501285"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation CollectionDelete($id: ID!) { collectionDelete(input: {id: $id}) { deletedCollectionId userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/Collection/1009501285"
  }
}'

Remix

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

const response = await admin.graphql(
  `#graphql
  mutation CollectionDelete($id: ID!) {
    collectionDelete(input: {id: $id}) {
      deletedCollectionId
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Collection/1009501285"
    },
  },
);

const data = await response.json();

Ruby

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 CollectionDelete($id: ID!) {
    collectionDelete(input: {id: $id}) {
      deletedCollectionId
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Collection/1009501285"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation CollectionDelete($id: ID!) {
      collectionDelete(input: {id: $id}) {
        deletedCollectionId
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/Collection/1009501285"
    },
  },
});

Response

{
  "collectionDelete": {
    "deletedCollectionId": "gid://shopify/Collection/1009501285",
    "userErrors": []
  }
}

collectionDelete reference

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

mutation collectionDelete($input: CollectionDeleteInput!) {

collectionDelete(input: $input) {

deletedCollectionId

shop {

name

}

userErrors {

field

message

}

}`,

{

variables: {

"input": {

"id": "gid://shopify/Collection/1009501285"

}

);

const data = await response.json();

mutation collectionDelete($input: CollectionDeleteInput!) {
  collectionDelete(input: $input) {
    deletedCollectionId
    shop {
      id
      name
    }
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation collectionDelete($input: CollectionDeleteInput!) { collectionDelete(input: $input) { deletedCollectionId shop { id name } userErrors { field message } } }",
 "variables": {
    "input": {
      "id": "gid://shopify/Collection/1009501285"
    }
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation collectionDelete($input: CollectionDeleteInput!) {
    collectionDelete(input: $input) {
      deletedCollectionId
      shop {
        id
        name
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "input": {
            "id": "gid://shopify/Collection/1009501285"
        }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation collectionDelete($input: CollectionDeleteInput!) {
      collectionDelete(input: $input) {
        deletedCollectionId
        shop {
          id
          name
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "input": {
            "id": "gid://shopify/Collection/1009501285"
        }
    },
  },
});

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 collectionDelete($input: CollectionDeleteInput!) {
    collectionDelete(input: $input) {
      deletedCollectionId
      shop {
        id
        name
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "id": "gid://shopify/Collection/1009501285"
  }
}

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

Input variables

JSON

{

"input": {

"id": "gid://shopify/Collection/1009501285"

}

Response

JSON

{

"collectionDelete": {

"deletedCollectionId": "gid://shopify/Collection/1009501285",

"shop": {

"id": "gid://shopify/Shop/26371970",

"name": "Snowdevil"

"userErrors": []

}