DocumentationTypesInterfaces

Collection

amerta


amerta / payload-types / Collection

Interface: Collection

Defined in: payload-types.ts:1204

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

Properties

_status?

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

Defined in: payload-types.ts:1249


breadcrumbs?

optional breadcrumbs: { doc?: string | Collection | null; id?: string | null; label?: string | null; url?: string | null; }[] | null

Defined in: payload-types.ts:1241


createdAt

createdAt: string

Defined in: payload-types.ts:1231


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:1208


id

id: string

Defined in: payload-types.ts:1205


image?

optional image: string | ProductMedia | null

Defined in: payload-types.ts:1207


meta?

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

Defined in: payload-types.ts:1233

description?

optional description: string | null

image?

optional image: string | Media | null

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

title?

optional title: string | null


parent?

optional parent: string | Collection | null

Defined in: payload-types.ts:1230


publishedOn?

optional publishedOn: string | null

Defined in: payload-types.ts:1223


salesChannels

salesChannels: (string | SalesChannel)[]

Defined in: payload-types.ts:1229

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


slug?

optional slug: string | null

Defined in: payload-types.ts:1224


slugLock?

optional slugLock: boolean | null

Defined in: payload-types.ts:1225


title

title: string

Defined in: payload-types.ts:1206


updatedAt

updatedAt: string

Defined in: payload-types.ts:1232