Open sourceActive

Vendure Core

Vendure Core: Getting Started Guides Reference Plugins Community How to use Search docs...

Open source page

Field note

What it does

title: 'Custom Fields' metaTitle: "Adding Custom Fields to Vendure Entities" metaDescription: "Extend Vendure entities like Product, Customer, and Order with custom data fields. Covers field types, validation, UI configuration, and relational fields." order: 3 Custom fields allow you to add your own custom data properties to almost every Vendure entity. The entities which may have custom fields defined are listed in the CustomFields interface documentation. Some use-cases for custom fields include: Storing the weight, dimensions or other product-specific data on the ProductVariant entity. Storing additional product codes on the ProductVariant entity such as ISBN or GTIN. Adding a downloadable flag to the Product entity to indicate whether the product is a digital download. Storing an external identifier (e.g. from a payment provider) on the Customer entity.

Capabilities

Available capabilities

Tags

Tags

No tags filed yet.

Ways to use it

Ways to use it

No integrations filed yet.

Product features

Product features

Accessing custom fields in TypeScript

Available custom field types

Common properties

Custom field config properties

Defining custom fields

description

label

list

name

public

Relations

type