***
title: "CollectionService"
generated: true
---------------
Contains methods relating to [Collection](/current/core/reference/typescript-api/entities/collection#collection) entities.
```ts title="Signature"
class CollectionService implements OnModuleInit {
constructor(connection: TransactionalConnection, channelService: ChannelService, assetService: AssetService, listQueryBuilder: ListQueryBuilder, translatableSaver: TranslatableSaver, eventBus: EventBus, jobQueueService: JobQueueService, configService: ConfigService, slugValidator: SlugValidator, configArgService: ConfigArgService, customFieldRelationService: CustomFieldRelationService, translator: TranslatorService, roleService: RoleService, requestContextService: RequestContextService)
findAll(ctx: RequestContext, options?: ListQueryOptions & { topLevelOnly?: boolean }, relations?: RelationPaths) => Promise>>;
findOne(ctx: RequestContext, collectionId: ID, relations?: RelationPaths) => Promise | undefined>;
findByIds(ctx: RequestContext, ids: ID[], relations?: RelationPaths) => Promise>>;
findOneBySlug(ctx: RequestContext, slug: string, relations?: RelationPaths) => Promise | undefined>;
getAvailableFilters(ctx: RequestContext) => ConfigurableOperationDefinition[];
getParent(ctx: RequestContext, collectionId: ID) => Promise;
getChildren(ctx: RequestContext, collectionId: ID) => Promise;
getProductVariantCounts(ctx: RequestContext, collectionIds: ID[]) => Promise>;
getBreadcrumbs(ctx: RequestContext, collection: Collection) => Promise>;
getCollectionsByProductId(ctx: RequestContext, productId: ID, publicOnly: boolean) => Promise>>;
getDescendants(ctx: RequestContext, rootId: ID, maxDepth: number = Number.MAX_SAFE_INTEGER) => Promise>>;
getAncestors(collectionId: ID) => Promise;
getAncestors(collectionId: ID, ctx: RequestContext) => Promise>>;
getAncestors(collectionId: ID, ctx?: RequestContext) => Promise | Collection>>;
previewCollectionVariants(ctx: RequestContext, input: PreviewCollectionVariantsInput, options?: ListQueryOptions, relations?: RelationPaths) => Promise>;
create(ctx: RequestContext, input: CreateCollectionInput) => Promise>;
update(ctx: RequestContext, input: UpdateCollectionInput) => Promise>;
delete(ctx: RequestContext, id: ID) => Promise;
move(ctx: RequestContext, input: MoveCollectionInput) => Promise>;
setApplyAllFiltersOnProductUpdates(applyAllFiltersOnProductUpdates: boolean) => ;
triggerApplyFiltersJob(ctx: RequestContext, options?: { collectionIds?: ID[]; applyToChangedVariantsOnly?: boolean }) => ;
getCollectionProductVariantIds(collection: Collection, ctx?: RequestContext) => Promise;
assignCollectionsToChannel(ctx: RequestContext, input: AssignCollectionsToChannelInput) => Promise>>;
removeCollectionsFromChannel(ctx: RequestContext, input: RemoveCollectionsFromChannelInput) => Promise>>;
}
```
* Implements: OnModuleInit
### findAll
\
RequestContext, options?: ListQueryOptions<Collection> & { topLevelOnly?: boolean }, relations?: RelationPaths<Collection>) => Promise<PaginatedListCollection>>>`} />
### findOne
\RequestContext, collectionId: ID, relations?: RelationPaths<Collection>) => PromiseCollection> | undefined>`} />
### findByIds
\RequestContext, ids: ID[], relations?: RelationPaths<Collection>) => PromiseCollection>>>`} />
### findOneBySlug
\RequestContext, slug: string, relations?: RelationPaths<Collection>) => PromiseCollection> | undefined>`} />
### getAvailableFilters
\RequestContext) => ConfigurableOperationDefinition[]`} />
Returns all configured CollectionFilters, as specified by the [CatalogOptions](/current/core/reference/typescript-api/products-stock/catalog-options#catalogoptions).
### getParent
\RequestContext, collectionId: ID) => Promise<Collection | undefined>`} />
### getChildren
\RequestContext, collectionId: ID) => Promise<Collection[]>`} />
Returns all child Collections of the Collection with the given id.
### getProductVariantCounts
\RequestContext, collectionIds: ID[]) => PromiseID, number>>`} />
Returns a Map of collection IDs to their product variant counts.
This performs a single bulk query to get counts for all provided collection IDs,
avoiding N+1 query issues when resolving productVariantCount on multiple collections.
### getBreadcrumbs
\RequestContext, collection: Collection) => PromiseID; slug: string }>>`} />
Returns an array of name/id pairs representing all ancestor Collections up
to the Root Collection.
### getCollectionsByProductId
\RequestContext, productId: ID, publicOnly: boolean) => PromiseCollection>>>`} />
Returns all Collections which are associated with the given Product ID.
### getDescendants
\RequestContext, rootId: ID, maxDepth: number = Number.MAX_SAFE_INTEGER) => PromiseCollection>>>`} />
Returns the descendants of a Collection as a flat array. The depth of the traversal can be limited
with the maxDepth argument. So to get only the immediate children, set maxDepth = 1.
### getAncestors
\ID) => Promise<Collection[]>`} />
Gets the ancestors of a given collection. Note that since ProductCategories are implemented as an adjacency list, this method
will produce more queries the deeper the collection is in the tree.
### getAncestors
\ID, ctx: RequestContext) => PromiseCollection>>>`} />
### getAncestors
\ID, ctx?: RequestContext) => PromiseCollection> | Collection>>`} />
### previewCollectionVariants
\RequestContext, input: PreviewCollectionVariantsInput, options?: ListQueryOptions<ProductVariant>, relations?: RelationPaths<Collection>) => Promise<PaginatedList<ProductVariant>>`} />
### create
\RequestContext, input: CreateCollectionInput) => PromiseCollection>>`} />
### update
\RequestContext, input: UpdateCollectionInput) => PromiseCollection>>`} />
### delete
\RequestContext, id: ID) => Promise`} />
### move
\RequestContext, input: MoveCollectionInput) => PromiseCollection>>`} />
Moves a Collection by specifying the parent Collection ID, and an index representing the order amongst
its siblings.
### setApplyAllFiltersOnProductUpdates
\ `} since="3.1.3" />
By default, whenever product data is updated (as determined by subscribing to the
[ProductEvent](/current/core/reference/typescript-api/events/event-types#productevent) and [ProductVariantEvent](/current/core/reference/typescript-api/events/event-types#productvariantevent) events), the CollectionFilters are re-applied
to all Collections.
In certain scenarios, such as when a large number of products are updated at once due to
bulk data import, this can be inefficient. In such cases, you can disable this behaviour
for the duration of the import process by calling this method with `false`, and then
re-enable it by calling with `true`.
Afterward, you can call the `triggerApplyFiltersJob` method to manually re-apply the filters.
### triggerApplyFiltersJob
\RequestContext, options?: { collectionIds?: ID[]; applyToChangedVariantsOnly?: boolean }) => `} since="3.1.3" />
Triggers the creation of an `apply-collection-filters` job which will cause the contents
of the specified collections to be re-evaluated against their filters.
If no `collectionIds` option is passed, then all collections will be re-evaluated.
### getCollectionProductVariantIds
\Collection, ctx?: RequestContext) => Promise<ID[]>`} />
### assignCollectionsToChannel
\RequestContext, input: AssignCollectionsToChannelInput) => PromiseCollection>>>`} />
Assigns Collections to the specified Channel
### removeCollectionsFromChannel
\RequestContext, input: RemoveCollectionsFromChannelInput) => PromiseCollection>>>`} />
Remove Collections from the specified Channel