Settings

amerta

amerta / payload-types / Settings

Interface: Settings

Defined in: payload-types.ts:5641

This interface was referenced by Config's JSON-Schema via the definition "settings".

Properties

accountPageDescription?

optional accountPageDescription: string | null

Defined in: payload-types.ts:5810

SEO description for the account page

accountPageTitle?

optional accountPageTitle: string | null

Defined in: payload-types.ts:5806

SEO title for the account page

addressesPageDescription?

optional addressesPageDescription: string | null

Defined in: payload-types.ts:5818

SEO description for the addresses page

addressesPageTitle?

optional addressesPageTitle: string | null

Defined in: payload-types.ts:5814

SEO title for the addresses page

aiModel?

optional aiModel: "gemini-2.0-flash" | "gemini-2.5-flash" | "gemini-2.0-flash-lite" | "gemini-flash-latest" | "gemini-pro-latest" | null

Defined in: payload-types.ts:6052

Select the AI model to use for content generation

androidIcon?

optional androidIcon: string | Media | null

Defined in: payload-types.ts:5726

Android icon for home screen (192x192 pixels recommended)

appleSettings?

optional appleSettings: { clientId?: string | null; enabled?: boolean | null; keyId?: string | null; privateKey?: string | null; teamId?: string | null; }

Defined in: payload-types.ts:6037

clientId?

optional clientId: string | null

enabled?

optional enabled: boolean | null

keyId?

optional keyId: string | null

privateKey?

optional privateKey: string | null

teamId?

optional teamId: string | null

appleTouchIcon?

optional appleTouchIcon: string | Media | null

Defined in: payload-types.ts:5722

Apple touch icon for iOS devices (180x180 pixels recommended)

backgroundColor?

optional backgroundColor: string | null

Defined in: payload-types.ts:6094

