Skip to content

KlCode Admin Documentation Index

Last Updated: 2026-03-02 Purpose: Comprehensive documentation for KlCode admin interface pages


About This Documentation

This documentation serves admin users with step-by-step guides for daily operations.

Each page documentation includes:

  • Feature overview and capabilities
  • Search and filtering options
  • Common workflows and use cases
  • Troubleshooting guidance
  • Best practices

How to Use This Documentation

For Admin Users

  • Find your page in the index below
  • Click to view detailed documentation
  • Use the Quick Reference sections for fast answers
  • Check Common Use Cases for step-by-step workflows

Documentation Status

Status Meaning
✅ Complete Fully documented with all sections
🚧 In Progress Documentation started, needs completion
📝 Planned Documentation planned but not started

Admin Page Documentation

Dashboard & Home

Page Status Description
Dashboard ✅ Complete Main admin dashboard with key metrics and quick links

Customers Section

Page Status Description
Customers ✅ Complete Main customer search, filtering, and management page
Add New Customer ✅ Complete Create new customer accounts
Customer Detail ✅ Complete Individual customer account details and editing
Customer Email History ✅ Complete Email communication history for customer
Customer Log History ✅ Complete Account activity audit trail
Customer Order Viewed ✅ Complete Last viewed order for customer
Customer Cancelled ✅ Complete Cancelled customer status view
Customer Chat ✅ Complete AI chat conversations with customers
Customer Chat View All ✅ Complete View all customer chat conversations
Contact Form ✅ Complete Customer contact form submissions
Cancellations ✅ Complete Cancellation tracking and reasons
Customer Product Matrix ✅ Complete Product preferences by customer
Conversions ✅ Complete Customer conversion tracking
Daily Customer Report ✅ Complete New signups, activations, cancellations
Missed Signups ✅ Complete Failed signup attempts
Missed Zip Codes ✅ Complete Signups outside delivery area
New Signups ✅ Complete Latest customer sign-ups
Account Notes ✅ Complete Customer account notes
Order Count by Time ✅ Complete Order count tracking
Promo Activations ✅ Complete Promo code redemptions
Reactivations ✅ Complete Reactivated customer accounts
Recent Logins ✅ Complete Customer login history
Subscriptions Report ✅ Complete Subscription price reports
Subscriptions Schedule Totals ✅ Complete Schedule type breakdown
Subscriptions Paused ✅ Complete Paused subscription management
VIP Status ✅ Complete VIP customer management
Birthdays ✅ Complete Customer birthday tracking
Email Sync ALPHA ✅ Complete Email inbox synchronization
Tagger ✅ Complete Bulk customer tagging via CSV
Authorize.net Import ✅ Complete Import payment profiles
Gift Certificates ✅ Complete Gift certificate management
Gift Card Images ✅ Complete Gift card image settings
Gift Card Promotions ✅ Complete Gift card promotional settings
Signup Secret Codes ✅ Complete Special signup code management
Co-ops ✅ Complete Group pickup location management
Gift Boxes ✅ Complete Gift subscription product management
Gift Box Report ✅ Complete Gift box sales analytics and tracking
Social Services Requests ✅ Complete Social services customer tracking
Customer Engagement ✅ Complete Customer engagement analytics and activity tracking
Customer Longevity ✅ Complete Customer retention and cohort analysis
Customer Totals ✅ Complete QuickBooks-compatible payment history export

Orders Section

Page Status Description
Orders ✅ Complete Main order management and search page
Order Detail ✅ Complete Individual order details and editing
Gift Boxes - Current Orders ✅ Complete Current week gift box orders
Order Wholesale +/- ✅ Complete Wholesale order adjustments

Products Section

Page Status Description
Products ✅ Complete Product catalog management
Add Product ✅ Complete Add new products to catalog
Inventory Demand ✅ Complete Print inventory demand report
Menu Builder ✅ Complete Weekly menu planning tool
Menu Inventory ✅ Complete Menu inventory tracking and distributor orders
Packing Order ✅ Complete Set product packing order
Product Feedback ✅ Complete Customer product feedback
Product Reviews ✅ Complete Product review management
Saved for Later ✅ Complete Customer saved items
Boxes ✅ Complete Subscription box management
Create New Box ✅ Complete Add new box types
Bundles ✅ Complete Product bundle management
Box Dimensions ✅ Complete Box size configuration
Store Categories ✅ Complete Online store category management
Checkout Upsells ✅ Complete Upsell product settings
Bestselling Results ✅ Complete Best-selling product tracking
Featured Icons ✅ Complete Product icon management
Featured Products Sort ✅ Complete Sort featured product display
Product Tags ✅ Complete Product tagging system
Lightspeed Product Linker ✅ Complete Link products to Lightspeed POS
Lightspeed POS ✅ Complete Lightspeed POS integration
Add Items to Orders via CSV ✅ Complete Bulk order item import
Addons History ✅ Complete Product sold history
Addons Report ✅ Complete Comprehensive addon sales analysis with multiple views
Product Quantities Report ✅ Complete Weekly packing quantities and fulfillment planning
Inventory History ✅ Complete Historical inventory data
Inventory Alert History ✅ Complete Low inventory alerts
Never Sold Products ✅ Complete Products with zero sales for catalog cleanup
Slow Moving Products ✅ Complete Product sales velocity analysis and slow movers
No Sub Found Report ✅ Complete Substitution tracking
Sub Popularity Report ✅ Complete Popular substitutions
Sub Un-Popularity Report ✅ Complete Unpopular substitutions
Distributors ✅ Complete Distributor management
Parent Category Classifications ✅ Complete Top-level categories
Master Product Classifications ✅ Complete Complete category tree
Product Attributes ✅ Complete Product attribute system
Menu Builder Tabs ✅ Complete Menu tab configuration
Vendors & Farms ✅ Complete Vendor management
Units ✅ Complete Unit of measure settings

