SazitoSazito SDKv1.2.2
API Reference

Search

Unified entity search across products, CMS pages, blog pages, and categories.

Method

Query

Use: search.query(query, filters?, options?).

FieldTypeRequiredDescription
querystringRequiredSearch query text.
filters.pagenumberOptionalPage number.
filters.pageSizenumberOptionalPage size.
filters.categoryIdnumberOptionalCategory filter.
filters.minPricenumberOptionalMinimum price.
filters.maxPricenumberOptionalMaximum price.
optionsRequestOptionsOptionalPer-request controls.

Returns: SazitoResponse<SearchResponse>.

SearchResponse fields

FieldTypeRequiredDescription
products.itemsProduct[]RequiredProduct results.
blogPages.itemsBlogPage[]RequiredBlog page results.
cmsPages.itemsCmsPage[]RequiredCMS page results.
productCategories.itemsProductCategory[]RequiredCategory results.
*.totalnumberRequiredTotal items in result set.
*.pagenumberRequiredCurrent page.
*.pageSizenumberRequiredPage size.

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.search.query('shoe', { page: 1, pageSize: 10 }).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.

SearchFilters

Source: src/api/search.ts

FieldTypeRequired
pagenumberOptional
pageSizenumberOptional
categoryIdnumberOptional
minPricenumberOptional
maxPricenumberOptional

SearchResponse

Source: src/types/search.ts

FieldTypeRequired
products{ items: Product[]; total: number; page: number; pageSize: number; }Required
products.itemsProduct[]Required
products.totalnumberRequired
products.pagenumberRequired
products.pageSizenumberRequired
blogPages{ items: BlogPage[]; total: number; page: number; pageSize: number; }Required
blogPages.itemsBlogPage[]Required
blogPages.totalnumberRequired
blogPages.pagenumberRequired
blogPages.pageSizenumberRequired
cmsPages{ items: CmsPage[]; total: number; page: number; pageSize: number; }Required
cmsPages.itemsCmsPage[]Required
cmsPages.totalnumberRequired
cmsPages.pagenumberRequired
cmsPages.pageSizenumberRequired
productCategories{ items: ProductCategory[]; total: number; page: number; pageSize: number; }Required
productCategories.itemsProductCategory[]Required
productCategories.totalnumberRequired
productCategories.pagenumberRequired
productCategories.pageSizenumberRequired

Product

Source: src/types/product.ts

FieldTypeRequired
idnumberOptional
namestringRequired
urlstringRequired
enabledbooleanRequired
productTypestringRequired
themeConfiganyOptional
dynamicFormIdnumberOptional
eventEntityIdnumberOptional
attributesProductAttribute[]Optional
imagesImage[]Required
variantsProductVariant[]Required
categoriesProductCategory[]Required
createdAtstringRequired
updatedAtstringRequired

BlogPage

Source: src/types/search.ts

FieldTypeRequired
idnumberOptional
namestringRequired
urlstringRequired
enabledbooleanOptional
cmsPageTypeCMSPageTypeOptional
contentstringOptional
summarystringOptional
imageImageOptional
themeConfiganyOptional
attributesProductAttribute[]Optional
createdAtstringRequired
updatedAtstringRequired

CmsPage

Source: src/types/search.ts

FieldTypeRequired
idnumberOptional
namestringRequired
urlstringRequired
enabledbooleanOptional
cmsPageTypeCMSPageTypeOptional
contentstringOptional
summarystringOptional
imageImageOptional
themeConfiganyOptional
attributesProductAttribute[]Optional
createdAtstringRequired
updatedAtstringRequired

ProductCategory

Source: src/types/product.ts

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

On this page