PeakPOS Documentation

website·Indexed 31 days ago

https://docs.peakpos.co

Help center for the PeakPOS Merchant Portal, providing guides on store setup, catalog and inventory management, sales and payments, staff access, terminal fleet review, and virtual terminal workflows.

Tokens
20.9K
Snippets
27
Records
123
Agent score
53%

What's inside PeakPOS

  1. Understand Store Operations page scopes and access

    The Store Operations section contains pages used for day-to-day sales, payments, customers, devices, and store-team management. Most pages are 'Store-scoped', meaning they show records only for the currently selected store in the portal.

    Two specific pages are 'Organization-scoped' and apply across the entire organization:

    1. Households: Manages customer relationships across the organization.
    2. Document Builder: Manages reusable document layouts shared by the organization.

    Visibility of pages is determined by the features enabled for the organization and the user's role permissions. Note that being able to open a page does not automatically grant permission to perform all actions (such as write or administrator actions) within that page.

  2. Navigate the Staff & Access workspace

    The Staff & Access workspace is used to manage personnel and their system permissions. It is organized into four primary tabs:

    • People: Manage organization and store membership, invitations, job-function assignments, additional access, and restrictions.
    • Job Functions: Manage named sets of responsibilities and their organization or store scope.
    • Store Policies: Manage store access policies.
    • Access Review: A read-only summary of a person's assigned job functions, scopes, and assignment status.
  3. Review organization overview and legal information

    The Overview page provides a rollup of Locations, Total Staff, Org Revenue, Org Members, and Subscription Tier. Use the Refresh button to update data.

    The Organization page allows review of the legal profile used on invoices and receipts, including Legal name, Default currency, EIN, Tax ID, Email, Phone, and Website, as well as legal/billing addresses.

    Note: These pages are summaries. To change organization settings, legal profiles, or billing locations, you must contact Peak Support.

  4. Operate the front-desk arrival board

    Navigate to Shifts > Check-ins to manage today's arrivals for the selected store.

    1. Find Bookings: Use the search bar to find guests by name, phone, or email.
    2. Awaiting Check-in: For confirmed guests arriving today, select Check in or No-show.
    3. Checked in: Once the service is finished, select Complete, or select No-show if applicable.

    Access Requirements: Appointment read access is required to view the board; 'Check-in write' or 'Check-in administrator' access is required to change statuses.

  5. Search the SMS Consent ledger

    Search for specific phone-number consent records for the selected store. While the ledger is store-specific, marketing delivery checks consent across the entire organization.
    1. Go to Settings > SMS Consent.
    2. Enter a phone number in the search field and select Search.
    3. Review the status and method of consent.
    4. Select the result or View History to see the audit trail of who recorded or revoked consent.
  6. Impersonate a job function to test portal access

    Organization administrators can use the View as job function feature to verify what a specific role can see and do. This is not a read-only simulation; actions performed while impersonating will be executed with that role's permissions.

    Steps to impersonate:

    1. Navigate to Staff & Access > Job Functions.
    2. If using a store-scoped function, select the specific store first. Organization-scoped functions start at the organization level.
    3. Select View as job function.
    4. Once the portal reloads, use the impersonation banner to identify the active role and to exit the session.

    Warning: Use approved test data when checking write operations. Do not share logins between staff.

  7. Monitor and review the terminal fleet

    To review registered devices and payment readiness for a selected store, navigate to Store Operations > Terminals. This view requires the store.terminals.read permission. Note that adding, registering, or provisioning terminals must be handled by Peak Support.

    From the Terminals page, you can:

    • View a fleet summary of online, offline, and total devices.
    • Review specific terminal details: name, identifier, status (Online, Offline, or Unknown), model, app version, battery/storage (if reported), and certificate expiration date.
    • Manually update the list using the Refresh button (the list also auto-refreshes every 30 seconds).
    • Open a terminal row to see detailed diagnostics including last-seen time, network information, uptime, memory, and hardware connection status (scanner/card-reader).
  8. Review and correct organization identity

    The organization record is a read-only canonical record containing the legal name, tax IDs, contact details, and bill-from locations used on invoices and receipts.

    To view this record, navigate to Organization $\rightarrow$ Organization. Because the Merchant Portal does not provide an edit path for this record, you must contact Peak Support to correct any errors in the organization identity or primary bill-from location.

  9. Review and accept Online Orders

    Access delivery and takeout platform orders via Store Operations > Online Orders. This is store-scoped and requires store.transactions.read.

    Important Constraints:

    • These orders do not create Peak sales, transactions, KDS tickets, or accounting entries.
    • Uber Eats: Available for approved pilot storefronts. Users with order-write permission can 'Accept' a Received order, which sends acceptance to Uber Eats. Other fulfillment actions must be managed via the provider.
    • DoorDash/Grubhub: Currently deferred and cannot be connected.

    Workflow:

    1. Confirm the selected store.
    2. Filter by Active or History (last 30 days) using status, fulfillment, external order ID, or dates.
    3. Review provider details, customer, external order reference, items, and timestamps.
    4. Select Accept order for eligible orders. If acceptance fails, refresh the order before retrying.
  10. Manage serialized inventory

    Navigate to Catalog & Inventory > Serialized Inventory. This page is scoped to the selected store.

    Creating a Serialized Item: (The product must already be configured to require serial tracking)

    1. Under Create Serialized Item, choose the Product.
    2. Enter the unique Serial Number.
    3. Optionally enter Notes and Required Forms.
    4. Select Create Serial. (Requires serial write access).

    Updating Serial Status:

    1. Use Lookup Serial or select a row from the table to open Serial Detail.
    2. Mark Sold: For available/received serials, enter the Sale transaction ID and select Mark Sold.
    3. Mark Returned: For sold serials that have physically returned, select Mark Returned.

    Note: Serial read access allows lookup/review; serial write access is required for status changes.

  11. Manage organization-wide Households

    Households group customers across the entire organization for shared loyalty balances, shared addresses, and marketing. This is an organization-scoped entry and requires the org.customers.read permission. Changing the selected store does not filter the Households page.

    Household Operations:

    • Review: Access via Store Operations > Households. Review members, combined points, grouping source, and shared addresses.
    • Create: Select 'Create Household'. Requires at least one member or a shared address.
    • Add Member: Search by name, email, phone, or loyalty ID within a household and select 'Add Member'.
    • Remove Member: Select 'Remove' next to a member (this removes the relationship, not the customer record).
    • Combine: Use the combine control to merge one household into another.
    • Split: Enter a new display name and select specific members to move into a new household.