Reports - General

Page Status Description
Weekly Report ✅ Complete Comprehensive weekly business analytics with revenue, customers, and trends
Weekly Open to Closed Comp. ✅ Complete Order status comparison
Future Demand ✅ Complete Projected order demand
Sidebar Stats ✅ Complete Dashboard sidebar statistics
Kiva Logic Launch List 📝 Planned Client launch tracking
View Screenshots ✅ Complete System screenshot gallery
Seasons ✅ Complete Seasonal period management
Seasons Report ✅ Complete Seasonal analytics

Reports - Orders

Page Status Description
Menu Feedback ✅ Complete Customer order feedback
Order Count Tracker ✅ Complete Order count over time
Order Report ✅ Complete Order analytics

Reports - System

Page Status Description
Active Campaign Modal Form Submissions ✅ Complete Marketing form tracking
Admins Action History ✅ Complete Admin user activity log
EasyPost Log ✅ Complete Shipping API logs
Fedex Rate Check ✅ Complete Shipping rate validation
Helpscout Log ✅ Complete Support ticket integration
System Log ✅ Complete System error and event logs
What's New ✅ Complete System updates and features

Reports - Email/SMS

Page Status Description
Emails Sent History ✅ Complete All sent email tracking with delivery status, opens, and clicks
Email Stats ✅ Complete Email performance analytics
SMS Pending Queue ✅ Complete Pending SMS messages
Email Pending Queue ✅ Complete Pending email queue
Un-opened Emails ✅ Complete Emails not opened

Reports - Web

Page Status Description
Web Stats ✅ Complete Website analytics

Reports - Credits

Page Status Description
Credits Batches ✅ Complete Credit batch management
Credits Leftover ✅ Complete Unused credit tracking
Credits Reports ✅ Complete Credit usage analytics

Reports - Products & Inventory

Page Status Description
Auto Preferences ✅ Complete Automated preference tracking
Box Count Breakdown Over Time ✅ Complete Box type trends
Inventory Dashboard ✅ Complete Multi-DC fulfillment command center with order and box counts
Inventory Invoices ✅ Complete Inventory invoice tracking
Love/Hate Report ✅ Complete Customer product preferences
Order Contents Dump ✅ Complete Complete order data export
Product Quantities Over Time ✅ Complete Product quantity trends
Produce Reports (alpha) ✅ Complete Produce-specific analytics
Produce History Summary (alpha) ✅ Complete Historical produce data
Recurring Product Conflicts/Missing ✅ Complete Recurring item issues
Recurring Items ✅ Complete Recurring product dashboard and navigation hub
Recurring Subscriptions ✅ Complete Complete customer recurring subscription export
Top Recurring Product Subscriptions ✅ Complete Popular recurring items
Shop Filter Report ✅ Complete Shop filter usage
Shop Filter Bulk Upload ✅ Complete Bulk filter management
Shop Searches ✅ Complete Customer search analytics

Reports - Acquisition & Marketing

Page Status Description
Tell A Friend ✅ Complete Referral program tracking
Referrals ✅ Complete Customer referral program tracking and crediting
Referral Leaders ✅ Complete Top referrers
Referral Leaderboard ✅ Complete Gamified referral tracking
How Did You Hear ✅ Complete Acquisition source analytics and reporting
How Did You Hear by Customer ✅ Complete Acquisition source by customer
How Did You Hear - Summary ✅ Complete Acquisition source summary

Reports - Data Exports

Page Status Description
Weekly CSV Export ✅ Complete Weekly data export
Order Data Exports ✅ Complete Monthly XLSX reports with sales, customer, and product data
Product Image Archives ✅ Complete Product image download
Monthly Transaction Spreadsheet Export-XLSX ✅ Complete Transaction Excel export

Reports - Shipping & Delivery

Page Status Description
Driver Report ✅ Complete Weekly driver performance with tips, mileage, and timing analysis
Shipping Report ✅ Complete Package tracking, late shipment resolution, and carrier performance
UPS Claims ✅ Complete Shipping insurance claims
UPS Claims API Log ✅ Complete Claims API activity

Reports - Financial

Page Status Description
Average Spend Per Box ✅ Complete Add-on spending analysis by box type with median statistics
Customer Totals ✅ Complete Customer financial summary
Delivery Fees Total Report ✅ Complete Delivery fee analytics
Actual Total Report ✅ Complete Historical revenue snapshots and tracking
Actual Reserved Report ✅ Complete Reserved revenue and cash flow forecasting
How Many Boxes Sold ✅ Complete Box sales count by type with monthly breakdown option
Route Wholesale vs. Revenue Report ✅ Complete Route profitability and margin analysis
Sales Per Route and Category ✅ Complete Route and category sales breakdown (ALPHA)
Daily Reports ✅ Complete Daily financial snapshots (testing)
Lifetime Reports ✅ Complete Customer lifetime value and churn analysis
Monthly Recurring Reports ✅ Complete MRR analytics and subscription metrics
Net Revenue Retention NRR ✅ Complete Revenue retention metrics
Payment Transactions ✅ Complete Transaction summaries by time period with drill-down modals
Revenue by Tag ✅ Complete Revenue segmentation
Revenue Per Customer ✅ Complete Customer revenue rankings and spending analysis
Tax Reports ✅ Complete Sales tax reporting by jurisdiction (state, city, county, zip)
Transaction Reports ✅ Complete Customer payment transaction history analysis
VAT Report ✅ Complete VAT tax reporting
Bookkeeping ✅ Complete Financial bookkeeping tools

Reports - Analytics

