Documentation
Everything you need to connect a shop, understand how ViralCart AI thinks about your business, and build on the platform.
Getting Started
Go from a fresh account to a working command center in three steps.
Connect your TikTok Shop
Authorize ViralCart AI through the official TikTok Shop flow. Credentials are encrypted at rest, and you can review granted scopes and disconnect at any time from Integrations.
Import your data
After connecting, we import your products, variants, prices, inventory, orders, fulfillment records, returns, refunds, creator collaborations, and available financial records. Sync status and any failures are visible throughout.
Review your initial audit
Once the import finishes, ViralCart AI generates readiness scores — listing quality, fulfillment risk, inventory risk, profitability, content, affiliate, and compliance — and a prioritized action plan telling you what to fix first.
Core Concepts
The three ideas that everything else in the product builds on.
Organizations and roles
All data belongs to an organization (your workspace). Team members are assigned roles — from Owner and Administrator down to Read-only Analyst — with fine-grained permissions, and tenant isolation is enforced at the database layer.
Contribution profit
Gross sales minus discounts, refunds, product cost, marketplace fees, affiliate commissions, ad spend, shipping, packaging, warehouse fees, and payment costs. This — not GMV — is the number the Profit Center optimizes.
AI agent safety levels (L1–L5)
Every agent action carries a safety level: L1 read-only analysis, L2 draft recommendation, L3 create internal task, L4 execute reversible action, and L5 execute sensitive action with explicit human approval. Refunds, price changes, ad budget increases, and publishing always sit at L5.
API Access
Programmatic access for teams that want to build on top.
Availability
API access is included on the Pro plan and above. Requests are scoped to your organization and honor the same role-based permissions as the app.
Key management
Create, rotate, and revoke API keys in Settings → API Providers. Keys are shown once at creation, stored encrypted, and every key action is recorded in your audit log.
Missing something? Email support@viralcartai.com and we will point you in the right direction.