findCategoryBySlug

Method finding category based on provided slug in Bloomreach Discovery.

This method sends a GET request to the search endpoint of the Vue Storefront API Middleware. In turn, it receives data from the Bloomreach GraphQL Commerce API using findCategoryBySlug query.

You can use this method to fetch information about certain category.

Signature

declare function findCategoryBySlug(
	params: QueryParams<QueryFindCategoryBySlugArgs>
): Promise<Category>;

Parameters

Name	Required	Type	Description
`params`	Required	`QueryParams<QueryFindCategoryBySlugArgs>`	Check the type for more information.

Returns

Returns a category.

Referenced Types

Examples

Fetching category by slug.

import { sdk } from '~/sdk';

const slug = 'some-slug';
const category = await sdk.brd.findCategoryBySlug({ slug });

Fetching category by slug with only specified fields.

import { sdk } from '~/sdk';

const slug = 'some-slug';
const category = await sdk.brd.findCategoryBySlug({
 slug,
 expect: `
   displayName
   slug
 `
});

Fetching category by slug passing query hint.

import { sdk } from '~/sdk';

const slug = 'some-slug';
const category = await sdk.brd.findCategoryBySlug({
 slug,
 queryHint: {
   brUid2: 'some value'
 }
});