Search.../
  1. APIs

getCollectionBySlug( )

Retrieves a collection with the provided slug.

Syntax

function getCollectionBySlug(slug: string): Promise<GetCollectionBySlugResponse>

getCollectionBySlug Parameters

NAME
TYPE
DESCRIPTION
slug
string

Slug of the collection to retrieve.

Returns

Return Type:

Promise<
GetCollectionBySlugResponse
>
NAME
TYPE
DESCRIPTION
collection
Collection

The requested collection.

Was this helpful?

getCollectionBySlug example

Copy Code
1import { products } from 'wix-stores.v2';
2  
3 async function getCollectionBySlug(slug) {
4   try {
5     const result = await products.getCollectionBySlug(slug);
6

7     return result;
8   } catch (error) {
9     console.error(error);
10     // Handle the error
11   }
12 }
13