Shopify Commerce
Package docs status
Section titled “Package docs status”This page is generated from public package documentation in capell-4/packages and the package manifest checked into the source repository.
| Field | Value |
|---|---|
| Composer package | capell-app/shopify-commerce |
| Package slug | shopify-commerce |
| Product group | Capell Commerce |
| Tier | premium |
| Bundle | commerce |
| Runtime contexts | admin, console |
| Capell version | ^4.0 |
| Source repository | capell-app/packages |
| Source path | packages/shopify-commerce |
| Docs source | packages/shopify-commerce/docs |
| Manifest | capell.json |
What This Plugin Adds
Section titled “What This Plugin Adds”Shopify Commerce is an Available, Schema-owning Capell package in the Capell Commerce product group. It ships as capell-app/shopify-commerce and extends these surfaces: admin, console.
Shopify Commerce adds site-scoped Shopify Admin API OAuth, catalog sync, and customer cache foundations for Capell.
After install, admins get package-owned management or reporting surfaces inside Capell.
Status details:
- Status: Available
- Tier: premium
- Bundle: commerce
- Composer package:
capell-app/shopify-commerce - Namespace:
Capell\ShopifyCommerce - Theme key: not applicable
Why It Matters
Section titled “Why It Matters”For developers: The package gives developers package-owned service providers, Actions, Data objects, models, Laravel routes, Filament classes, and Blade views instead of pushing this behaviour into core or application code.
For teams: Connect any Shopify store to Capell in minutes and keep its product catalog and customer data in sync - securely, per site, with no storefront lock-in.
Screens And Workflow
Section titled “Screens And Workflow”Screenshot contract: docs/screenshots.json.
- Shopify connection page (admin, required).
- Shopify catalog sync state (admin, required).
- Shopify product search (admin, required).
Technical Shape
Section titled “Technical Shape”- Service providers:
Capell\ShopifyCommerce\Providers\ShopifyCommerceServiceProvider,Capell\ShopifyCommerce\Providers\AdminServiceProvider. - Config files:
packages/shopify-commerce/config/capell-shopify-commerce.php. - Migrations:
packages/shopify-commerce/database/migrations/2026_05_22_000001_create_shopify_connections_table.php,packages/shopify-commerce/database/migrations/2026_05_22_000002_create_shopify_oauth_states_table.php,packages/shopify-commerce/database/migrations/2026_05_22_000003_create_shopify_products_table.php,packages/shopify-commerce/database/migrations/2026_05_22_000004_create_shopify_product_variants_table.php,packages/shopify-commerce/database/migrations/2026_06_01_000001_create_shopify_customers_table.php,packages/shopify-commerce/database/migrations/2026_06_18_000001_create_shopify_webhook_events_table.php. - Settings migrations:
packages/shopify-commerce/database/settings/2026_05_22_000001_create_shopify_commerce_settings.php. - Settings classes:
ShopifyCommerceSettings. - Models:
ShopifyConnection,ShopifyCustomer,ShopifyOAuthState,ShopifyProduct,ShopifyProductVariant,ShopifyWebhookEvent. - Filament classes:
ShopifyConnectionPage,ShopifyCommerceSettingsSchema. - Route files:
packages/shopify-commerce/routes/oauth.php. - Events:
ShopifyCustomerSynced. - Actions:
BuildShopifyCatalogThemeDataAction,ContinueShopifyProductBulkSyncAction,FetchShopifyProductAction,ImportShopifyProductBulkSyncAction,InvalidateShopifyProductSearchCacheAction,PersistShopifyProductAction,PollShopifyProductBulkSyncAction,SanitizeShopifySyncErrorAction,SearchShopifyProductsAction,StartShopifyProductBulkSyncAction,SyncShopifyProductsAction,SyncShopifyCustomersAction,and 17 more. - Data objects:
ShopifyCallbackQueryData,ShopifyCatalogProductThemeData,ShopifyCatalogSummaryThemeData,ShopifyCatalogThemeData,ShopifyCatalogVariantThemeData,ShopifyProductData,ShopifyProductOptionData,ShopifyProductVariantData,ShopifyTokenExchangeResponseData. - Command signatures:
capell-shopify-commerce:install,capell-shopify-commerce:prune-oauth-states,capell-shopify-commerce:sync,capell-shopify-commerce:sync-customers. - Console command classes:
InstallShopifyCommerceCommand,PruneExpiredShopifyOAuthStatesCommand,SyncShopifyCustomersCommand,SyncShopifyProductsCommand. - Manifest contributions:
admin-page: Capell\ShopifyCommerce\Manifest\ShopifyConnectionPageContribution,console-command: Capell\ShopifyCommerce\Manifest\ShopifyCommerceConsoleCommandsContribution,health-check: Capell\ShopifyCommerce\Manifest\ShopifyCommerceHealthContribution,model: Capell\ShopifyCommerce\Manifest\ShopifyCommerceModelsContribution,route: Capell\ShopifyCommerce\Manifest\ShopifyCommerceRoutesContribution,scheduled-job: Capell\ShopifyCommerce\Manifest\ShopifyOAuthStatePruneScheduleContribution,scheduled-job: Capell\ShopifyCommerce\Manifest\ShopifyProductSyncScheduleContribution,setting: Capell\ShopifyCommerce\Manifest\ShopifyCommerceSettingsContribution. - Health checks:
Capell\ShopifyCommerce\Health\ShopifyCommerceHealthCheck. - Blade views:
packages/shopify-commerce/resources/views/filament/pages/connection.blade.php. - Cache tags:
shopify-commerce.
Data Model
Section titled “Data Model”- Required tables:
shopify_connections,shopify_oauth_states,shopify_products,shopify_product_variants,shopify_customers. - Protected tables:
shopify_connections,shopify_oauth_states,shopify_products,shopify_product_variants,shopify_customers. - Models:
ShopifyConnection,ShopifyCustomer,ShopifyOAuthState,ShopifyProduct,ShopifyProductVariant,ShopifyWebhookEvent. - Migration files:
2026_05_22_000001_create_shopify_connections_table.php,2026_05_22_000002_create_shopify_oauth_states_table.php,2026_05_22_000003_create_shopify_products_table.php,2026_05_22_000004_create_shopify_product_variants_table.php,2026_06_01_000001_create_shopify_customers_table.php,2026_06_18_000001_create_shopify_webhook_events_table.php. - Migration impact: run host migrations through the package install flow before opening package surfaces.
- Deletion/retention behaviour: Docs gap unless the package has an explicit pruning command, retention setting, or tested cascade path.
Install Impact
Section titled “Install Impact”- Admin navigation: adds package-owned Filament classes when registered.
- Permissions:
shopify-commerce.manage. - Public routes: route files exist and must be reviewed before public enablement.
- Database changes: package migrations are declared.
- Settings:
Capell\ShopifyCommerce\Settings\ShopifyCommerceSettings. - Queues or schedules: none detected in standard package paths.
- Cache tags:
shopify-commerce. - Commands:
capell-shopify-commerce:install,capell-shopify-commerce:prune-oauth-states,capell-shopify-commerce:sync,capell-shopify-commerce:sync-customers.
Common Pitfalls
Section titled “Common Pitfalls”- Run migrations before opening package resources or public routes.
- Configure package settings before testing production-like workflows.
- Review route middleware, throttling, signed URLs, and public-output safety before exposing routes.
- Run package commands from the host app; in this repository use
vendor/bin/pestfor package tests. - Keep
composer.json,composer.local.json,capell.json, docs, screenshots, and tests aligned when the package surface changes.
Troubleshooting
Section titled “Troubleshooting”| Symptom | Likely cause | Check | Fix |
|---|---|---|---|
| Package surface is missing after install | Provider or manifest is not loaded | Confirm capell.json, package composer.json, and provider registration | Reinstall the package, refresh Composer autoload, and clear host caches |
| Admin screen or command fails on missing table | Package migrations have not run | Check the tables listed in Data Model | Run host migrations and rerun the focused package test |
| Route returns unexpected output | Route cache, middleware, or signed URL setup does not match the package route file | Check the route files listed in Technical Shape | Clear route cache and verify middleware before exposing public routes |
| Background work does not run | Queue worker or scheduled command is not active | Check package jobs, commands, and host scheduler configuration | Start the queue or scheduler, then run the focused command or package test |
Quick Start
Section titled “Quick Start”- Install the package:
composer require capell-app/shopify-commerce. - Run the required setup:
php artisan capell-shopify-commerce:install. - Open the related Capell admin surface and verify Shopify Commerce appears.
Next Steps
Section titled “Next Steps”- Package docs
- Overview
- Screenshot contract
- Marketplace assets
- Capell content language plan
- Capell documentation design system
- Capell and package ERD notes
- Focused tests:
vendor/bin/pest packages/shopify-commerce/tests --configuration=phpunit.xml.