Page Status Description
Admin History 📝 Planned System administration log
Cohort Data ✅ Complete Cohort analysis
Yearly State Report ✅ Complete State-level annual report
How Did You Hear Revenue Report ✅ Complete Revenue by acquisition source

Delivery Section

Page Status Description
Delivery ✅ Complete Main delivery management page
Print Labels ✅ Complete Shipping label printing, packing lists, driver sheets, and route management
Driver App ✅ Complete Mobile driver application

Discounts Section

Page Status Description
Discounts ✅ Complete Discount codes, gift certificates, and promotional offers

Payments Section

Page Status Description
Payments ✅ Complete Payment transaction management
Payment Settings ✅ Complete Payment gateway configuration
Driver Tips ✅ Complete Driver tip management
City Tax ✅ Complete City tax configuration
County Tax ✅ Complete County tax configuration
State Tax ✅ Complete State tax configuration
Zip Code Tax ✅ Complete Zip-level tax configuration
Tax Reports ✅ Complete Tax collection reports
Billing Payment Transactions ✅ Complete Payment history
Credits Report ✅ Complete Account credit analytics

Settings - Main

Page Status Description
Business Settings ✅ Complete Master business configuration: features, pricing, integrations, and system settings
Admin Users ✅ Complete Staff account and permission management
Admin Navigation Menu ✅ Complete Customize admin menu

Settings - Delivery

Page Status Description
Bin Tracker ✅ Complete Reusable bin tracking
Enter Bin Pickups ✅ Complete Log bin returns
Routes ✅ Complete Delivery route and service area management
Zip Codes ✅ Complete Service area zip code assignments
Distribution Centers ✅ Complete Warehouse locations
Shipping Hubs ✅ Complete Regional shipping hubs
Shipping Zips->Hubs ✅ Complete Zip to hub mapping
Shipping Zips->Hubs State Defaults ✅ Complete State-level hub defaults
Delivery Windows ✅ Complete Delivery time slot management
Printed Messages ✅ Complete Packing slip messages
Printed Messages - by Box ✅ Complete Box-specific messages
Printed Messages - by Route ✅ Complete Route-specific messages
Printed Messages - Welcome Message ✅ Complete Welcome letter content
Pickup Locations ✅ Complete Customer pickup points
Label Sorting Order ✅ Complete Label print sorting
Map Editor ✅ Complete Route map editor
Drivers ✅ Complete Driver profile and performance management

Settings - Customer

Page Status Description
Co-Ops Settings ✅ Complete Co-op settings
Customer Tags ✅ Complete Custom customer segmentation tags
Promotions ✅ Complete Promotional campaign tagging
Order Count Events ✅ Complete Order milestone events
Social Services ✅ Complete Social service programs
Monthly Specials ✅ Complete Monthly special offers
Active Campaign Tags ✅ Complete Marketing automation tags

Settings - Content

Page Status Description
Auto Blog Topics ✅ Complete AI blog topic generation
Auto Blog Posts ✅ Complete AI blog post generation
Automated Emails using Order Filters ✅ Complete Order-triggered emails
Automated Emails LOGS ✅ Complete Automated email logs
Content Overview ✅ Complete Content management dashboard
Email Template Preview Saves ✅ Complete Saved email previews
Email Templates ✅ Complete Email template management and system emails
FAQ Content ✅ Complete FAQ management
Favicon ✅ Complete Site favicon settings
Front Page ✅ Complete Homepage content editor
Hello Bar ✅ Complete Top banner messages
Holiday Theme Settings ✅ Complete Seasonal theme settings
Hosted File Uploads PDF ✅ Complete PDF file hosting
How Did You Hear? ✅ Complete Acquisition source options
Seasons ✅ Complete Seasonal product availability periods
LeadPages ✅ Complete Landing page integration
Keywords ✅ Complete SEO keyword management
Image Upload History ✅ Complete Uploaded image log
Media Library ✅ Complete Media asset management
Media Mentions ✅ Complete Press mention tracking
Monthly Special ✅ Complete Monthly offer management
News Items ✅ Complete News/announcement management
Customer Pop-up Messages ✅ Complete Modal message settings
Recipes ✅ Complete Recipe content management
Recipe Category ✅ Complete Recipe categorization
Testimonials ✅ Complete Customer testimonial management

Settings - System

Page Status Description
Android/iOS App Settings ✅ Complete Mobile app configuration
Automated Emails from Filters ✅ Complete Filter-based email automation
Bad Logins ✅ Complete Failed login tracking
CloudFlare Settings ✅ Complete CDN configuration
Drip Emails ✅ Complete Email drip campaigns
EasyPost Settings ✅ Complete Shipping API configuration
EasyPost Webhooks ✅ Complete Shipping webhook management
Easypost Validations ✅ Complete Address validation logs
Email Pending ✅ Complete Pending email queue
Facebook Pixel Server Side Sync ✅ Complete FB tracking integration
Holiday Weeks ✅ Complete Holiday schedule management
Klaviyo Integration ✅ Complete Email marketing integration
Lightspeed POS Inventory Sync 📝 Planned POS inventory sync
Push Messages ✅ Complete Mobile app push notification management
Send Weekly Order Email ✅ Complete Weekly order email settings
SMS Messages ✅ Complete SMS notification queue management
Temp Banned IPs 📝 Planned Temporary IP bans
URL Redirects ✅ Complete URL redirect management
Weekly Cycle ✅ Complete Weekly processing schedule

Settings - Data Integration

Page Status Description
Shopify Order Importer ✅ Complete Import Shopify orders
MailChimp Export ✅ Complete Export to MailChimp
MailChimp Active ✅ Complete Active MailChimp sync
Customer Export ✅ Complete General customer export

AI Section

