Functionality Guide

Overview

What the portal is, how users enter it, and what the main journey looks like.

Purpose of the portal

The Uptown Med Spa Franchise Ordering Portal is a private, invite-only ordering and operations system. Franchise locations use it to browse the approved catalog, build carts, submit orders, pay by e-transfer, track status, and message Uptown Corporate.

Corporate uses the admin side to review orders, request information, accept orders, confirm payments, move orders to In Transit and Delivered, manage catalog products, manage users and locations, view reports, and maintain audit history.

Simple mental model

  • Franchise side: order products and communicate with Corporate.
  • Admin side: review, control, and report on all franchise activity.
  • Location-based access: franchise users only see their assigned location.
  • Backend authority: final pricing, tax, totals and permission checks are calculated and verified server-side.
PIN Gate Portal PIN entry screen

The PIN screen is the first access gate before user login. It protects the portal URL but does not replace individual user login.

Public Landing Page Entry page with Franchise Access and Corporate Admin paths

The landing page separates Franchise Access from Corporate Admin so each user enters the correct portal path.

Functionality Guide

Access & Roles

How user permissions work and why each role sees different data.

Two gates before the app

  1. Portal PIN gate: a shared access code managed by Super Admin. It protects entry to the portal URL.
  2. Individual user login: Base44 authentication plus portal profile checks for role, account status, and location assignment.

The PIN is not the same as a user password. After entering the PIN, the user still needs to log in with their own account.

RoleWho it is forMain accessImportant limitation
Franchise OwnerLocation owner/managerOwn location orders, cart, messages, team invitesCannot change order status or access admin pages
Franchise TeamStaff at a franchise locationSame location orders/messages and ordering flowCannot invite users or manage location/team settings
AdminCorporate operationsOrders, catalog, locations, users, reports, messagesCannot manage PIN settings or Super Admin accounts
Super AdminHighest corporate accessEverything Admin can do plus PIN and admin-level managementProtected from self-lockout rules
Location rule: franchise users see data for their assigned location only. Corporate users see all locations.
Functionality Guide

Franchise User Walkthrough

The day-to-day ordering journey from dashboard to order detail.

1Dashboard
2Catalog
3Cart
4Submit Order
5Track Status
Franchise Dashboard Franchise home view with recent orders and quick actions

The dashboard gives franchise users quick access to recent orders, order history and the catalog.

Franchise Catalog Product catalog with search, filters, stock status, MOQ and add-to-cart controls

The catalog shows only Active products. Quantity controls follow MOQ, stock quantity and order increment rules.

Cart Review Cart with quantities, line totals, tax, notes, urgent flag and continue to review

The cart explains quantity × unit price, calculates tax based on the location, and lets users add notes or mark an urgent order.

Franchise Order Detail Franchise order tracking with progress, guidance, items and totals

After submitting, franchise users can track progress, view totals, read next-step guidance, respond to queries, and see tracking if entered.

Functionality Guide

Order Workflow

How an order moves through review, payment, transit and delivery.

Pending ReviewFranchise submitted order; Corporate reviews it.
Needs InformationCorporate asks a question; franchise responds on order detail.
Accepted — Awaiting E-transferOrder is accepted; franchise sends payment.
Payment ReceivedCorporate confirms e-transfer manually.
In TransitOrder is being shipped or prepared for delivery.
DeliveredOrder is complete.

What is important to understand

Franchise users do not directly change order status. Corporate controls the workflow. Payment proof or a reference number does not automatically confirm payment; Corporate must verify the e-transfer before the order moves forward.

The order detail page preserves item snapshots, subtotal, tax, total, status history and timeline so old orders remain understandable even if product prices or tax settings change later.

Functionality Guide

Corporate Admin Walkthrough

How Corporate reviews orders and manages the network.

Corporate Dashboard Network-wide dashboard for pending orders, products and locations

The Corporate Dashboard summarizes pending orders, urgent orders, active products and active locations.

Admin Orders List Corporate order management list with search, filters and status badges

The order list lets Corporate search by location/order number and filter by status before opening an order for review.

Admin Order Detail Admin review screen with order actions, payment, status override and timeline

The admin detail page is the main action screen: accept, query, reject, cancel, confirm payment, override status and review timeline.

Team & Users Corporate user management with roles, account status and invite controls

The Team & Users page manages account status, roles, locations and user invitations.

Functionality Guide

Catalog, Inventory & Locations

How products, stock quantity, product lifecycle and location tax settings work.

Catalog Management Admin product list with active/inactive/archive controls

Admin catalog management keeps product visibility controlled through Active, Inactive and Archived states.

Edit Product Modal Product editing modal with MOQ, stock quantity, status and image options

The product form controls MOQ, optional stock quantity, stock status, catalog status, price and image upload.

Locations Franchise locations and tax settings overview

Locations define franchise identity and tax settings. Tax is based on the order location and saved on the order at creation time.

Product lifecycle

StatusMeaningFranchise visibility
ActiveVisible and orderableShown in catalog
InactiveTemporarily hidden but editableHidden
ArchivedRetired/historical productHidden unless admin views archived filter
DeletedPermanent removal for mistakes/test recordsRemoved
Functionality Guide

Payments, Tax & Totals

How totals are calculated and how payment moves the order forward.

Tax and total calculation

Cart totals are previews, but the backend is the final source of truth. When an order is submitted, the backend fetches the real product prices and the authoritative location tax settings, then calculates:

line total = quantity × unit price
subtotal = sum of line totals
tax = subtotal × location tax rate
total = subtotal + tax

These values are saved on the order so historical orders do not change if product pricing or tax rates change later.

E-transfer payment

Once an order is accepted, it moves to Accepted — Awaiting E-transfer. The franchise sends the payment using the order number as the reference. Corporate manually verifies the e-transfer and marks Payment Received. The order does not move to In Transit until payment is confirmed.

Functionality Guide

Messages & Notifications

Location-based conversations and per-user unread state.

Messages Location-based messaging thread between franchise and corporate users

Messages are shared at the location level. Franchise users at the same location see the same threads, while Corporate sees all locations.

Unread messages

Unread counts are per individual user, not shared by location. If one franchise team member opens a thread, that thread is marked as read only for that person. Other team members still see it unread until they open it.

Email notifications are sent for important order, message, invite and user events. Sending failures do not stop the actual portal action from being saved.

Functionality Guide

Reports & Security

Corporate reporting plus the most sensitive system settings.

Analytics & Reports Corporate reports with date filters, KPI cards and charts

Reports summarize spend, orders, locations, top products and status breakdown by preset or custom date range.

PIN Settings Super Admin PIN gate management screen

PIN Settings is Super Admin only. The PIN is hidden by default and reveal/update actions are protected server-side.

Security summary

  • PIN protects portal entry, but user login and role checks enforce real access.
  • Franchise users are restricted to their assigned location.
  • Backend functions re-check role/account status before sensitive actions.
  • Order totals and tax are recalculated on the backend.
  • Audit logs record important user, order, payment, tracking and PIN events.
Functionality Guide

Quick Reference

Short operating summary by user type.

Franchise Owner

Enter PIN, sign in, browse catalog, submit orders, track status, send messages, and invite Franchise Team members.

Franchise Team

Enter PIN, sign in, browse catalog, submit orders, view shared location orders/messages, and respond where allowed.

Admin

Review orders, request clarification, accept orders, confirm payment, move orders to In Transit and Delivered, and manage catalog, users, locations and reports.

Super Admin

Everything Admin can do, plus PIN settings, Admin/Super Admin management, and highest-level account safeguards.