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
| Field | Type | Required | Description |
|---|---|---|---|
shop.name | string | Required | Shop display name. |
shop.description | string | Required | Shop description. |
shop.city | City | null | Required | Shop city or null. |
shop.domain.url | string | Required | Primary shop domain URL. |
shop.logo.main | string | Required | Main logo URL. |
Settings
| Field | Type | Required | Description |
|---|---|---|---|
settings.checkout | CheckoutConfig | Required | Checkout behavior config. |
settings.features | ShopFeatures | Required | Feature flags map. |
settings.wallet | WalletConfig | Required | Wallet rules. |
settings.tajrobe | TajrobeConfig | Required | Tajrobe settings. |
settings.registerType | string | Required | Registration strategy. |
settings.showProductStockNumber | boolean | Required | Stock number visibility flag. |
CheckoutConfig key fields
| Field | Type | Required | Description |
|---|---|---|---|
addToCartAlert | boolean | Required | Show add-to-cart alert. |
dynamicForm | boolean | Required | Dynamic form enabled. |
emailOptional | boolean | Required | Email optional in checkout. |
preventRedirect | boolean | Required | Prevent redirect behavior. |
miniCart | boolean | Required | Mini-cart enabled. |
postalCodeMandatory | boolean | Required | Postal code requirement. |
quickAddToCart | boolean | Required | Quick add-to-cart enabled. |
minBasket.enabled | boolean | Required | Min basket rule active. |
minBasket.minAmount | number | Required | Minimum 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
| Field | Type | Required |
|---|---|---|
shop | ShopInfo | Required |
settings | SettingsInfo | Required |
scripts | ScriptsInfo | Required |
ShopInfo
Source: src/api/general.ts
| Field | Type | Required |
|---|---|---|
name | string | Required |
description | string | Required |
city | City | null | Required |
domain | DomainInfo | Required |
logo | LogoInfo | Required |
social | SocialInfo | Required |
SettingsInfo
Source: src/api/general.ts
| Field | Type | Required |
|---|---|---|
checkout | CheckoutConfig | Required |
features | ShopFeatures | Required |
wallet | WalletConfig | Required |
tajrobe | TajrobeConfig | Required |
registerType | string | Required |
showProductStockNumber | boolean | Required |
ScriptsInfo
Source: src/api/general.ts
| Field | Type | Required |
|---|---|---|
enamad | EnamadInfo | Required |
google | GoogleInfo | Required |
CheckoutConfig
Source: src/api/general.ts
| Field | Type | Required |
|---|---|---|
addToCartAlert | boolean | Required |
dynamicForm | boolean | Required |
emailOptional | boolean | Required |
preventRedirect | boolean | Required |
minBasket | { enabled: boolean; minAmount: number; } | Required |
minBasket.enabled | boolean | Required |
minBasket.minAmount | number | Required |
miniCart | boolean | Required |
postalCodeMandatory | boolean | Required |
quickAddToCart | boolean | Required |
WalletConfig
Source: src/api/general.ts
| Field | Type | Required |
|---|---|---|
enabled | boolean | Required |
useWithDiscount | boolean | Required |
minAmount | number | Required |
minAmountRequired | boolean | Required |
TajrobeConfig
Source: src/api/general.ts
| Field | Type | Required |
|---|---|---|
enabled | boolean | Required |
ShopFeatures
Source: src/api/general.ts
| Field | Type | Required |
|---|---|---|
[featureName: string] | boolean | PremiumInfo | undefined | N/A |
premium | PremiumInfo | Optional |
PremiumInfo
Source: src/api/general.ts
| Field | Type | Required |
|---|---|---|
enabled | boolean | Required |
nextRenewal | string | Required |
subscriptionSubtype | string | Required |
City
Source: src/api/general.ts
| Field | Type | Required |
|---|---|---|
id | number | Required |
name | string | Required |
latitude | number | Required |
longitude | number | Required |
region | Region | Required |
Region
Source: src/api/general.ts
| Field | Type | Required |
|---|---|---|
id | number | Required |
name | string | Required |
latitude | number | Required |
longitude | number | Required |
GoogleInfo
Source: src/api/general.ts
| Field | Type | Required |
|---|---|---|
analyticsCode | GoogleAnalyticsCode | Required |
analyticsId | GoogleAnalyticsCode | Required |
tagManager | GoogleAnalyticsCode | Required |
GoogleAnalyticsCode
Source: src/api/general.ts
| Field | Type | Required |
|---|---|---|
code | string | Required |
enabled | boolean | Required |
LogoInfo
Source: src/api/general.ts
| Field | Type | Required |
|---|---|---|
favicon | string | Required |
main | string | Required |
SocialInfo
Source: src/api/general.ts
| Field | Type | Required |
|---|---|---|
facebook | string | Required |
instagram | string | Required |
phone1 | string | Required |
phone2 | string | Required |
telegram | string | Required |
twitter | string | Required |
whatsapp | string | Required |
DomainInfo
Source: src/api/general.ts
| Field | Type | Required |
|---|---|---|
url | string | Required |
EnamadInfo
Source: src/api/general.ts
| Field | Type | Required |
|---|---|---|
code | string | Required |