Skip to content

Custom Field Names

Connect for Commerce saves information about a product, category or shop-driven content page in FirstSpirit formData. The default field names id and type are very commonly used variable names. Connect for Commerce allows these form field names to be customized.

Frontend API Server: Configuration

The Frontend API Server package has to be configured.

The required configuration is located inside the core.project.fields configuration object as follows:

# ...
core:
  # ...
  project:
    # ...
    fields:
      # Name of the field for storing the ShopID
      id: _Identifier123

      # Name of the field for storing the type of page represented in a FirstSpirit page.
      type: _PageType123

Additional steps

  1. Update fcecom-frontend-api-server to the latest version, at least to v1.5.0.
  2. Refer to Connect for Commerce documentation to read all about needed FirstSpirit-related updates.

Troubleshooting

Which version of the Frontend API is compatible with custom field names?

You have to use at least v1.5.0 of the Frontend API to use this feature.


Last update: March 20, 2025