Product

amerta

---

amerta / payload-types / Product

Interface: Product

Defined in: payload-types.ts:343

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

Properties

_status?

optional _status: "draft" | "published" | null

Defined in: payload-types.ts:488

---

barcode?

optional barcode: string | null

Defined in: payload-types.ts:395

---

benefits?

optional benefits: { description: string; icon?: string | null; id?: string | null; title: string; }[] | null

Defined in: payload-types.ts:440

---

brand?

optional brand: string | ProductBrand | null

Defined in: payload-types.ts:470

---

collections?

optional collections: (string | Collection)[] | null

Defined in: payload-types.ts:468

---

countries?

optional countries: (string | Country)[] | null

Defined in: payload-types.ts:482

If set, this product will only be available to customers from the selected countries, this will only work if the theme supports it.

---

createdAt

createdAt: string

Defined in: payload-types.ts:484

---

description?

optional description: {[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:349

---

excerpt?

optional excerpt: string | null

Defined in: payload-types.ts:348

---

faqs?

optional faqs: { answer: string; id?: string | null; question: string; }[] | null

Defined in: payload-types.ts:449

---

height?

optional height: number | null

Defined in: payload-types.ts:401

---

id

id: string

Defined in: payload-types.ts:344

---

images?

optional images: (string | ProductMedia)[] | null

Defined in: payload-types.ts:346

---

isFeatured?

optional isFeatured: boolean | null

Defined in: payload-types.ts:469

---

layout?

optional layout: (ThemeShopHeroBlock | ThemeShopHeroVideoBlock | ThemeShopCollectionShowcaseBlock | ThemeShopCTAFeatureBlock | ThemeShopGridShowcaseBlock | ThemeShopMediaBlock | ThemeShopBannerBlock | ThemeShopCodeBlock | ThemeShopCallToActionTextBlock | ThemeShopNewsletterBlock | ThemeShopCollectionArchiveBlock | ThemeShopFeaturesBlock | ThemeShopBenefitsBlock | ThemeShopBlogPostsBlock | ThemeShopContactUsBlock | ThemeShopContentBlock | ThemeShopImageBlock | ThemeShopSpacerBlock)[] | null

Defined in: payload-types.ts:403

---

length?

optional length: number | null

Defined in: payload-types.ts:400

---

meta?

optional meta: { description?: string | null; image?: string | ProductMedia | null; title?: string | null; }

Defined in: payload-types.ts:459

description?

optional description: string | null

image?

optional image: string | ProductMedia | null

Maximum upload file size: 12MB. Recommended file size for images is <500KB.

title?

optional title: string | null

---

pairWithProducts?

optional pairWithProducts: (string | Product)[] | null

Defined in: payload-types.ts:457

---

price

price: number

Defined in: payload-types.ts:392

---

productDetails?

optional productDetails: { detail: string; id?: string | null; }[] | null

Defined in: payload-types.ts:426

---

productFeatures?

optional productFeatures: { feature: string; id?: string | null; }[] | null

Defined in: payload-types.ts:433

---

publishedOn?

optional publishedOn: string | null

Defined in: payload-types.ts:467

---

quantity?

optional quantity: number | null

Defined in: payload-types.ts:398

---

rating?

optional rating: number | null

Defined in: payload-types.ts:486

---

relatedProducts?

optional relatedProducts: (string | Product)[] | null

Defined in: payload-types.ts:458

---

reviewCount?

optional reviewCount: number | null

Defined in: payload-types.ts:487

---

salePrice?

optional salePrice: number | null

Defined in: payload-types.ts:393

---

salesChannels

salesChannels: (string | SalesChannel)[]

Defined in: payload-types.ts:478

This product will only be available in the selected sales channels.

---

showBenefits?

optional showBenefits: boolean | null

Defined in: payload-types.ts:439

---

showFAQs?

optional showFAQs: boolean | null

Defined in: payload-types.ts:448

---

showPairWith?

optional showPairWith: boolean | null

Defined in: payload-types.ts:456

---

showProductDetails?

optional showProductDetails: boolean | null

Defined in: payload-types.ts:425

---

showProductFeatures?

optional showProductFeatures: boolean | null

Defined in: payload-types.ts:432

---

skipSync?

optional skipSync: boolean | null

Defined in: payload-types.ts:483

---

sku?

optional sku: string | null

Defined in: payload-types.ts:394

---

slug?

optional slug: string | null

Defined in: payload-types.ts:472

---

slugLock?

optional slugLock: boolean | null

Defined in: payload-types.ts:473

---

stockStatus?

optional stockStatus: "in_stock" | "out_of_stock" | "on_backorder" | null

Defined in: payload-types.ts:397

---

stores?

optional stores: (string | Store)[] | null

Defined in: payload-types.ts:474

---

tags?

optional tags: (string | ProductTag)[] | null

Defined in: payload-types.ts:471

---

title

title: string

Defined in: payload-types.ts:345

---

trackInventory?

optional trackInventory: boolean | null

Defined in: payload-types.ts:396

---

type?

optional type: "variant" | "simple" | null

Defined in: payload-types.ts:347

---

updatedAt

updatedAt: string

Defined in: payload-types.ts:485

---

variants?

optional variants: { barcode?: string | null; height?: number | null; id?: string | null; image?: string | ProductMedia | null; length?: number | null; price: number; quantity?: number | null; requires_shipping?: boolean | null; salePrice?: number | null; sku?: string | null; stockStatus?: "in_stock" | "out_of_stock" | "on_backorder" | null; trackInventory?: boolean | null; variant: {[k: string]: {[k: string]: unknown; name: string; value: string; }; }; weight?: number | null; width?: number | null; }[] | null

Defined in: payload-types.ts:364

---

weight?

optional weight: number | null

Defined in: payload-types.ts:402

---

width?

optional width: number | null

Defined in: payload-types.ts:399