categorySearch
Search categories
Signature
declare function categorySearch(
context: Context,
filters: QueryCategoriesArgs,
customQuery?: CustomQuery,
customHeaders?: CustomHeaders
): Promise<ApolloQueryResult<CategoriesQuery>>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | Context | |
filters | Required | QueryCategoriesArgs | |
customQuery | Optional | CustomQuery | |
customHeaders | Optional | CustomHeaders |
Referenced Types
- Context
- QueryCategoriesArgs
- CustomQuery
- CustomHeaders
ApolloQueryResultCategoriesQuery
Examples
Simple usage without filters
import { sdk } from '~/sdk.config.ts';
// fetch list of categories with default parameters
const categories = await sdk.magento.categorySearch();Usage with filters
import { sdk } from '~/sdk.config.ts';
// make a request to fetch list of categories with custom parameters
const details = await sdk.magento.categorySearch({
filters: {
category_uid: {
in: ['MjA=']
}
}
});Creating a custom GraphQL query for searching categories
module.exports = {
integrations: {
magento: {
customQueries: {
'category-search-custom-query': ({ variables, metadata }) => ({
variables,
query: `
query categorySearch($filters: CategoryFilterInput) {
categoryList(filters: $filters) {
${metadata.fields}
}
}
`
}),
},
}
}
};Using a custom GraphQL query to search categories.
import { sdk } from '~/sdk.config.ts';
const customQuery = {
categorySearch: 'category-search-custom-query',
metadata: {
fields: 'children_count products { total_count }'
}
};
const result = await sdk.magento.categorySearch({
filter: {
category_uid: {
in: ['=MjA']
}
}
}, customQuery);
// Details will contain only the fields specified in the custom query.