Create catalogue
Create a location or organisation catalogue, add the products it should contain, and control the order in which product types appear.
In this article
Catalogues turn the product setup for a restaurant location into the menus operators can use day to day. In the Harbor Soho demo, this means creating focused catalogues from the Catalogues tab, then choosing products such as Fish and chips, Beef pie, Sticky toffee pudding or Lemon posset.
The main documented path is location-scoped because Default catalogues are only valid for locations. Organisation catalogues use the same creation surface, but the save is rejected if Default is enabled there.
Before you start
- You are signed in to `/api/app` and working in the correct organisation context; location creation also needs an active `locationId`.
- Your role has `catalog:manage` in the scope where the catalogue will be created.
- Products and product types already exist if the catalogue should contain products or show a product type order.
- File upload is available if the operator needs to attach a catalogue image.
Instructions
- 1.
Open the Catalogues tab
For the Harbor Soho location path, open `/location/catalogs?tab=catalogs`. Organisation catalogues start from `/organization/catalogs?tab=catalogs`. The Create Catalogue action appears in the list header only when the user can manage catalogues.
- 2.
Start a new catalogue
Select Create Catalogue. The item screen opens in create mode with an empty name, Default switched off and no products selected. Opening from the list clears copy state, so this is a normal new catalogue.
- 3.
Enter basic details
Add the required catalogue name. At location level, decide whether it should be the Default catalogue. The image control is optional; when used, the file is uploaded first and the returned file reference is saved with the catalogue.
- 4.
Select products
Choose the products that should appear in the catalogue. For Harbor Soho, use products from the same location scope, such as Fish and chips, Beef pie, Sticky toffee pudding or Lemon posset. The app recalculates product types from the selected products.
- 5.
Review product type order
Use Product type order to arrange the product groups shown by the catalogue. If no products are selected, the section remains empty and prompts the operator to select products first.
- 6.
Save the catalogue
Save once the form has a valid name and at least one change. The app creates a location catalogue with `POST /api/app/{orgId}/{locationId}/catalogs` or an organisation catalogue with `POST /api/app/{orgId}/catalogs`, then returns to the Catalogues tab after success.
Validations and limits
- Name is required; leading and trailing spaces are ignored when the form and backend validate it.
- Save is disabled while the form is unchanged, invalid or already submitting.
- Location creation requires both `orgId` and `locationId`; organisation creation requires `orgId`.
- Default catalogues are valid for locations only. If Default is enabled in organisation scope, the backend rejects the save.
- A catalogue can be saved with no products; the app sends empty product and product type lists.
- Selected products and product types must belong to the exact same scope as the catalogue being created.
- Only product types represented by selected products are persisted in the catalogue order; missing selected types are added after the ordered types.
- Catalogue names must be unique within the same organisation or location.
- If an image upload fails, the catalogue is not submitted with that image reference.
Expected result
The catalogue is created in the current scope, optional product and product type order rows are persisted, and the operator returns to the Catalogues tab with the new catalogue available for Harbor Soho or the selected organisation.