How to create an allergen
Create a custom allergen for Harbor Soho or Harbor Demo Group so it can later be attached to products and shown consistently in the catalogue taxonomy.
In this article
Use this guide when a catalogue operator needs to add an allergen that is not already available in the selected scope.
The form creates the allergen record only. Product links are managed later from the product configuration flow.
Before you start
- You are signed in to Harbor Demo Group.
- For location-level creation, Harbor Soho is selected as the active location.
- You have catalog:manage permission in the organisation or location where the allergen will be created.
- An image file is only needed if you want to add an optional allergen image.
Instructions
- 1.
Open the Allergens tab
In catalogue management, open the Allergens tab for Harbor Soho. Use the list to review existing allergens before creating a new location-level record.
- 2.
Start a new allergen
Select Create Allergen. The app opens a blank allergen form because the route does not include an allergen id.
- 3.
Fill in the allergen details
Enter the allergen name, add an optional description, keep or change the default colour, and optionally upload one image. The image is only a visual aid and is not required.
- 4.
Save the allergen
Submit the form with Create Allergen. The app saves the record in the current route scope: Harbor Soho for the location form or Harbor Demo Group for the organisation form.
- 5.
Confirm the refreshed list
After a successful save, the app shows a success notification, refreshes the allergens list, and returns to the resource tab so you can find the new allergen.
Validations and limits
- Name is required and cannot be blank after spaces are trimmed.
- Colour is required in the current form and defaults to #98A2B3, although the backend and database can accept an empty or null value.
- Create Allergen is disabled until the form has changes, required fields are valid, and no submission is already in progress.
- Duplicate allergen names are not allowed within the same organisation scope or location scope.
- Only one optional image can be selected, and the selector is limited to image files.
- If image upload fails, the form stays open and the allergen is not created until the operator submits successfully.
- The backend checks catalog:manage again before creating the record.
- Creating an allergen does not link it to products; product links are managed later.
Expected result
The custom allergen is saved in the selected scope, the allergens list is refreshed, and the record is available for later product configuration.