Page Status Description
AI Overview ✅ Complete KL-AI-2000 dashboard and event management
AI Image Calls ✅ Complete AI screenshot analysis utility
API Calls ✅ Complete AI API usage tracking and cost monitoring
AI Improvements RAW ✅ Complete Backend processor for AI product suggestions
AI Suggestions for Product ✅ Complete Product improvement AI with review workflow
AI Campaigns - Marketing ✅ Complete AI marketing campaign generation
Cancels Analysis ✅ Complete AI cancellation trend analysis and classification
System Log Insights ✅ Complete AI-powered system log analysis
Love/Hate Groupings ✅ Complete AI product preference clustering (stub)

Tools Section

Page Status Description
Tools 📝 Planned Tools overview page
Data Import Tool ✅ Complete CSV/XLSX bulk data import with column mapping and validation
Freescout Knowledge Base AI Generator 📝 Planned AI knowledge base tool
BlueSky Post 📝 Planned Social media posting
Rate Limiter Cleanup Test 📝 Planned Rate limit testing
Bookkeeping Book Expenses 📝 Planned Expense tracking
GME Options Engine 📝 Planned Options trading tool
Sys Datastore 📝 Planned System data storage
Weekly Cycle Data 📝 Planned Weekly cycle management
PHP Info 📝 Planned Server PHP configuration
Database Editor 📝 Planned Database management tool
OpSec Privacy Data Removal Tracker 📝 Planned GDPR compliance tool
Screenshot Gallery 📝 Planned System screenshot library
Stripe Fees Importer 📝 Planned Import Stripe fee data
Archive Data 📝 Planned Data archival tool
Barcode Scanner 📝 Planned Barcode scanning utility
Bookkeeping 📝 Planned Financial bookkeeping
CloudFlare Settings 📝 Planned CDN settings
Imgix Whitelist 📝 Planned Image CDN whitelist
Features! 📝 Planned Feature flags
Freshbooks Invoices 📝 Planned Accounting integration
Signup IP Blocker 📝 Planned Block signup by IP
Signup IP Blocker Blacklist 📝 Planned IP blacklist management
Temp Banned IPs 📝 Planned Temporary IP bans
Navbar Margins 📝 Planned UI spacing settings
Warehouse App 📝 Planned Warehouse management app
Apps 📝 Planned Mobile app overview

Kiva Tools Section (Kiva Admin Only)

Page Status Description
Kiva Checks Daily Report 📝 Planned Daily system health checks
Parse Apache Errors 📝 Planned Error log parser
IP Blacklist 📝 Planned Blocked IP management
Fix While list to Foreach 📝 Planned Code migration tool
Google Cloud API 📝 Planned Google Cloud integration
AAReadings Editor 📝 Planned Internal data editor
Build Classes PHP 📝 Planned ORM class generator
HelpScout Import Docs 📝 Planned Documentation importer
OpenAI API Calls/Log 📝 Planned AI API usage log
Twitter/Beanstalk Entries 📝 Planned Deployment tracking
Checking Account Tool 📝 Planned Financial reconciliation
AWS Excludes for Beanstalk Deployment 📝 Planned Deployment exclusions
Sorry App Downtime Email 📝 Planned Downtime notifications
Crypto 📝 Planned Cryptocurrency tools
Competitors 📝 Planned Competitor analysis
Tests 📝 Planned System testing tools
Post to App API 📝 Planned API testing tool
301 Gen 📝 Planned Redirect generator
All Domains List 📝 Planned Multi-tenant domain list
Gen Cloudways Backup Script 📝 Planned Backup script generator
Server Moving 📝 Planned Server migration tools
KLBAK 📝 Planned Backup management
Get All Admin Users 📝 Planned Cross-site admin list
Get All Product Picts 📝 Planned Product image aggregator
Sitemaps 📝 Planned Sitemap generator
Twilio Settings 📝 Planned SMS API configuration
Get Settings 📝 Planned Cross-site config checker
Cachet Subscribers 📝 Planned Status page subscribers
EasyCron Tools 📝 Planned Cron job management
FreshBooks Tax Tool 📝 Planned Accounting tax tool
FreshBooks Tools 📝 Planned Accounting integration
FreshBooks Invoice Checker 📝 Planned Invoice validation
Library Jobs 📝 Planned Background job library
SVN Tools 📝 Planned Version control tools
IMAP Filter Tools 📝 Planned Email filter management
Billing Checks 📝 Planned Billing validation
Sales 📝 Planned Sales tracking
SVN Deploy 📝 Planned Deployment tool
Status 📝 Planned System status page
APCu Report 📝 Planned Cache performance
APC Report 📝 Planned Cache statistics
Schedule Test 📝 Planned Cron schedule tester
APC Cache 📝 Planned Cache management
Mandrill API Test 📝 Planned Email API tester
KL-AI-2000 Dashboard 📝 Planned AI system dashboard

User Profile

Page Status Description
Your Profile 📝 Planned Admin user profile settings
Update Credit Card / Billing 📝 Planned Payment method management
Account History 📝 Planned Personal activity history
Bookmarks 📝 Planned Saved page bookmarks
Logout 📝 Planned Sign out of admin
Page Status Description
Data Importer Tool 📝 Planned Health plan data import
Incomm Log 📝 Planned Incomm transaction log
Incomm M66 Catalog 📝 Planned Incomm product catalog
OTC Report 📝 Planned Over-the-counter report
View All Batches 📝 Planned Import batch history
View SFTP Imports 📝 Planned SFTP import log
Company Data Sources 📝 Planned Health plan data sources
Box Aliases 📝 Planned Box type aliases
Fiserv Snap/EBT Settings 📝 Planned SNAP/EBT configuration
Health Plans Eligible 📝 Planned Eligible health plans
SFTP Servers 📝 Planned SFTP server configuration
Ice Packs 📝 Planned Ice pack settings
Demo Card Batches 📝 Planned Demo card management
Incomm Settings 📝 Planned Incomm API settings
SSO 📝 Planned Single sign-on settings

