categories
Fetch list of all categories matching specified filters
Signature
declare function categories(
context: Context,
params: QueryCategoriesArgs,
customQuery?: CustomQuery,
customHeaders?: CustomHeaders
): Promise<ApolloQueryResult<CategoriesQuery>>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | Context | |
params | Required | QueryCategoriesArgs | |
customQuery | Optional | CustomQuery | |
customHeaders | Optional | CustomHeaders |
Referenced Types
- Context
- QueryCategoriesArgs
- CustomQuery
- CustomHeaders
ApolloQueryResultCategoriesQuery
Examples
Simple usage:
import { sdk } from '~/sdk.config.ts';
// fetch list of categories with default parameters
const categories = await sdk.magento.categories({});Creating a custom GraphQL query for fetching categories.
module.exports = {
integrations: {
magento: {
customQueries: {
'categories-custom-query': ({ variables, metadata }) => ({
variables,
query: `
query categories {
categories {
${metadata.fields}
}
}
`
}),
},
}
}
};Using a custom GraphQL query to fetch categories.
import { sdk } from '~/sdk.config.ts';
const customQuery = {
categories: 'categories-custom-query',
metadata: {
fields: 'items { uid name }'
}
};
const categories = await sdk.magento.categories({}, customQuery);
// Category list will contain only the fields specified in the custom query.