The commercial copy for one Platform capability, as served by the Vendure catalog.
stringThe capability key, for example org.accounts.
PlatformTierstringstring[string, string, string]Exactly 3 lines.
'trial' | 'sales'trial for Starter, Growth and Scale. sales for Enterprise.
Version 1 of the dashboardPromotion field of GET https://api.vendure.io/v1/catalog.
It holds the Dashboard placements of the Vendure Platform plugins, and the commercial
copy for each capability.
1Array<{ id: string; label: string; /** * @description * The PascalCase name of a lucide-react icon, without the `Icon` suffix, for example `ShieldCheck`. */ icon: string; placement: 'top' | 'bottom'; order: number; }>Array<{ capability: string; sectionId: string; id: string; label: string; url: string; /** * @description * Items with no `order` sort after the ordered items, by title. */ order?: number; page: { kind: 'list' | 'detail'; title: string; columns?: string[]; fields?: string[] }; /** * @description * `true` on one navigation item per promoted capability. Only these * show in the Dashboard navigation as locked items. */ promoted: boolean; }>Array<{ capability: string; pageId: string; blockId: string; column: 'main' | 'side'; position?: { blockId: string; order: 'before' | 'after' | 'replace' }; title: string; }>Array<{ capability: string; pageId: string; label: string }>DashboardPromotionCapabilityV1[]The copy for each capability that a nav item, page block or action names.
Returns true when value has all required fields of DashboardPromotionV1.
The snapshot generator does not use a payload that fails this check.
Parameters
unknownArchitecture reviews, custom plugin work, migrations, ongoing support. Get a hand from the team that builds Vendure.
Talk to the team