Common Workflows Across Pages

Customer Management Workflow

  1. Find CustomerCustomers Page
  2. View DetailsCustomer Detail
  3. Edit AccountCustomer Detail
  4. View Orders → Customer Orders (planned)
  5. Send Email → Email Templates (planned)

Order Management Workflow

  1. Search OrdersOrders
  2. View Order → Order Detail (planned)
  3. Edit Order → Order Detail (planned)
  4. Process Payment → Payments (planned)
  5. Print Labels → Delivery (planned)

Product Management Workflow

  1. Manage ProductsProducts
  2. Set Categories → Master Product Classifications (planned)
  3. Update Inventory → Menu Inventory (planned)
  4. Plan MenuMenu Builder
  5. Add Recipes → Recipes (planned)

Communication Workflow

  1. Create TemplateEmail Templates
  2. Filter RecipientsCustomers Page
  3. Send CampaignCustomers Page
  4. Monitor Results → Emails Sent History (planned)

Inventory Management Workflow

  1. Build MenuMenu Builder
  2. Plan OrdersMenu Inventory
  3. Download Invoices → Inventory Invoices
  4. Receive Inventory → Update stock levels
  5. Fulfill OrdersOrders

Quick Reference: Common Tasks

Finding Information

Task Go To Documentation
Find a customer Customers page Customers
Search orders Orders page Orders
Check inventory Menu Inventory Menu Inventory
View sales data Weekly Report Reports (planned)
Check email status Emails Sent History Reports (planned)
Manage email templates Email Templates Email Templates

Making Changes

Task Go To Documentation
Update customer info Customer Detail Customer Detail
Edit an order Orders page Orders
Change product price Products Products
Modify email template Email Templates Email Templates
Update settings Business Info / All Settings Settings (planned)
Order from distributor Menu Inventory Menu Inventory

Bulk Operations

Task Go To Documentation
Email multiple customers Customers page Customers
Export customer list Customers page Customers
Create weekly orders Orders Orders
Import data Data Import Tool Tools (planned)

Documentation Standards

All page documentation follows this structure:

  1. Header: Menu location, access level, last updated
  2. Overview: Purpose and primary functions
  3. Page Layout: Visual structure description
  4. Features: Detailed feature documentation
  5. Common Use Cases: Step-by-step workflows
  6. Troubleshooting: Common issues and solutions
  7. Best Practices: Guidelines for effective use
  8. Related Pages: Links to connected functionality
  9. Permissions: Access level requirements
  10. Recent Updates: Change log
  11. Quick Reference: Fast lookup table
  12. FAQs: Frequently asked questions

Contributing to Documentation

Documentation File Naming

  • Use kebab-case: page-name.md
  • Match menu label where possible
  • Keep names descriptive but concise
  • Use relative links: [Page Name](page-file.md)
  • Link to related pages in documentation
  • Create cross-references for workflows

Getting Help

For Admin Users

  1. Search this documentation first
  2. Use Quick Reference sections
  3. Check Common Use Cases
  4. Contact your administrator
  5. Submit support ticket to Kiva Logic

Recent Documentation Updates

