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.

Latest portal updates included in this guide

  • Location minimum order value: each location can have a required cart subtotal before a franchise user can submit an order.
  • Pending order edit: Corporate can edit items, quantities and totals while an order is still Pending Review. Franchise users see an “Order Updated by Corporate” notice and receive an email when real item or total changes are made.
  • Additional charges: after payment is received or while an order is In Transit, Corporate can add a separate extra charge without modifying the original order subtotal, tax or total.
  • Shared location cart: Franchise Owner and Franchise Team users at the same location share one cart.
  • Tracking and notifications: tracking can be added, updated or cleared by Corporate; new order and payment-related email notification paths have been updated.
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

Current franchise ordering behavior

  • Shared cart by location: Franchise Owner and Franchise Team users assigned to the same location see the same cart. When one user updates it, the other user sees the updated cart after refresh. The cart clears after a successful order submission.
  • Minimum order value: if Corporate sets a minimum order value for the location, the cart shows the required amount, current subtotal and how much more must be added. Orders cannot be submitted below the required subtotal.
  • Order updated by Corporate: if Corporate edits a Pending Review order before accepting it, the franchise user sees an update notice on the order page and receives an email with the change details.
  • Additional payment required: if Corporate adds a separate additional charge later, franchise users see a dedicated additional payment section with the amount, reason and proof-upload option.
  • Tracking: tracking details only appear when Corporate adds them. If Corporate clears tracking, it should no longer appear on the franchise order page.
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.

Pending Review edits: while an order is still Pending Review, Admin/Super Admin users can edit order items, quantities and totals. If real item or total changes are saved, the franchise side sees an Order Updated by Corporate notice and receives an email. Once the order is accepted or moved forward, the original order is no longer editable.

Additional charges: after payment has been received or while an order is In Transit, Corporate can add a separate extra charge, such as a shipping adjustment. This does not modify the original order items, subtotal, tax or total.

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.

Shipment Tracking (Franchise View)Tracking display on the franchise order detail page

Once tracking is saved, the franchise order detail page displays the tracking section with the current status and a direct Track Shipment button.

Functionality Guide

Corporate Admin Walkthrough

How Corporate reviews orders and manages the network.

New admin order controls

  • Edit Pending Review orders: Corporate can update items, quantities and totals only while an order is Pending Review. Franchise users are notified and shown what changed.
  • Additional Charge: Corporate can add a separate extra charge after payment is received or while the order is In Transit. This is used for adjustments such as extra shipping and does not change the original order total.
  • Tracking: Admins can save carrier, tracking number and tracking URL. Tracking URLs should be stored with a valid https:// link, and cleared tracking should disappear from the franchise side.
  • Notification Settings: Super Admin can control new-order notification settings. Active Admin/Super Admin users receive new-order emails unless excluded, and extra recipients can be added if supported.
Edit Pending Review OrderCorporate item and quantity editing modal

Corporate can edit items, quantities and recalculated totals while an order is still in Pending Review. Internal notes can also be recorded for the edit.

Shipment Tracking (Admin View)Corporate tracking save form

Corporate can save a tracking number alone, add carrier and tracking URL, or clear the fields to remove tracking from the franchise view.

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.

Location minimum order value

Minimum Order Value is managed on each location, not in the product catalog. Open a location record and set the minimum dollar amount required before that location can submit an order.

  • Product MOQ: minimum quantity for a specific product.
  • Minimum Order Value: minimum cart subtotal, before tax, required for a location to submit an order.
  • If the location minimum is disabled or set to zero, no minimum cart value restriction applies.
Minimum Order Value and Cart EnforcementFranchise cart below the required minimum

This screenshot documents the minimum order value feature from the franchise side. It shows the below-minimum warning, the remaining amount needed, and the disabled Continue to Review button in one view.

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 and contact email

Once an order is accepted, it moves to Accepted — Awaiting E-transfer. The franchise sends payment to skinbyuptown@gmail.com using the order number as the reference. This same email is used for order/payment/query contact guidance unless Corporate requests a different address.

Corporate manually verifies the e-transfer and marks Payment Received. The order does not move to In Transit until payment is confirmed.

Additional charges

If a separate cost comes up after payment has been received, such as an extra shipping charge, Corporate can add an Additional Charge. The franchise sees a separate additional payment request and can upload proof for that extra payment.

Additional charges do not change the original order subtotal, tax or total. They are tracked separately so the original paid order remains clear.

Additional Charges (Admin View)Separate charge entry form

Use this panel to add a separate charge such as shipping or another post-payment fee. It does not modify the original order total.

Additional Payment Required (Franchise View)Franchise side payment request for a separate extra charge

Franchise users see the extra charge separately from the original order, along with the e-transfer email, payment reference, note field and proof upload button.

Functionality Guide

Messages & Notifications

Location-based conversations and per-user unread state.

Notification behavior

  • New order submitted: Admin/Super Admin recipients are controlled through notification settings. Active corporate users receive emails unless excluded.
  • Payment proof: when franchise users upload or update proof, corporate recipients are notified.
  • Additional charges: franchise users are notified when a charge is added or confirmed; corporate users are notified when proof is uploaded.
  • Pending order edits: franchise users receive an email when Corporate changes items, quantities or totals on a Pending Review order.
  • Messages: unread counts are per user. Opening a thread marks it read only for that user.
Order Updated by Corporate EmailFranchise notification when order contents change

When Corporate changes a Pending Review order, the franchise receives an email that summarizes what changed and links them back to the updated order.

New Order Notification SettingsSuper Admin control over corporate email recipients

Super Admin users can enable or mute new-order email notifications and control which active corporate users receive them.

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.

Reporting and security updates

  • Reports include Total Spend, Orders, Locations, Average Order Value, Location Spend Summary, Most Ordered Products, Order Status Breakdown and Location Spend Trend.
  • Spend totals are based on confirmed/active order stages and exclude Pending Review, Needs Information, Rejected and Cancelled orders.
  • Admins cannot invite other corporate Admin/Super Admin users. Corporate admin creation is reserved for Super Admin.
  • Super Admin can manage PIN settings and notification settings. Franchise help should not expose internal notification routing or admin-only 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, use the shared location cart, submit orders, review corporate edits, upload payment proof, respond to queries, view additional charges/tracking, send messages, and invite Franchise Team members.

Franchise Team

Enter PIN, sign in, browse catalog, use the shared location cart, submit orders, view shared location orders/messages, upload proofs where allowed, and respond where allowed.

Admin

Review orders, edit Pending Review orders, request clarification, accept orders, confirm payment, add separate additional charges, manage tracking, move orders to In Transit and Delivered, and manage catalog, franchise users, locations and reports.

Super Admin

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

Screenshots refreshed in this update

The newly added features now have fresh screenshots in this guide. The reports image can remain as the existing one from the previous version.

  • Minimum order value enforcement and below-minimum cart state are now shown together in one franchise review screenshot.
  • Pending Review order edit modal has been added.
  • Order Updated by Corporate email has been added.
  • Additional Charges is shown on both the corporate and franchise sides.
  • New Order Notification Settings has been added.
  • Shipment Tracking is now shown on both the corporate and franchise sides.
  • Reports can continue using the older screenshot already in the guide.