Background color for PWA (e.g., #ffffff)

blogPageDescription?

optional blogPageDescription: string | null

Defined in: payload-types.ts:5754

SEO description for the blog page

blogPageTitle?

optional blogPageTitle: string | null

Defined in: payload-types.ts:5750

SEO title for the blog page

brandsPageDescription?

optional brandsPageDescription: string | null

Defined in: payload-types.ts:5850

SEO description for the brands page

brandsPageTitle?

optional brandsPageTitle: string | null

Defined in: payload-types.ts:5846

SEO title for the brands page

cartPageDescription?

optional cartPageDescription: string | null

Defined in: payload-types.ts:5890

SEO description for the cart page

cartPageTitle?

optional cartPageTitle: string | null

Defined in: payload-types.ts:5886

SEO title for the cart page

categoriesPageDescription?

optional categoriesPageDescription: string | null

Defined in: payload-types.ts:5874

SEO description for the categories page

categoriesPageTitle?

optional categoriesPageTitle: string | null

Defined in: payload-types.ts:5870

SEO title for the categories page

checkoutPageDescription?

optional checkoutPageDescription: string | null

Defined in: payload-types.ts:5898

SEO description for the checkout page

checkoutPageTitle?

optional checkoutPageTitle: string | null

Defined in: payload-types.ts:5894

SEO title for the checkout page

collectionsPageDescription?

optional collectionsPageDescription: string | null

Defined in: payload-types.ts:5842

SEO description for the collections page

collectionsPageTitle?

optional collectionsPageTitle: string | null

Defined in: payload-types.ts:5838

SEO title for the collections page

consentPrivacyPolicy?

optional consentPrivacyPolicy: string | Page | null

Defined in: payload-types.ts:6074

URL to your privacy policy for consent purposes

createAccountPageDescription?

optional createAccountPageDescription: string | null

Defined in: payload-types.ts:5762

SEO description for the create account page

createAccountPageTitle?

optional createAccountPageTitle: string | null

Defined in: payload-types.ts:5758

SEO title for the create account page

createdAt?

optional createdAt: string | null

Defined in: payload-types.ts:6112

dateFormat?

optional dateFormat: string | null

Defined in: payload-types.ts:5658

Format for displaying dates throughout the site (e.g., 'MMM dd, yyyy')

defaultPhoneCountryCode?

optional defaultPhoneCountryCode: "+1" | "+44" | "+61" | "+91" | "+86" | "+81" | "+82" | "+33" | "+49" | "+39" | "+34" | "+31" | "+46" | "+41" | "+43" | "+47" | "+45" | "+358" | "+48" | "+421" | "+385" | "+36" | "+40" | "+359" | "+30" | "+213" | "+20" | "+27" | "+55" | "+57" | "+56" | "+54" | "+51" | "+52" | "+506" | "+966" | "+971" | "+974" | "+965" | "+968" | "+92" | "+880" | "+66" | "+60" | "+65" | "+63" | "+84" | "+62" | "+64" | null

Defined in: payload-types.ts:5662

Default country code for phone number inputs (e.g., '+1' for USA)

defaultSeoDescription?

optional defaultSeoDescription: string | null

Defined in: payload-types.ts:5738

Default description when no specific description is set

defaultSeoImage?

optional defaultSeoImage: string | Media | null

Defined in: payload-types.ts:5742

Default image for social media sharing (1200x630 recommended)

defaultSeoPaginationTitle?

optional defaultSeoPaginationTitle: string | null

Defined in: payload-types.ts:5746

Don't add {siteName} here, it will be appended automatically from the SEO Title Template setting. Use %s for the base title and %d for the page number

defaultSeoTitle?

optional defaultSeoTitle: string | null

Defined in: payload-types.ts:5734

Default title when no specific title is set

desktopScreenshot?

optional desktopScreenshot: string | Media | null

Defined in: payload-types.ts:6082

Desktop PWA screenshot (must be exactly 1920x1080 pixels, landscape)

dir?

optional dir: "rtl" | "ltr" | null

Defined in: payload-types.ts:6106

Text direction for the PWA

emailFooterAddress?

optional emailFooterAddress: string | null

Defined in: payload-types.ts:5950

Business address to display in email footer

emailFooterEmail?

optional emailFooterEmail: string | null

Defined in: payload-types.ts:5954

Contact email to display in email footer

emailFooterHtml?

optional emailFooterHtml: {[k: string]: unknown; root: { children: {[k: string]: unknown; type: any; version: number; }[]; direction: "rtl" | "ltr" | null; format: "" | "center" | "left" | "start" | "right" | "end" | "justify"; indent: number; type: string; version: number; }; } | null

Defined in: payload-types.ts:5962

Additional custom HTML to append at the end of all emails (e.g., social media links, legal text)

emailFooterPhone?

optional emailFooterPhone: string | null

Defined in: payload-types.ts:5958

Phone number to display in email footer

emailLogo?

optional emailLogo: string | Media | null

Defined in: payload-types.ts:5942

Logo to display at the top of emails (recommended: max 600px wide, optimal height: 80-100px)

emailThemeColor?

optional emailThemeColor: string | null

Defined in: payload-types.ts:5946

Choose a color for this email theme

enableWhatsappChat?

optional enableWhatsappChat: boolean | null

Defined in: payload-types.ts:6024

Toggle to enable or disable WhatsApp chat support on the site

facebookAppId?

optional facebookAppId: string | null

Defined in: payload-types.ts:6019

Facebook App ID for Open Graph

facebookSettings?

optional facebookSettings: { clientId?: string | null; clientSecret?: string | null; enabled?: boolean | null; }

Defined in: payload-types.ts:6044

clientId?

optional clientId: string | null

clientSecret?

optional clientSecret: string | null

enabled?

optional enabled: boolean | null

favicon?

optional favicon: string | Media | null

Defined in: payload-types.ts:5718

Site favicon (.ico, .png, or .svg format, 32x32 pixels recommended)

fromEmail?

optional fromEmail: string | null

Defined in: payload-types.ts:5910

Default sender email address for all outgoing emails

fromName?

optional fromName: string | null

Defined in: payload-types.ts:5914

Default sender name for all outgoing emails

geminiTranslateApiKey?

optional geminiTranslateApiKey: string | null

Defined in: payload-types.ts:6058

API key for the selected AI service

googleSettings?

optional googleSettings: { clientId?: string | null; clientSecret?: string | null; enabled?: boolean | null; }

Defined in: payload-types.ts:6029

clientId?

optional clientId: string | null

clientSecret?

optional clientSecret: string | null

From Google Cloud Console

enabled?

optional enabled: boolean | null

gtagConsentEnabled?

optional gtagConsentEnabled: boolean | null

Defined in: payload-types.ts:6066

Enable Google Consent Mode for GDPR compliance

gtagEnabled?

optional gtagEnabled: boolean | null

Defined in: payload-types.ts:6062

Enable Google Analytics 4 tracking via GTag

gtagId?

optional gtagId: string | null

Defined in: payload-types.ts:6070

Your Google Analytics 4 Measurement ID (e.g., GTM-XXXXXXXX)

id

id: string

Defined in: payload-types.ts:5642

lang?

optional lang: string | null

Defined in: payload-types.ts:6102

Primary language for the PWA (default: en)

locales?

optional locales: string[]

Defined in: payload-types.ts:5980

Simple list of variant values

loginPageDescription?

optional loginPageDescription: string | null

Defined in: payload-types.ts:5770

SEO description for the login page

loginPageTitle?

optional loginPageTitle: string | null

Defined in: payload-types.ts:5766

SEO title for the login page

logoutPageDescription?

optional logoutPageDescription: string | null

Defined in: payload-types.ts:5906

SEO description for the logout page

logoutPageTitle?

optional logoutPageTitle: string | null

Defined in: payload-types.ts:5902

SEO title for the logout page

manifestIcon?

optional manifestIcon: string | Media | null

Defined in: payload-types.ts:6078

PWA icon image (must be exactly 512x512 pixels, SVG/PNG/WebP only)

mobileScreenshot?

optional mobileScreenshot: string | Media | null

Defined in: payload-types.ts:6086

Mobile PWA screenshot (must be exactly 1080x1920 pixels, portrait)

ogType?

optional ogType: "article" | "website" | null

Defined in: payload-types.ts:6020

ordersPageDescription?

optional ordersPageDescription: string | null

Defined in: payload-types.ts:5826

SEO description for the orders page

ordersPageTitle?

optional ordersPageTitle: string | null

Defined in: payload-types.ts:5822

SEO title for the orders page

productsPageDescription?

optional productsPageDescription: string | null

Defined in: payload-types.ts:5858

SEO description for the products page

productsPageTitle?

optional productsPageTitle: string | null

Defined in: payload-types.ts:5854

SEO title for the products page

productTagsPageDescription?

optional productTagsPageDescription: string | null

Defined in: payload-types.ts:5866

SEO description for the product tags page

productTagsPageTitle?

optional productTagsPageTitle: string | null

Defined in: payload-types.ts:5862

SEO title for the product tags page

profilePageDescription?

optional profilePageDescription: string | null

Defined in: payload-types.ts:5834

SEO description for the profile page

profilePageTitle?

optional profilePageTitle: string | null

Defined in: payload-types.ts:5830

SEO title for the profile page

pwaId?

optional pwaId: string | null

Defined in: payload-types.ts:6110

Unique identifier for the PWA

recoverPasswordPageDescription?

optional recoverPasswordPageDescription: string | null

Defined in: payload-types.ts:5778

SEO description for the recover password page

recoverPasswordPageTitle?

optional recoverPasswordPageTitle: string | null

Defined in: payload-types.ts:5774

SEO title for the recover password page

resendVerificationEmailPageDescription?

optional resendVerificationEmailPageDescription: string | null

Defined in: payload-types.ts:5786

SEO description for the resend verification email page

resendVerificationEmailPageTitle?

optional resendVerificationEmailPageTitle: string | null

Defined in: payload-types.ts:5782

SEO title for the resend verification email page

resetPasswordPageDescription?

optional resetPasswordPageDescription: string | null

Defined in: payload-types.ts:5794

SEO description for the reset password page

resetPasswordPageTitle?

optional resetPasswordPageTitle: string | null

Defined in: payload-types.ts:5790

SEO title for the reset password page

reviewNotificationEmails?

optional reviewNotificationEmails: { email: string; id?: string | null; }[] | null

Defined in: payload-types.ts:5988

Add email addresses that should receive product review notifications

reviewNotificationsEnabled?

optional reviewNotificationsEnabled: boolean | null

Defined in: payload-types.ts:5984

Enable email notifications when product reviews are submitted

reviewNotificationTemplate?

optional reviewNotificationTemplate: {[k: string]: unknown; root: { children: {[k: string]: unknown; type: any; version: number; }[]; direction: "rtl" | "ltr" | null; format: "" | "center" | "left" | "start" | "right" | "end" | "justify"; indent: number; type: string; version: number; }; } | null