User Guide & Documentation
Visit the login page and click "Create Account". Enter your full name, email address, business name, and a strong password (minimum 6 characters). You can also sign up instantly using your Google account by clicking "Continue with Google". After registration, you will be redirected to your personalised business dashboard.
Use your email and password to log in, or click the Google button for SSO. If you are a Super Admin, you will be automatically redirected to the Admin Panel. Other users land on the main Dashboard.
Your dashboard shows a real-time snapshot of your business: total orders, today's revenue, monthly revenue, active products, and customer count. Below the stats you will find a revenue chart for the past 7 days, recent orders, and low-stock alerts. Quick action buttons let you jump to key tasks like adding a product or viewing orders.
Navigate to Products from the sidebar. You'll see a searchable, filterable list of all your products with stock status indicators. Click "Add Product" to create a new item — fill in the name, description, price, cost price, SKU, stock quantity, and assign a category. Every product can be toggled active/inactive and featured/unfeatured. Click any product row to edit its details.
Go to Categories in the sidebar. Here you can create, edit, and delete product categories. Categories help organise your catalog and make it easier for customers to browse. You can also add categories inline when creating a new product by clicking the "+" button next to the category dropdown. Deleting a category that has products assigned is blocked with a warning.
Each product has a "Low Stock Threshold" field. When stock drops to or below this number, the product will appear in your dashboard alerts and in the notification bell. This helps you restock before running out.
The Orders page shows all orders in a tabular format with order number, customer name, status, payment status, total amount, and date. Use the search bar and status filter to narrow results. Click any order to view its full details.
Orders move through these stages: Pending → Confirmed → Processing → Ready for Pickup / Out for Delivery → Delivered → Completed. You can also Cancel or Refund orders. From the order detail page, use the status dropdown to advance an order through each stage. Each status change is timestamped for audit purposes.
The detail page shows the complete order: line items with quantities and prices, customer contact information, delivery address, payment status, and a timeline of status changes. You can update the status directly from this page.
The Customers page displays all your customers with name, phone, email, total orders, and lifetime value. Click any customer to see their detailed profile.
Each customer detail page shows their contact information, business metrics (total orders, average order value, lifetime value), assigned tags, and an activity timeline showing all their interactions — orders placed, conversations, and tag changes.
Add tags to customers (e.g., "VIP", "Wholesale", "New") to categorise them. The system also performs automatic RFM (Recency, Frequency, Monetary) segmentation to classify customers as VIP, Active, At Risk, New, or Dormant — helping you target the right groups with marketing campaigns.
View all payment transactions with summary cards for total, successful, and pending payments. Filter by status and payment gateway (Paystack or Flutterwave).
SHOPYSH supports Paystack and Flutterwave for accepting payments. Configure your API keys in the environment settings. The system handles payment initialization, verification, and webhook processing automatically. A demo mode is available when API keys are not configured.
The Conversations page shows all customer interactions via the chat widget. Each conversation displays the customer name, last message, status (active/closed), and intent detected by the AI. Escalated conversations are flagged for human attention.
Test your AI assistant from the AI Assistant page. Type messages to see how the AI responds to customer inquiries about products, pricing, and orders. The AI is context-aware — it knows your product catalog, pricing, and business information. It supports Nigerian English and Pidgin.
Go to Chat Widget in the sidebar to get your embeddable chat widget code. Simply copy the script tag and paste it into your website. The widget connects customers directly to your AI assistant — no API keys or complex setup required.
Navigate to Campaigns from the sidebar. Click "Create Campaign" to set up a new broadcast message. Enter a campaign name, the message template, and optionally target a specific customer segment (e.g., VIP, Active, New). Campaigns start in "Draft" status.
From the campaigns list, click the send button on a draft campaign to dispatch it. The system will send messages to targeted customers and track delivery stats (sent, delivered, failed counts).
The Analytics page provides a comprehensive view of your business performance. View revenue, orders, customer metrics, AI conversation metrics, and more. Filter by time period (7, 30, or 90 days). Charts visualise trends over time.
Go to Reports in the sidebar to download CSV exports of your business data. Available reports include: Orders Report (with customer details and line items), Product Inventory (pricing and stock levels), Customer Database (contact info and lifetime value), and Payment Transactions. Use the optional date range filter for time-bound exports.
As an Admin, go to Team in the sidebar. Click "Add Member" to invite colleagues. Enter their name, email, a temporary password, and assign a role: Staff (view/manage daily tasks) or Manager (full access except billing). Team members log in with the credentials you create for them.
From the team list, use the action menu (three dots) on any staff or manager to: promote/demote their role, activate/deactivate their account, or remove them entirely. Admins cannot be modified by other admins for security.
Update your business name, email, phone, description, address, city, and country. This information is used across the platform and in customer-facing communications.
Customise your AI assistant's welcome message, personality/tone, and toggle auto-reply on or off. The AI adapts to your preferences to match your brand voice.
View your current subscription plan (Starter, Business, or Premium), usage statistics for the current month, and available plans for upgrade. Plans differ in AI conversation limits, product limits, user seats, and advanced features like API access.
Super Admin users see an "Admin Panel" link in the sidebar. The panel shows platform-wide statistics: total companies, users, revenue, and active tenant rates. Below is a searchable table of all registered tenants/companies with the ability to activate or deactivate any business.
Search for any business by name. Use the toggle switches to activate or deactivate tenant accounts. Deactivated tenants cannot log in until reactivated.
SHOPYSH is a modern web application with a multi-tenant architecture. Each business gets isolated data storage while sharing the same application infrastructure. The platform uses server-side rendering for fast page loads, JWT-based authentication, and real-time notifications.
All data is accessed through RESTful API routes: /api/products, /api/orders, /api/customers, /api/payments, /api/campaigns, /api/analytics, /api/team, /api/reports/export, /api/notifications, /api/settings/*, /api/admin/*. All endpoints require authentication via session cookies. Admin endpoints require SUPER_ADMIN or TENANT_ADMIN roles.
The platform supports email/password login and Google Single Sign-On (SSO). Sessions are maintained via secure JWT tokens with 7-day expiry. Passwords are hashed with bcrypt. Multi-tenant isolation is enforced at the API layer — every query is scoped to the authenticated user's tenant.
Payment notifications are received at /api/payments/webhook/paystack and /api/payments/webhook/flutterwave. Both endpoints verify webhook signatures for security. Paystack uses HMAC-SHA512 signature verification, while Flutterwave uses a shared webhook hash.
The embeddable chat widget is available at /api/widget/[tenantId]/config. Tenants can embed the widget on their website with a single script tag. Incoming messages are processed through the AI assistant, which uses the business's product catalog and settings to generate contextual responses.
All data is stored in a secure database with row-level tenant isolation. Sensitive fields (passwords, tokens) are encrypted. API routes enforce role-based access control. CSRF protection is built-in via NextAuth. Session cookies are HttpOnly and Secure in production.
SHOPYSH User Guide • Last updated: May 2026
For support, contact your platform administrator.