OmniSync Backend

Scalable Integration Platform for Shopware 6 & Amazon SP-API

---

🚀 Overview

OmniSync is a robust, modular monolith backend built with Laravel. It serves as the central integration hub connecting Shopware 6 e-commerce backends with Amazon Selling Partner API (SP-API) for seamless synchronization of products, orders, and inventory.

🛠 Tech Stack

Category	Technology	Description
Framework		Laravel 11.x / 12.x
Architecture	🧩 Modular Monolith	Powered by nwidart/laravel-modules
Database		Primary data store (JSONB support)
Queue		Laravel Horizon + Redis for background jobs
HTTP Client	🌐 Guzzle	For external API communication
Auth	🔐 Sanctum / Spatie	API Auth & RBAC
Testing	🧪 Pest	Testing framework

🏗 Architecture & Modules

The application follows a strict Modular Monolith architecture. All business logic resides within Modules/.

graph TD
    User((User/Admin)) --> AdminDashboard
    Shopware((Shopware 6)) <--> ShopwareIntegration
    Amazon((Amazon SP-API)) <--> AmazonIntegration
    
    subgraph "OmniSync Backend (/web)"
        Core[📦 Core Module]
        
        subgraph "Integrations"
            ShopwareIntegration[🛒 Shopware Integration]
            AmazonIntegration[📦 Amazon Integration]
        end
        
        SyncEngine[⚙️ Sync Engine]
        AdminDashboard[🖥️ Admin Dashboard]
        Reporting[📊 Reporting]
        Tenancy[🏢 Tenancy]
        
        AdminDashboard --> SyncEngine
        SyncEngine --> ShopwareIntegration
        SyncEngine --> AmazonIntegration
        
        ShopwareIntegration -.-> Core
        AmazonIntegration -.-> Core
        SyncEngine -.-> Core
        Reporting -.-> Core
    end

📦 Key Modules

• Core: Shared domain logic, base models, traits, exceptions, and events.
• ShopwareIntegration: Shopware 6 API client, webhooks, and sync jobs.
• AmazonIntegration: Amazon SP-API client, OAuth, and listing/inventory/order sync.
• SyncEngine: Orchestration, conflict resolution, and queued sync jobs.
• AdminDashboard: Livewire/Inertia UI for management.
• Tenancy: Multi-tenant provisioning and isolation.
• Reporting: Analytics and sync stats.

💻 Development Guidelines

Code Structure

• Domain-Driven Design: Modules\AmazonIntegration\Domain\Services\ListingCreator.php
• Communication: Events, Jobs, Commands. No direct coupling between modules.
• Logic: Keep controllers thin. Use Services/Jobs.

Quality Assurance

• Testing:

  ./vendor/bin/pest
  

• Formatting:

  ./vendor/bin/pint
  

⚙️ Setup & Installation

1. Install Dependencies

   composer install
   

2. Environment Config

   cp .env.example .env
   php artisan key:generate
   

3. Database Migration

   php artisan migrate
   

4. Run App

   php artisan serve
   

📄 License

Proprietary / [Insert License Here]