Seed Data¶

Vectis Commerce includes a comprehensive demo dataset that can be installed with a single command. The seed pipeline creates a fully working B2B wholesale environment suitable for development, testing, and demos.

Quick Start¶

# Install the package (enables the `vectis` CLI)
pip install -e .

# Run all 11 seed steps
vectis seed

# Or via python -m
python -m vectis.core.seed_all

CLI Reference¶

Seed Steps¶

The pipeline runs 11 steps in dependency order:

Demo Credentials¶

Fixture File¶

All demo data is defined in a single JSON fixture:

vectis/core/fixtures/demo_data.json

This file is the canonical source of truth for demo data. Seed scripts load from it at runtime, converting JSON strings to Python Decimal values where needed. To update the demo dataset, edit this file and re-run vectis seed --reset.

The fixture contains: brands, categories, products (with flavors and nicotine levels), demo accounts, notification templates, tax categories and rates, price lists, payment terms, discount rules, tags, tag assignments, and search synonyms.

Adding New Seed Steps¶

1. Create a new seed_<module>.py in vectis/core/
2. Add the data definitions to fixtures/demo_data.json
3. Implement the seed_<module>() async function (idempotent, check-before-insert)
4. Register the step in SEED_STEPS in seed_all.py
5. Update this documentation

All seed functions must be idempotent — they check for existing records before inserting and skip gracefully if data already exists.

Architecture¶

vectis/core/
├── cli.py                  # `vectis seed` CLI entry point
├── seed_all.py             # Orchestrator (11 steps)
├── seed.py                 # Step 1: base system
├── seed_cms_pages.py       # Step 3: CMS pages
├── seed_tax.py             # Step 4: tax configuration
├── seed_demo.py            # Step 5: demo accounts
├── seed_products.py        # Step 6: product catalog
├── seed_pricing.py         # Step 7: pricing
├── seed_promotions.py      # Step 8: promotions
├── seed_shipping.py        # Step 9: shipping
├── seed_fraud.py           # Step 10: fraud demo data
├── seed_tags.py            # Step 11: tags + search
└── fixtures/
    ├── __init__.py          # load_fixture() helper
    └── demo_data.json       # Canonical demo dataset

The geo seed lives separately at vectis/modules/geo/seed.py (Step 2) because it loads data from CSV files in vectis/modules/geo/data/.

Permissions Sync at Boot¶

Permission rows no longer wait for a re-seed: at every api boot, core permission codenames and every extension manifest's permissions are upserted into the permissions table (vectis/core/permission_sync.py). The sync is additive-only and idempotent — missing rows are inserted, existing rows are never updated or deleted. New extensions should namespace their codenames as ext.<name>.<perm>.

Re-Seeding After Setting Additions¶

Setting additions are still not auto-applied on container restart. When a new feature adds a setting (e.g., cart_ai_provider_priority), the dev API container needs a re-seed before the new key is visible:

docker exec vectis-api-1 python -m vectis.core.seed_all --only base
docker exec vectis-api-1 python -m vectis.core.seed_all --only demo  # for new demo accounts

If something looks "broken for everyone" after pulling main, re-seed before debugging — setting keys silently fall behind otherwise.

Notable Recent Settings (verified in code)¶

Per-channel approval workflow (B2B) lives on the channel admin settings, not as a top-level setting key. Inspect via AdminChannelSettingsType.approvalMode, defaultCartApproverEmployeeId, defaultPaymentApproverEmployeeId, defaultOrderApproverEmployeeId, cartApprovalInvalidatesOnEdit.