CustomFields
CustomFields
Most entities can have additional fields added to them by defining an array of CustomFieldConfig objects on against the corresponding key.
Example
bootstrap({
// ...
customFields: {
Product: [
{ name: 'infoUrl', type: 'string' },
{ name: 'downloadable', type: 'boolean', defaultValue: false },
{ name: 'shortName', type: 'localeString' },
],
User: [
{ name: 'socialLoginToken', type: 'string', public: false },
],
},
})
Signature
interface CustomFields {
Address?: CustomFieldConfig[];
Administrator?: CustomFieldConfig[];
Asset?: CustomFieldConfig[];
Channel?: CustomFieldConfig[];
Collection?: CustomFieldConfig[];
Customer?: CustomFieldConfig[];
CustomerGroup?: CustomFieldConfig[];
Facet?: CustomFieldConfig[];
FacetValue?: CustomFieldConfig[];
Fulfillment?: CustomFieldConfig[];
GlobalSettings?: CustomFieldConfig[];
Order?: CustomFieldConfig[];
OrderLine?: CustomFieldConfig[];
PaymentMethod?: CustomFieldConfig[];
Product?: CustomFieldConfig[];
ProductOption?: CustomFieldConfig[];
ProductOptionGroup?: CustomFieldConfig[];
ProductVariant?: CustomFieldConfig[];
Promotion?: CustomFieldConfig[];
Region?: CustomFieldConfig[];
Seller?: CustomFieldConfig[];
ShippingMethod?: CustomFieldConfig[];
StockLocation?: CustomFieldConfig[];
TaxCategory?: CustomFieldConfig[];
TaxRate?: CustomFieldConfig[];
User?: CustomFieldConfig[];
Zone?: CustomFieldConfig[];
}
Address
property
Administrator
property
Asset
property
Channel
property
Collection
property
Customer
property
CustomerGroup
property
Facet
property
FacetValue
property
Fulfillment
property
GlobalSettings
property
Order
property
OrderLine
property
PaymentMethod
property
Product
property
ProductOption
property
ProductOptionGroup
property
ProductVariant
property
Promotion
property
Region
property
Seller
property
ShippingMethod
property
StockLocation
property
TaxCategory
property
TaxRate
property
User
property
Zone
property