SazitoSazito SDKv1.2.2
API Reference

Categories

Category lookup and hierarchical category tree retrieval.

Methods

Get

Use: categories.get(idOrSlug, options?).

ParameterTypeRequiredDescription
idOrSlugstring | numberRequiredCategory ID or slug.
optionsRequestOptionsOptionalPer-request controls.

Returns: SazitoResponse<ProductCategory>.

List

Use: categories.list(filters?, options?).

FieldTypeRequiredDescription
filters.pagenumberOptionalPage number.
filters.pageSizenumberOptionalPage size.
optionsRequestOptionsOptionalPer-request controls.

Returns: SazitoResponse<CategoryListResponse>.

CategoryListResponse fields

FieldTypeRequiredDescription
categoriesProductCategory[]RequiredFlat category list.
treeCategoryTreeRequiredHierarchical 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

FieldTypeRequired
pagenumberOptional
pageSizenumberOptional

CategoryListResponse

Source: src/api/categories.ts

FieldTypeRequired
categoriesProductCategory[]Required
treeCategoryTreeRequired

CategoryTree

Source: src/api/categories.ts

FieldTypeRequired
idnumberRequired
treeType'product_categories'Required
treeStructure{ nodes: CategoryTreeNode[]; }Required
treeStructure.nodesCategoryTreeNode[]Required

CategoryTreeNode

Source: src/api/categories.ts

FieldTypeRequired
idnumberRequired
entityType'product_category'Required
entityIdnumberRequired
entityProductCategoryRequired
detailsanyRequired
childrenCategoryTreeNode[]Required
createdAtstringRequired
updatedAtstringRequired

ProductCategory

Source: src/types/product.ts

FieldTypeRequired
idnumberOptional
namestringRequired
urlstringRequired
enabledbooleanOptional
descriptionstringOptional
productsCountnumberOptional
themeConfiganyOptional
attributesProductAttribute[]Optional
createdAtstringOptional
updatedAtstringOptional

On this page