To use the Collections API, install the @wix/stores package using npm or Yarn:
or
Then import { collections } from @wix/stores:
Retrieves a collection with the provided ID.
Requested collection ID.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Retrieves a collection with the provided slug.
Slug of the collection to retrieve.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Retrieves a list of up to 100 collections, given the provided paging, sorting and filtering. See Stores Pagination for more information.
| PROPERTY | SUPPORTED FILTERS & SORTING |
|---|---|
_id | eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending() |
name | eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending() |
function queryCollections(): CollectionsQueryBuilder;import { collections } from "@wix/stores";
async function queryCollections() {
const { items } = await collections.queryCollections().find();
}This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.