API Reference
Categories
Category lookup and hierarchical category tree retrieval.
Methods
Get
Use: categories.get(idOrSlug, options?).
| Parameter | Type | Required | Description |
|---|---|---|---|
idOrSlug | string | number | Required | Category ID or slug. |
options | RequestOptions | Optional | Per-request controls. |
Returns: SazitoResponse<ProductCategory>.
List
Use: categories.list(filters?, options?).
| Field | Type | Required | Description |
|---|---|---|---|
filters.page | number | Optional | Page number. |
filters.pageSize | number | Optional | Page size. |
options | RequestOptions | Optional | Per-request controls. |
Returns: SazitoResponse<CategoryListResponse>.
CategoryListResponse fields
| Field | Type | Required | Description |
|---|---|---|---|
categories | ProductCategory[] | Required | Flat category list. |
tree | CategoryTree | Required | Hierarchical category tree. |
Examples
// app/lib/sazito-client.ts
import { createSazitoClient } from '@sazito/client-sdk';
export const sazito = createSazitoClient({
domain: process.env.NEXT_PUBLIC_SAZITO_DOMAIN!,
});// app/[lang]/(home)/page.tsx
'use client';
import { useEffect, useState } from 'react';
import { sazito } from '@/app/lib/sazito-client';
export default function Example() {
const [data, setData] = useState<any>(null);
useEffect(() => {
sazito.categories.list({ page: 1, pageSize: 100 }).then((res) => setData(res.data ?? null));
}, []);
return <pre>{JSON.stringify(data, null, 2)}</pre>;
}Type Details
The following tables are generated from SDK TypeScript types and include nested object fields.
CategoryFilters
Source: src/api/categories.ts
| Field | Type | Required |
|---|---|---|
page | number | Optional |
pageSize | number | Optional |
CategoryListResponse
Source: src/api/categories.ts
| Field | Type | Required |
|---|---|---|
categories | ProductCategory[] | Required |
tree | CategoryTree | Required |
CategoryTree
Source: src/api/categories.ts
| Field | Type | Required |
|---|---|---|
id | number | Required |
treeType | 'product_categories' | Required |
treeStructure | { nodes: CategoryTreeNode[]; } | Required |
treeStructure.nodes | CategoryTreeNode[] | Required |
CategoryTreeNode
Source: src/api/categories.ts
| Field | Type | Required |
|---|---|---|
id | number | Required |
entityType | 'product_category' | Required |
entityId | number | Required |
entity | ProductCategory | Required |
details | any | Required |
children | CategoryTreeNode[] | Required |
createdAt | string | Required |
updatedAt | string | Required |
ProductCategory
Source: src/types/product.ts
| Field | Type | Required |
|---|---|---|
id | number | Optional |
name | string | Required |
url | string | Required |
enabled | boolean | Optional |
description | string | Optional |
productsCount | number | Optional |
themeConfig | any | Optional |
attributes | ProductAttribute[] | Optional |
createdAt | string | Optional |
updatedAt | string | Optional |