2026-03-01

  • Created master index and documentation structure
  • Completed all Priority 1 pages (9 total):
  • Customers page (search and filtering)
  • Customer Detail page (account management)
  • Orders page (order management)
  • Products page (product catalog)
  • Menu Builder page (weekly menu planning)
  • Dashboard page (admin home)
  • Add New Customer page (account creation)
  • Email Templates page (email template management)
  • Menu Inventory page (inventory management)
  • Completed all Priority 2 pages (5 total):
  • Emails Sent History (email tracking with opens/clicks)
  • Weekly Report (comprehensive business analytics)
  • Discounts (discount codes and gift certificates)
  • Delivery/Print Labels (shipping and route management)
  • Business Settings (system configuration)
  • Completed 10 Priority 3 pages - Batch 1 (Customer & Product Reports):
  • Customer Engagement - Customer activity tracking and engagement scoring
  • Customer Longevity - Retention cohort analysis by weekly cycle
  • Customer Totals - QuickBooks-compatible payment export
  • Addons Report - Multi-view addon sales analysis
  • Product Quantities - Weekly packing quantities report
  • Recurring Items - Recurring product dashboard hub
  • Recurring Subscriptions - Complete subscription data export
  • Never Sold Products - Zero-sales product identification
  • Slow Moving Products - Product sales velocity analysis
  • Inventory Dashboard - Multi-DC fulfillment command center
  • Completed 10 Priority 3 pages - Batch 2 (Financial & Shipping Reports):
  • Payment Transactions - Transaction summaries with drill-down by time period
  • Revenue Per Customer - Customer revenue rankings and analysis
  • Tax Reports - Sales tax reporting by jurisdiction (state/city/county/zip)
  • Transaction Reports - Customer payment transaction history
  • How Many Boxes Sold - Box sales count by type with monthly breakdown
  • Average Spend Per Box - Add-on spending analysis with median statistics
  • Driver Report - Weekly driver performance with tips, mileage, timing
  • Shipping Report - Package tracking, late shipment resolution, EasyPost integration
  • Data Import Tool - CSV/XLSX bulk import with column mapping
  • Order Data Exports - Monthly XLSX reports with comprehensive sales data
  • Completed Batch 3 - Priority 3 & Priority 4 Pages (15 pages):
  • Routes - Delivery route and service area management
  • Drivers - Driver profile and performance management
  • Referrals - Customer referral program tracking and crediting
  • How Did You Hear - Acquisition source analytics and reporting
  • Admin Users - Staff account and permission management
  • Gift Boxes - Gift subscription product management
  • Gift Box Report - Gift box sales analytics
  • Co-ops - Group pickup location management
  • Customer Tags - Custom customer segmentation tags
  • Promotions - Promotional campaign tagging
  • Seasons - Seasonal product availability periods
  • Delivery Windows - Time slot delivery management
  • Zip Codes - Service area zip code assignments
  • SMS Messages - SMS notification queue management
  • Push Messages - Mobile app push notification management
  • Completed Batch 4 - High-Value Remaining Pages (18 pages):
  • Order Detail - Individual order editing and management
  • Add Product - Product creation and catalog management
  • Boxes - Subscription box configuration
  • Store Categories - Online store category organization
  • Checkout Upsells - Upsell offer configuration
  • Vendors & Farms - Vendor and supplier management
  • Daily Customer Report - Daily signup/cancellation analytics
  • New Signups - Customer acquisition tracking
  • Subscriptions Report - Subscription pricing and MRR reporting
  • Front Page - Homepage content editor
  • FAQ Content - FAQ management interface
  • Testimonials - Customer testimonial management
  • EasyPost Settings - Shipping API configuration
  • Holiday Weeks - Holiday schedule management
  • Weekly Cycle - Weekly processing schedule (critical operational timing)
  • Klaviyo Integration - Email marketing platform integration
  • Lightspeed POS - Point of sale integration
  • Packing Order - Warehouse packing sequence optimization
  • Completed Batch 5 - All Remaining High-Value Pages (25 pages):
  • Critical Operations (7 pages):
    • Gift Boxes - Current Orders - Current week gift box fulfillment
    • Inventory Demand - Inventory planning and packing reports
    • Product Reviews - Customer review moderation
    • Contact Form - Contact form submission management
    • Cancellations - Cancellation tracking and analysis
    • Payment Settings - Payment gateway configuration (Stripe, Authorize.net)
    • Distribution Centers - Multi-warehouse/DC management
  • Common Reports (8 pages):
    • Order Report - Order analytics and trends
    • Email Stats - Email performance metrics and sender reputation
    • Web Stats - Website traffic and Google Analytics integration
    • Credits Report - Account credit usage analytics
    • Revenue by Tag - Revenue segmentation by customer tags
    • Cohort Data - Customer cohort retention and LTV analysis
    • Bookkeeping - Financial bookkeeping and expense tracking
    • Customer Export - Advanced customer data export
  • Content & Marketing (6 pages):
    • Recipes - Recipe content creation and publishing
    • Recipe Category - Recipe categorization and organization
    • News Items - News article and announcement management
    • Hello Bar - Top banner notification messages
    • Keywords - SEO keyword tracking and optimization
    • Media Library - Central media asset management
  • System Settings (4 pages):
    • URL Redirects - SEO-friendly redirect management
    • Drip Emails - Automated email drip campaigns
    • CloudFlare Settings - CDN and caching configuration
    • Admin Navigation Menu - Admin menu customization
  • Completed Batch 6 - Additional High-Value Pages (28 pages):
  • Gift & Payment Features (4 pages):
    • Gift Certificates - Gift certificate creation, sales, and redemption tracking
    • Gift Card Images - Visual branding and custom gift card design
    • Gift Card Promotions - Gift card promotional campaign management
    • Payment Transactions Page - Payment transaction management interface
  • Product Management (8 pages):
    • Bundles - Product bundle creation, pricing, and marketing
    • Distributors - Distributor relationship and ordering management
    • Master Product Classifications - Complete hierarchical category tree
    • Parent Category Classifications - Top-level category management
    • Product Tags - Flexible product tagging for filtering and marketing
    • Product Attributes - Structured attributes (organic, gluten-free, etc.)
    • Units - Unit of measure configuration (lb, oz, each, bag)
    • Box Dimensions - Shipping box size and volume configuration
  • Customer Management (8 pages):
    • Subscriptions Paused - Paused subscription tracking and win-back
    • VIP Status - VIP tier management with benefits and recognition
    • Birthdays - Birthday tracking and automated campaign management
    • Recent Logins - Login activity and customer engagement tracking
    • Reactivations - Reactivated customer analysis and tracking
    • Promo Activations - Promo code redemption and conversion tracking
    • Conversions - Signup funnel conversion tracking (experimental)
    • Customer Cancelled - Cancelled customer status and win-back
  • Inventory & Operations (5 pages):
    • Inventory History - Historical inventory tracking and trend analysis
    • Inventory Alert History - Low stock alert tracking and response
    • Menu Feedback - Customer menu/box feedback management
    • Product Feedback - Product ratings and customer feedback
    • Saved for Later - Customer saved items and conversion tracking
  • Marketing & Content (3 pages):
    • Monthly Specials - Monthly promotion planning and calendar
    • How Did You Hear? Options - Acquisition source configuration
    • Customer Pop-up Messages - Modal message targeting and scheduling
  • Completed Batch 7 - Customer Communication & Analytics (28 pages):
  • Customer Management & Communication (8 pages):
    • Customer Email History - Email communication tracking per customer
    • Customer Log History - Account activity audit trail
    • Customer Chat - Individual AI chat conversations
    • Customer Chat View All - Platform-wide chat conversation viewing
    • Customer Product Matrix - Product preference analysis matrix
    • Missed Signups - Failed signup attempt tracking and recovery
    • Missed Zip Codes - Out-of-service-area signup tracking
    • Account Notes - Customer note management system
  • Order Management (3 pages):
    • Order Wholesale +/- - Wholesale order quantity adjustments
    • Order Count by Time - Order volume tracking over time
    • Add Items to Orders via CSV - Bulk order item import tool
  • Product Features (5 pages):
    • Create New Box - New subscription box type creation
    • Featured Products Sort - Featured product display ordering
    • Featured Icons - Product badge/icon management
    • Bestselling Results - Best-selling product performance tracking
    • Lightspeed Product Linker - POS product synchronization
  • Reports - Analytics (7 pages):
    • Weekly Open to Closed Comparison - Order fulfillment status tracking
    • Future Demand - Order and product demand forecasting
    • Box Count Breakdown Over Time - Subscription box type trends
    • Product Quantities Over Time - Product sales trend analysis
    • Love/Hate Report - Customer product preference insights
    • Order Contents Dump - Complete order data export
    • Shop Searches - Customer search behavior analytics
  • Settings & Tools (5 pages):
    • Email Sync ALPHA - Email inbox integration (experimental)
    • Tagger - Bulk customer tagging via CSV
    • Signup Secret Codes - Invitation code management
    • Social Services Requests - Subsidized subscription tracking
    • Subscriptions Schedule Totals - Delivery frequency breakdown
  • Completed Batch 8 - Reports, Analytics & Exports (17 pages):
  • Reports - Financial & Analytics (6 pages):
    • Auto Preferences - Automated customer preference tracking
    • Inventory Invoices - Inventory invoice history and tracking
    • Produce Reports (Alpha) - Produce-specific analytics (experimental)
    • Recurring Product Conflicts - Recurring item conflict resolution
    • Top Recurring Product Subscriptions - Popular recurring items analysis
    • Shop Filter Report - Shop filter usage analytics
  • Referral & Acquisition (4 pages):
    • Tell A Friend - Original referral program tracking
    • Referral Leaders - Top referrer rankings
    • Referral Leaderboard - Gamified referral display
    • How Did You Hear by Customer - Individual customer acquisition source
  • Data Exports (4 pages):
    • Weekly CSV Export - Weekly data export utility
    • Product Image Archives - Product image download/backup
    • Monthly Transaction Spreadsheet Export - Monthly transaction Excel export
    • MailChimp Export - Customer list export to MailChimp
  • Shipping Operations (3 pages):
    • UPS Claims - Shipping insurance claims management
    • UPS Claims API Log - Claims API activity tracking
  • Completed Batch 9 - Operations, Logs & Financial Reports (28 pages):
  • Product & Inventory Management (7 pages):
    • Addons History - Product sales history tracking
    • No Sub Found Report - Substitution failure tracking
    • Sub Popularity Report - Popular product substitutions
    • Sub Un-Popularity Report - Unpopular substitutions analysis
    • Menu Builder Tabs - Menu tab configuration and customization
    • Produce History Summary (alpha) - Historical produce data
    • Shop Filter Bulk Upload - Bulk filter management via CSV
  • System Logs & Monitoring (7 pages):
    • Admins Action History - Admin user activity audit log
    • EasyPost Log - Shipping API activity tracking
    • Helpscout Log - Support ticket integration logs
    • System Log - System error and event logs
    • What's New - System updates and feature announcements
    • Email Pending Queue - Pending email queue management
    • SMS Pending Queue - Pending SMS queue management
  • Financial Reports (7 pages):
    • Credits Batches - Credit batch issuance management
    • Credits Leftover - Unused credit tracking
    • Credits Report - Account credit analytics
    • Delivery Fees Total Report - Delivery fee revenue analytics
    • VAT Report - VAT tax reporting and compliance
    • Yearly State Report - State-level annual reporting
    • How Did You Hear Revenue Report - Revenue by acquisition source
  • Delivery & Operations Settings (7 pages):
    • Bin Tracker - Reusable bin tracking system
    • Enter Bin Pickups - Log bin returns from customers
    • Printed Messages - General packing slip messages
    • Printed Messages - by Box - Box-specific packing messages
    • Printed Messages - by Route - Route-specific packing messages
    • Printed Messages - Welcome Message - Welcome letter content
    • Label Sorting Order - Label print sorting configuration
  • Completed Batch 10 - Content, Delivery & Advanced Features (28 pages):
  • Content Management (10 pages):
    • Automated Emails using Order Filters - Order-triggered automated email campaigns
    • Automated Emails LOGS - Automated email activity tracking
    • Content Overview - Content management dashboard
    • Email Template Preview Saves - Saved email previews for testing
    • Favicon - Site favicon generator for all formats
    • Holiday Theme Settings - Seasonal theme configuration
    • Hosted File Uploads PDF - PDF document hosting
    • Image Upload History - Image upload audit trail
    • Monthly Special - Time-limited promotional offers
    • Recipe Images - Recipe photography management
  • Delivery & Shipping Settings (7 pages):
    • Shipping Hubs - Regional distribution center management
    • Shipping Zips->Hubs - ZIP code to hub mapping
    • Shipping Zips State Defaults - State-level hub defaults
    • Map Editor - Visual delivery zone drawing tool
    • Delivery Page - Central delivery operations dashboard
    • Driver App - Mobile driver application settings
    • FedEx Rate Check - Real-time FedEx rate validation
  • Customer & Order Features (6 pages):
    • Customer Order Viewed - Order viewing engagement tracking
    • Authorize.net Import - Payment profile import tool
    • Order Count Tracker - Order volume analytics
    • Order Count Events - Order milestone automation
    • Un-opened Emails - Unopened email tracking
  • Settings & Configuration (5 pages):
    • Co-Ops Settings - Buying cooperative management
    • Social Services Settings - SNAP/EBT program configuration
    • Active Campaign Tags - Marketing automation sync
    • Seasons Settings - Seasonal period definition
    • Seasons Report - Seasonal performance analytics
  • Completed Batch 11 - Payment, Tax & System Settings (28 pages):
  • Payment & Tax Settings (8 pages):
    • Payments - Payment transaction management interface
    • Driver Tips - Driver tip distribution and reporting
    • City Tax - City-level tax rate configuration
    • County Tax - County tax rate management
    • State Tax - State sales tax configuration
    • Zip Code Tax - ZIP-level tax rates
    • Tax Reports - Tax collection reporting
    • Billing Payment Transactions - Payment history records
  • System & Integration Settings (8 pages):
    • Android/iOS App Settings - Mobile app configuration
    • Automated Emails from Filters - Filter-based automation
    • Bad Logins - Failed login tracking and security
    • CloudFlare Settings - CDN and caching configuration
    • Drip Emails - Email drip campaign management
    • EasyPost Webhooks - Shipping webhook management
    • Easypost Validations - Address validation logs
    • Email Pending - Pending email queue system
  • Marketing & Integration (6 pages):
    • Facebook Pixel Server Side Sync - FB tracking integration
    • Send Weekly Order Email - Weekly email automation
    • Temp Banned IPs - Temporary IP ban management
    • URL Redirects - SEO redirect management
    • Shopify Order Importer - Shopify integration
    • MailChimp Active - Active MailChimp sync
  • Reporting & Misc (6 pages):
    • Pickup Locations - Pickup point management
    • Sidebar Stats - Dashboard statistics config
    • View Screenshots - System screenshot gallery
    • Active Campaign Modal Forms - Form tracking
    • How Did You Hear Summary - Acquisition summary
    • Customer Totals - Customer financial summary
  • Completed Batch 12 - Financial Reports & MRR Analytics (6 pages):
  • Revenue Reports (6 pages):
    • Actual Total Report - Historical revenue snapshots and manual tracking
    • Actual Reserved Report - Reserved revenue and cash flow forecasting
    • Route Wholesale vs. Revenue Report - Route profitability and margin analysis
    • Sales Per Route and Category - Route and category sales breakdown (ALPHA)
    • Monthly Recurring Reports (MRR) - Comprehensive MRR analytics with 7 key metrics
    • Lifetime Reports - Customer lifetime value and churn analysis
  • Total Documentation: 255 complete pages
  • Established documentation standards and format
  • Added complete inventory of all admin pages (350+ pages)

