# collectionDelete - admin-graphql - MUTATION
Version: 2024-10

## Description
Deletes a collection.

### Access Scopes
`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.


## Arguments
* [input](/docs/api/admin-graphql/2024-10/input-objects/CollectionDeleteInput): CollectionDeleteInput! - The collection to delete.


## Returns
* [deletedCollectionId](/docs/api/admin-graphql/2024-10/scalars/ID): ID The ID of the collection that was deleted. Returns `null` if the collection doesn't exist.
* [shop](/docs/api/admin-graphql/2024-10/objects/Shop): Shop! The shop associated with the collection.
* [userErrors](/docs/api/admin-graphql/2024-10/objects/UserError): UserError! The list of errors that occurred from executing the mutation.


## Examples
### Delete a collection
Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation collectionDelete($input: CollectionDeleteInput!) { collectionDelete(input: $input) { deletedCollectionId shop { id name } userErrors { field message } } }\",\n \"variables\": {\n    \"input\": {\n      \"id\": \"gid://shopify/Collection/1009501285\"\n    }\n  }\n}'\n"
Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation collectionDelete($input: CollectionDeleteInput!) {\n      collectionDelete(input: $input) {\n        deletedCollectionId\n        shop {\n          id\n          name\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"id\": \"gid://shopify/Collection/1009501285\"\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 collectionDelete($input: CollectionDeleteInput!) {\n    collectionDelete(input: $input) {\n      deletedCollectionId\n      shop {\n        id\n        name\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"id\": \"gid://shopify/Collection/1009501285\"\n  }\n}\n\nresponse = 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 collectionDelete($input: CollectionDeleteInput!) {\n    collectionDelete(input: $input) {\n      deletedCollectionId\n      shop {\n        id\n        name\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"id\": \"gid://shopify/Collection/1009501285\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
Graphql query: "mutation collectionDelete($input: CollectionDeleteInput!) {\n  collectionDelete(input: $input) {\n    deletedCollectionId\n    shop {\n      id\n      name\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
#### Graphql Input
{
  "input": {
    "id": "gid://shopify/Collection/1009501285"
  }
}
#### Graphql Response
{
  "data": {
    "collectionDelete": {
      "deletedCollectionId": "gid://shopify/Collection/1009501285",
      "shop": {
        "id": "gid://shopify/Shop/26371970",
        "name": "Snowdevil"
      },
      "userErrors": []
    }
  }
}

### Delete a collection that doesn't exist
Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation collectionDelete($input: CollectionDeleteInput!) { collectionDelete(input: $input) { deletedCollectionId shop { id name } userErrors { field message } } }\",\n \"variables\": {\n    \"input\": {\n      \"id\": \"gid://shopify/Collection/-1\"\n    }\n  }\n}'\n"
Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation collectionDelete($input: CollectionDeleteInput!) {\n      collectionDelete(input: $input) {\n        deletedCollectionId\n        shop {\n          id\n          name\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"id\": \"gid://shopify/Collection/-1\"\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 collectionDelete($input: CollectionDeleteInput!) {\n    collectionDelete(input: $input) {\n      deletedCollectionId\n      shop {\n        id\n        name\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"id\": \"gid://shopify/Collection/-1\"\n  }\n}\n\nresponse = 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 collectionDelete($input: CollectionDeleteInput!) {\n    collectionDelete(input: $input) {\n      deletedCollectionId\n      shop {\n        id\n        name\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"id\": \"gid://shopify/Collection/-1\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
Graphql query: "mutation collectionDelete($input: CollectionDeleteInput!) {\n  collectionDelete(input: $input) {\n    deletedCollectionId\n    shop {\n      id\n      name\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
#### Graphql Input
{
  "input": {
    "id": "gid://shopify/Collection/-1"
  }
}
#### Graphql Response
{
  "data": {
    "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
Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation collectionDelete($input: CollectionDeleteInput!) { collectionDelete(input: $input) { deletedCollectionId shop { id name } userErrors { field message } } }\",\n \"variables\": {\n    \"input\": {\n      \"id\": \"gid://shopify/Collection/1009501285\"\n    }\n  }\n}'\n"
Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation collectionDelete($input: CollectionDeleteInput!) {\n      collectionDelete(input: $input) {\n        deletedCollectionId\n        shop {\n          id\n          name\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"id\": \"gid://shopify/Collection/1009501285\"\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 collectionDelete($input: CollectionDeleteInput!) {\n    collectionDelete(input: $input) {\n      deletedCollectionId\n      shop {\n        id\n        name\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"id\": \"gid://shopify/Collection/1009501285\"\n  }\n}\n\nresponse = 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 collectionDelete($input: CollectionDeleteInput!) {\n    collectionDelete(input: $input) {\n      deletedCollectionId\n      shop {\n        id\n        name\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"id\": \"gid://shopify/Collection/1009501285\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
Graphql query: "mutation collectionDelete($input: CollectionDeleteInput!) {\n  collectionDelete(input: $input) {\n    deletedCollectionId\n    shop {\n      id\n      name\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
#### Graphql Input
{
  "input": {
    "id": "gid://shopify/Collection/1009501285"
  }
}
#### Graphql Response
{
  "errors": [
    {
      "message": "Access denied for collectionDelete field. Required access: `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.",
      "locations": [
        {
          "line": 2,
          "column": 3
        }
      ],
      "path": [
        "collectionDelete"
      ],
      "extensions": {
        "code": "ACCESS_DENIED",
        "documentation": "https://shopify.dev/api/usage/access-scopes",
        "requiredAccess": "`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."
      }
    }
  ],
  "data": {
    "collectionDelete": null
  }
}

