List allergens
Review the allergens visible to Harbor Demo Group or Harbor Soho from the Catalogs screen. The Allergens tab shows each allergen with its colour marker, description and owner, and supports UI search, paging, refresh and row actions based on catalogue permissions.
In this article
Use the Allergens tab when catalogue teams need to check which allergen records are available before maintaining products or menus.
The list can be opened at organisation scope or location scope. Location scope can include system, organisation and Harbor Soho allergens; organisation scope can include system and Harbor Demo Group allergens.
Before you start
- An organisation must be selected. Location scope also requires a selected location such as Harbor Soho.
- Open the Catalogs screen with tab=allergens. If the tab value is missing or invalid, the app falls back to the Catalogs tab.
- The user needs catalogue read access in the active scope. Catalogue manage access only adds create, edit and delete controls.
Instructions
- 1.
Open the Allergens tab
Open /location/catalogs?tab=allergens for Harbor Soho or /organization/catalogs?tab=allergens for Harbor Demo Group. Confirm the Catalogs screen is open and the Allergens tab is selected.
- 2.
Review the table
Read the Name, Description and Owner columns. The Name cell includes the colour indicator and optional image. Owner identifies whether the record belongs to System, the organisation or the location.
- 3.
Search by name
Use Search by name to filter the visible rows. The route stores this as allergens_query, but filtering happens in the current UI against the localized allergen name, not in the backend list endpoint.
- 4.
Use paging and refresh
Move through pages when the visible allergen list spans more than one page. Invalid allergens_page values are treated as page 1 and clamped to the available page count. Refresh reloads the allergen query for the active scope.
- 5.
Open row actions
Open a row or its menu to view available actions. System allergens are view-only. Scope-owned rows can show Edit or Delete only when the user has catalogue manage access. Allergens do not offer Copy.
Validations and limits
- Without the required organisation, or without a location in location scope, the screen shows the not-found state.
- Without catalogue view or manage access, the page shows the no-access message and does not run the list query.
- The backend also checks catalog:view before returning allergens and filters each result by readable scope.
- Search and pagination are UI behaviour; GET /allergens does not consume allergens_query or allergens_page.
Expected result
The operator can see the allergens available in the active catalogue scope, understand who owns each record, search the visible list, refresh it and open permitted row actions without changing allergen data.