Documentation Roadmap

Priority 1 (Most Used Pages - Document First)

  • [x] Customers (customers.php)
  • [x] Customer Detail (customer_info.php)
  • [x] Orders (cust_order.php)
  • [x] Products (product_classifications_active.php)
  • [x] Dashboard (Home)
  • [x] Menu Builder (build_menu.php)
  • [x] Add New Customer (add-new-customer.php)
  • [x] Email Templates (admin_email.php)

Priority 2 (Common Daily Operations) - ✅ COMPLETE

  • [x] Menu Inventory (inventory.php)
  • [x] Delivery / Print Labels (print_labels.php)
  • [x] Weekly Report (reports/weekly-report.php)
  • [x] Emails Sent History (emails-sent.php)
  • [x] Discounts (admin_discount_codes.php)
  • [x] Business Settings (admin-config.php)

Priority 3 (Weekly/Regular Use) - ✅ COMPLETE

  • [x] Batch 1 Complete - Customer & Product Reports (10 pages):
  • [x] Customer Engagement
  • [x] Customer Longevity
  • [x] Customer Totals
  • [x] Addons Report
  • [x] Product Quantities Report
  • [x] Recurring Items Landing Page
  • [x] Recurring Subscriptions
  • [x] Never Sold Products
  • [x] Slow Moving Products
  • [x] Inventory Dashboard
  • [x] Batch 2 Complete - Financial & Shipping Reports (10 pages):
  • [x] Payment Transactions
  • [x] Revenue Per Customer
  • [x] Tax Reports
  • [x] Transaction Reports
  • [x] How Many Boxes Sold
  • [x] Average Spend Per Box
  • [x] Driver Report
  • [x] Shipping Report
  • [x] Data Import Tool
  • [x] Order Data Exports
  • [x] Batch 3 Complete - Content & Settings Pages (5 pages):
  • [x] Routes (delivery routes)
  • [x] Drivers (driver management)
  • [x] Referrals (referral program)
  • [x] How Did You Hear (acquisition tracking)
  • [x] Admin Users (staff management)