### Deletes a custom collection
Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation CollectionDelete($id: ID!) { collectionDelete(input: {id: $id}) { deletedCollectionId userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Collection/1009501285\"\n  }\n}'\n"
Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation CollectionDelete($id: ID!) {\n      collectionDelete(input: {id: $id}) {\n        deletedCollectionId\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Collection/1009501285\"\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 CollectionDelete($id: ID!) {\n    collectionDelete(input: {id: $id}) {\n      deletedCollectionId\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Collection/1009501285\"\n}\n\nresponse = 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 CollectionDelete($id: ID!) {\n    collectionDelete(input: {id: $id}) {\n      deletedCollectionId\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Collection/1009501285\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
Graphql query: "mutation CollectionDelete($id: ID!) {\n  collectionDelete(input: {id: $id}) {\n    deletedCollectionId\n    userErrors {\n      field\n      message\n    }\n  }\n}"
#### Graphql Input
{
  "id": "gid://shopify/Collection/1009501285"
}
#### Graphql Response
{
  "data": {
    "collectionDelete": {
      "deletedCollectionId": "gid://shopify/Collection/1009501285",
      "userErrors": []
    }
  }
}

### Removes a smart collection
Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation CollectionDelete($id: ID!) { collectionDelete(input: {id: $id}) { deletedCollectionId userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Collection/1009501285\"\n  }\n}'\n"
Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation CollectionDelete($id: ID!) {\n      collectionDelete(input: {id: $id}) {\n        deletedCollectionId\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Collection/1009501285\"\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 CollectionDelete($id: ID!) {\n    collectionDelete(input: {id: $id}) {\n      deletedCollectionId\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Collection/1009501285\"\n}\n\nresponse = 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 CollectionDelete($id: ID!) {\n    collectionDelete(input: {id: $id}) {\n      deletedCollectionId\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Collection/1009501285\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
Graphql query: "mutation CollectionDelete($id: ID!) {\n  collectionDelete(input: {id: $id}) {\n    deletedCollectionId\n    userErrors {\n      field\n      message\n    }\n  }\n}"
#### Graphql Input
{
  "id": "gid://shopify/Collection/1009501285"
}
#### Graphql Response
{
  "data": {
    "collectionDelete": {
      "deletedCollectionId": "gid://shopify/Collection/1009501285",
      "userErrors": []
    }
  }
}