Ecommerce Settings

amerta

---

amerta / payload-types / EcommerceSettings

Interface: EcommerceSettings

Defined in: payload-types.ts:5347

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

Properties

allowOrderNotes?

optional allowOrderNotes: boolean | null

Defined in: payload-types.ts:5364

Allow customers to add notes to their orders

---

announcementBar?

optional announcementBar: { announcements?: { id?: string | null; link?: { appearance?: "default" | "link" | "outline" | "destructive" | "ghost" | "secondary" | null; label?: string | null; newTab?: boolean | null; reference?: { relationTo: "pages"; value: string | Page; } | { relationTo: "posts"; value: string | Post; } | { relationTo: "categories"; value: string | Category; } | { relationTo: "products"; value: string | Product; } | { relationTo: "collections"; value: string | Collection; } | { relationTo: "product-brands"; value: string | ProductBrand; } | null; size?: "default" | "sm" | "lg" | "xs" | null; type?: "custom" | "reference" | null; url?: string | null; }; text: string; }[] | null; autoRotate?: boolean | null; direction?: "scrollTop" | "scrollLeft" | null; enabled?: boolean | null; showButtons?: boolean | null; showSocial?: boolean | null; socialLinks?: { id?: string | null; platform: "x" | "facebook" | "instagram" | "github" | "youtube"; url: string; }[] | null; speed?: number | null; }

Defined in: payload-types.ts:5365

announcements?

optional announcements: { id?: string | null; link?: { appearance?: "default" | "link" | "outline" | "destructive" | "ghost" | "secondary" | null; label?: string | null; newTab?: boolean | null; reference?: { relationTo: "pages"; value: string | Page; } | { relationTo: "posts"; value: string | Post; } | { relationTo: "categories"; value: string | Category; } | { relationTo: "products"; value: string | Product; } | { relationTo: "collections"; value: string | Collection; } | { relationTo: "product-brands"; value: string | ProductBrand; } | null; size?: "default" | "sm" | "lg" | "xs" | null; type?: "custom" | "reference" | null; url?: string | null; }; text: string; }[] | null

autoRotate?

optional autoRotate: boolean | null

direction?

optional direction: "scrollTop" | "scrollLeft" | null

enabled?

optional enabled: boolean | null

showButtons?

optional showButtons: boolean | null

showSocial?

optional showSocial: boolean | null

socialLinks?

optional socialLinks: { id?: string | null; platform: "x" | "facebook" | "instagram" | "github" | "youtube"; url: string; }[] | null

speed?

optional speed: number | null

---

createdAt?

optional createdAt: string | null

Defined in: payload-types.ts:5429

---

enableGuestCheckout?

optional enableGuestCheckout: boolean | null

Defined in: payload-types.ts:5352

Allow customers to place orders without creating an account

---

id

id: string

Defined in: payload-types.ts:5348

---

orderIdTemplate

orderIdTemplate: string

Defined in: payload-types.ts:5356

Template for generating order IDs. Available variables: {YYYY} - year, {MM} - month, {DD} - day, {COUNTER} - sequential number

---

startOrderIdFrom

startOrderIdFrom: number

Defined in: payload-types.ts:5360

The starting number for order IDs (e.g., 1000 will start from ORD-20260107-1000)

---

updatedAt?

optional updatedAt: string | null

Defined in: payload-types.ts:5428