SazitoSazito SDKv1.2.2
API Reference

General

Shop-wide info, features, checkout config, wallet config, and tajrobe config.

Methods

Get Info

Use: general.getInfo(options?).

Returns normalized SazitoResponse<GeneralInfo>.

Get Features

Use: general.getFeatures(options?).

Returns SazitoResponse<ShopFeatures>.

Get Checkout Config

Use: general.getCheckoutConfig(options?).

Returns SazitoResponse<CheckoutConfig>.

Get Wallet Config

Use: general.getWalletConfig(options?).

Returns SazitoResponse<WalletConfig>.

Get Tajrobe Config

Use: general.getTajrobeConfig(options?).

Returns SazitoResponse<TajrobeConfig>.

GeneralInfo key fields

Shop

FieldTypeRequiredDescription
shop.namestringRequiredShop display name.
shop.descriptionstringRequiredShop description.
shop.cityCity | nullRequiredShop city or null.
shop.domain.urlstringRequiredPrimary shop domain URL.
shop.logo.mainstringRequiredMain logo URL.

Settings

FieldTypeRequiredDescription
settings.checkoutCheckoutConfigRequiredCheckout behavior config.
settings.featuresShopFeaturesRequiredFeature flags map.
settings.walletWalletConfigRequiredWallet rules.
settings.tajrobeTajrobeConfigRequiredTajrobe settings.
settings.registerTypestringRequiredRegistration strategy.
settings.showProductStockNumberbooleanRequiredStock number visibility flag.

CheckoutConfig key fields

FieldTypeRequiredDescription
addToCartAlertbooleanRequiredShow add-to-cart alert.
dynamicFormbooleanRequiredDynamic form enabled.
emailOptionalbooleanRequiredEmail optional in checkout.
preventRedirectbooleanRequiredPrevent redirect behavior.
miniCartbooleanRequiredMini-cart enabled.
postalCodeMandatorybooleanRequiredPostal code requirement.
quickAddToCartbooleanRequiredQuick add-to-cart enabled.
minBasket.enabledbooleanRequiredMin basket rule active.
minBasket.minAmountnumberRequiredMinimum basket amount.

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.general.getInfo().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.

GeneralInfo

Source: src/api/general.ts

FieldTypeRequired
shopShopInfoRequired
settingsSettingsInfoRequired
scriptsScriptsInfoRequired

ShopInfo

Source: src/api/general.ts

FieldTypeRequired
namestringRequired
descriptionstringRequired
cityCity | nullRequired
domainDomainInfoRequired
logoLogoInfoRequired
socialSocialInfoRequired

SettingsInfo

Source: src/api/general.ts

FieldTypeRequired
checkoutCheckoutConfigRequired
featuresShopFeaturesRequired
walletWalletConfigRequired
tajrobeTajrobeConfigRequired
registerTypestringRequired
showProductStockNumberbooleanRequired

ScriptsInfo

Source: src/api/general.ts

FieldTypeRequired
enamadEnamadInfoRequired
googleGoogleInfoRequired

CheckoutConfig

Source: src/api/general.ts

FieldTypeRequired
addToCartAlertbooleanRequired
dynamicFormbooleanRequired
emailOptionalbooleanRequired
preventRedirectbooleanRequired
minBasket{ enabled: boolean; minAmount: number; }Required
minBasket.enabledbooleanRequired
minBasket.minAmountnumberRequired
miniCartbooleanRequired
postalCodeMandatorybooleanRequired
quickAddToCartbooleanRequired

WalletConfig

Source: src/api/general.ts

FieldTypeRequired
enabledbooleanRequired
useWithDiscountbooleanRequired
minAmountnumberRequired
minAmountRequiredbooleanRequired

TajrobeConfig

Source: src/api/general.ts

FieldTypeRequired
enabledbooleanRequired

ShopFeatures

Source: src/api/general.ts

FieldTypeRequired
[featureName: string]boolean | PremiumInfo | undefinedN/A
premiumPremiumInfoOptional

PremiumInfo

Source: src/api/general.ts

FieldTypeRequired
enabledbooleanRequired
nextRenewalstringRequired
subscriptionSubtypestringRequired

City

Source: src/api/general.ts

FieldTypeRequired
idnumberRequired
namestringRequired
latitudenumberRequired
longitudenumberRequired
regionRegionRequired

Region

Source: src/api/general.ts

FieldTypeRequired
idnumberRequired
namestringRequired
latitudenumberRequired
longitudenumberRequired

GoogleInfo

Source: src/api/general.ts

FieldTypeRequired
analyticsCodeGoogleAnalyticsCodeRequired
analyticsIdGoogleAnalyticsCodeRequired
tagManagerGoogleAnalyticsCodeRequired

GoogleAnalyticsCode

Source: src/api/general.ts

FieldTypeRequired
codestringRequired
enabledbooleanRequired

LogoInfo

Source: src/api/general.ts

FieldTypeRequired
faviconstringRequired
mainstringRequired

SocialInfo

Source: src/api/general.ts

FieldTypeRequired
facebookstringRequired
instagramstringRequired
phone1stringRequired
phone2stringRequired
telegramstringRequired
twitterstringRequired
whatsappstringRequired

DomainInfo

Source: src/api/general.ts

FieldTypeRequired
urlstringRequired

EnamadInfo

Source: src/api/general.ts

FieldTypeRequired
codestringRequired

On this page