DOCSEARCHbyAlgolia
Submit Docs

X1 POS Documentation

website·Indexed 31 days ago

https://docs.x1.tech

Technical documentation for X1 POS, including X1 HQ for administrative settings, menu catalog management, online ordering configuration, and sales reporting. Covers POS Client terminal settings, device management, and MCP-capable AI assistant integration for ChatGPT, Cursor, and Claude.

Tokens
54.2K
Snippets
80
Records
480
Agent score
52%

What's inside X1

  1. Overview of Smart Categories

    Smart Categories allow administrators to create flexible category groupings for POS or online ordering displays without rebuilding the base category structure. They are used to manage item relationships, shop display settings, and order-channel settings.

  2. Overview of Meal Sets for combo selection flows

    Meal Sets are used to create grouped item choices for combo-style selling flows. Use this feature when a parent item should force or allow a customer to choose from specific item groups, such as selecting one main, one side, and one drink. Meal set groups must be linked back to a parent set item in the Menu Items section to function.

  3. Overview of the Online Ordering module

    The Online Ordering module manages how the POS Menu catalog is projected to customer-facing digital channels, including BYOD (Bring Your Own Device) QR Code ordering, native Mobile Apps, and third-party API aggregators. Instead of maintaining a separate database, it syncs with the core Menu Catalog, enabling administrators to selectively publish items, apply specific pricing tiers, and override translations for the digital storefront.

  4. Overview of the POS X1 Client app documentation

    This documentation covers the POS X1 Client app used by store teams, specifically focusing on cashier and manager operations. The manual is organized into three primary views to assist different user needs:

    1. Use-case view: Step-by-step operation guides for tasks such as starting shifts, sales, checkout, refunds, and day-end processes.
    2. Role view: Guidance on permissions and escalation boundaries between cashiers and managers.
    3. Function view: Individual pages for specific functions for quick lookup.

    For a complete inventory of all available features, refer to the Reference -> Function & Feature Map.

  5. Overview of X1 Function Documentation

    The X1 documentation provides function-specific pages designed for developers or operators who need to perform a single, exact operation quickly. While use-case pages are intended for general training, function pages provide targeted guidance for specific tasks including:

    • Ordering functions: Managing discounts, service charges, table changes, takeaway contact details, order-type switching, splitting/merging orders, member logins, and Octopus settlements.
    • Checkout and completed-order functions: Processing payments, performing voids or returns, reopening orders, and reprinting receipts.
    • Device functions: Configuring printers, payment inputs, and general X1 configuration.
    • More Tools functions: Handling pay-in/pay-out operations and day-end procedures.

  6. Overview of X1 HQ Web Portal

    The X1 HQ web portal is used by owners, back-office admins, setup staff, and managers to maintain store setup, POS behavior, menus, reports, online ordering, integrations, marketplace subscriptions, and billing for one or more shops.

  7. Overview of Insights analysis views

    The Insights page provides five main views for analyzing business performance. All views share the same workspace, brand, shop, and time period filters.

  8. Overview of Menu Management in HQ

    The Menu Management section is the core catalog setup area in HQ. It is used by administrators to create and maintain sellable items, menu structures, and cashier-facing catalog behavior. Key managed entities include categories, smart categories, menu items, POS menus, modifiers, meal sets, and interface button styles.

  9. X1 MCP guided assistant workflow

    X1 MCP transforms HQ administrative work into a structured, safe workflow to prevent accidental misconfiguration:

    1. Inspect: The assistant analyzes the current setup.
    2. Prepare: A proposed change is drafted.
    3. Preview: The assistant shows a 'before and after' comparison of values.
    4. Approval: The assistant waits for explicit user approval.
    5. Apply: The approved change is executed.
    6. Verify: The result is confirmed.

  10. Manage POS users and permissions

    POS Users are the staff accounts used on physical POS terminals. This is distinct from HQ workspace member access. You can manage user groups (reusable role assignments), individual user records, login methods, and account status (active/inactive). To access these settings, navigate to POS Settings -> POS Users.

  11. Manage core business rules via POS Settings

    The POS Settings section in the HQ is used by administrators to configure the main business rules governing POS behavior during service. This includes managing tenders, checkout methods, tax/surcharge logic, reporting groupings (departments), reason lists for high-risk actions, POS user access, and on-premise payment gateway vendor connections.

  12. Select the appropriate Sales Report group

    Sales Reports are organized into four main groups based on the level of detail required:

    • Revenue and trends: High-level performance reviews (e.g., Sales Overview, Sales Summary, Annual Turnover, Hourly Report, Revenue Attainment, Transaction Overview).
    • Breakdown analysis: Slicing performance by business dimensions (e.g., Sales by Item, Sales by Section, Sales by Department, Sales by Discount, Sales by Modifier, Payment Methods).
    • Detailed records: Record-level or audit-style details (e.g., Transaction List, Order Details, Payment Details, Food Cost).
    • Customers and partners: Member or customer-linked analysis (e.g., Members Analysis).