Antylogic
DemoApp login

399 operational guides

Docs sections
DocsCatalogue setup
Device

Create a product specification

Create a reusable product specification for Harbor Soho or the wider Harbor Demo Group, such as “Gluten-free option”, so it can later be selected on product records.

In this article

Specifications are catalogue labels that help operators keep product information consistent. They can describe service or menu attributes and are assigned to products later from the product form.

This guide uses the Harbor Soho location flow. The organisation flow uses the same shared form, but saves the specification at Harbor Demo Group level instead.

Before you start

  • The operator is signed in to Antylogic with Harbor Demo Group selected.
  • For the location flow, Harbor Soho is the active location.
  • The operator can load specifications with `catalog:view` and create them with `catalog:manage`.
  • If an image is needed, upload the file first through the app file upload step; the specification stores only the returned `image_file_id`.

Instructions

  1. 1.

    Open the Specifications tab

    Go to `/location/catalogs?tab=specifications` for Harbor Soho. The list shows existing specifications and the Create Specification action when the operator can manage catalogues.

  2. 2.

    Start a new specification

    Select Create Specification. The app opens `/location/catalogs/specification-item?tab=specifications` in create mode, with Name and Colour required and Description and Image optional.

  3. 3.

    Enter the details

    Add a clear name, for example “Gluten-free option”. Add a short description if it helps the team understand when the label should be used. The colour defaults to `#98A2B3` unless the operator chooses another valid colour.

  4. 4.

    Add an image only when useful

    Use Image only as a supporting reference. Image upload is a separate step through `POST /api/app/files`; the specification can still be created without an image.

  5. 5.

    Save the specification

    Save the form. The location route sends the payload to `POST /api/app/{orgId}/{locationId}/specifications`; the organisation route sends it to `POST /api/app/{orgId}/specifications`.

  6. 6.

    Confirm the refreshed list

    After a successful create, Antylogic returns to the Specifications tab and refreshes the list. Product assignment is separate and happens later from the product form.

Validations and limits

  • Name is required after trimming spaces.
  • Description is trimmed and omitted from the request when left empty.
  • An empty or invalid colour falls back to `#98A2B3` in the frontend.
  • `image_file_id` is omitted when no image was uploaded.
  • Specification names must be unique within the effective organisation or location scope.
  • Create mode is blocked without `catalog:manage`.
  • A location-scoped specification belongs to the location only; an organisation-scoped specification belongs to the organisation only.
  • Creating a specification does not assign it to any product.

Expected result

Harbor Soho has a new reusable specification available for later product setup, while product associations remain unchanged until edited from a product.

Related articles