Antylogic
DemoApp login

399 operational guides

Docs sections
DocsTPV setup
Device

How to manage virtual brands

List, create and edit the virtual brand identities available to a location TPV: name, code, logos, cover image and colour palette.

In this article

Virtual brands hold the visual identity that a location can reuse in TPV setup: brand name, generated or typed code, favicon, square logo, wide logos, cover image and colour palette.

In the GB demo, use Harbor Demo Group and Harbor Soho. The flow is location-scoped, so brands from the organisation scope or another location are not mixed into this list.

Before you start

  • Sign in to Antylogic with an active session.
  • Select Harbor Demo Group and the Harbor Soho location, or another organisation and location with TPV setup access.
  • Use an account with `brand:view` or `brand:manage` to view virtual brands. Use `brand:manage` to create or edit them.
  • For editing, start from an existing `virtual_brand.id` in the active location.
  • Make sure file storage is configured before uploading favicon, logo or cover image files.

Instructions

  1. 1.

    Open the virtual brands list

    Go to `${APP_DEEPLINK_BASE}${ORG_ID}/${LOCATION_ID}/location/brands`. The page loads the virtual brands for the active location and shows the available actions for the current permissions.

  2. 2.

    Review the current identities

    Use the list to check each brand name, code and visual identity indicators before changing anything. In the Harbor Soho demo, the seed can include a brand derived from the Soho Menu catalogue.

  3. 3.

    Create a new brand

    Select `New brand`, enter the brand name, add image assets if needed and set the colour palette. If the active build exposes the code field, leave it blank to derive it from the name or enter a stable slug.

  4. 4.

    Add logos and colours

    Upload only the assets the brand needs: favicon, square logo, black-and-white logo, colour logo and cover image. If an image does not match the expected shape, use the crop assistant before uploading.

  5. 5.

    Edit an existing brand

    Open a brand row or its edit action. The editor loads the record for the active location and saves changes back to that same location scope.

  6. 6.

    Save and verify the result

    After saving, return to the virtual brands list and confirm that the brand appears with the expected name, code and identity indicators.

Validations and limits

  • The active organisation and location must be present before the list loads.
  • Users with `brand:view` can review the list; `brand:manage` is required to create or edit brands.
  • `name` is required before a brand can be saved.
  • `code` is normalised to a lowercase slug with hyphens. On creation, a blank code is derived from `name` when possible.
  • Non-empty colour values must be valid 6-digit hex colours before the UI allows saving.
  • Favicon and square logo expect a 1:1 ratio; colour and black-and-white logos expect 16:5; cover image expects 3:1.
  • The save action is disabled while submitting, in read-only mode, when there are no changes or when the setup guide is incomplete.
  • Virtual brands are scope-specific: a location brand is not edited from the organisation scope, and an organisation brand is not edited from a location scope.
  • Creating or editing a virtual brand does not select it as the active TPV brand.

Expected result

The saved virtual brand is available in the location list with its name, code and visual identity indicators; list and detail data are refreshed after successful creation or edit.

Related articles