getCollection( )

Retrieves a collection with the provided ID.

Method Declaration
Copy
Method Parameters
_idstringRequired

Requested collection ID.

Returns
Return Type:Promise<Collection>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

getCollectionBySlug( )

Retrieves a collection with the provided slug.

Method Declaration
Copy
Method Parameters
slugstringRequired

Slug of the collection to retrieve.

Returns
Return Type:Promise<GetCollectionBySlugResponse>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

queryCollections( )

Retrieves a list of up to 100 collections, given the provided paging, sorting and filtering. See Stores Pagination for more information.

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
nameeq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Return Type:CollectionsQueryBuilder
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

hasNext( )

Indicates whether the query has more results.

You can use the next() and prev() functions returned by collections to navigate the pages of a query result.

Method Declaration
Copy
Request
This method does not take any parameters
Returns
Return Type:boolean
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

hasPrev( )

Indicates whether the query has previous results.

You can use the next() and prev() functions returned by collections to navigate the pages of a query result.

Method Declaration
Copy
Request
This method does not take any parameters
Returns
Return Type:boolean
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

next( )

Retrieves the next page of query results.

The next() function retrieves the next page of query results. The page size is defined by the limit() function and can be retrieved using the pageSize property. You can use the next() and prev() functions returned by collections to navigate the pages of a query result. If items are added or removed between calls to next(), the values returned by CollectionsQueryBuilder may change.

Method Declaration
Copy
Request
This method does not take any parameters
Returns
Return Type:Promise<CollectionsQueryResult>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

prev( )

Retrieves the previous page of query results.

The prev() function retrieves the previous page of query results. The page size is defined by the limit() function and can be retrieved using the pageSize property. You can use the next() and prev() functions returned by collections to navigate the pages of a query result. If items are added or removed between calls to prev(), the values returned may change.

Method Declaration
Copy
Request
This method does not take any parameters
Returns
Return Type:Promise<CollectionsQueryResult>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?