Priority 4 (Specialized Features) - ✅ COMPLETE (10 of 10 pages)

  • [x] Gift Boxes - Gift subscription management
  • [x] Gift Box Report - Gift sales analytics
  • [x] Co-ops - Group pickup locations
  • [x] Customer Tags - Custom segmentation
  • [x] Promotions - Campaign tagging
  • [x] Seasons - Product availability periods
  • [x] Delivery Windows - Time slot management
  • [x] Zip Codes - Service area definition
  • [x] SMS Messages - SMS queue management
  • [x] Push Messages - Push notification management

Priority 5 (Kiva Admin Tools - Internal Use)

  • [ ] Development Tools
  • [ ] System Maintenance Tools
  • [ ] API Testing Tools
  • [ ] Deployment Tools

Appendix

Access Levels

  • Customer Service: Basic customer and order management
  • Manager: Customer Service + reporting and bulk operations
  • Administrator: Manager + settings, users, sensitive operations
  • Kiva Admin: All features + development tools

Common Terms

  • Admin V2: Current admin interface (V1 is deprecated)
  • APCu: PHP caching system used for performance
  • ORM Classes: Auto-generated database access classes
  • Migration: Database schema update

Total Page Count

  • Customers Section: 52 pages
  • Orders Section: 4 pages
  • Products Section: 48 pages
  • Reports: 90+ pages across all categories
  • Settings: 80+ pages across all categories
  • Tools: 30+ pages
  • Kiva Tools: 45+ pages (admin only)
  • AI: 9 pages
  • Total: 350+ admin pages

End of Index

This documentation is maintained by Kiva Logic. For support, contact your system administrator.