Openship is an order router that connects the places where you're selling to the places where you're fulfilling. It automatically routes orders from your sales channels to your fulfillment partners, giving you complete control over your order flow.
Built on top of next-keystone-starter, which provides the foundational architecture for modern full-stack applications with KeystoneJS and Next.js.
Shops represent your online stores where your customers place orders (e.g. Shopify, WooCommerce, eBay, Amazon). Once connected, new orders can be routed to Openship to be fulfilled.
Channels represent destinations where your orders can be routed and fulfilled. A channel could be an existing platform like your supplier's Shopify shop or a 3PL fulfillment service. It could also be something very simple like adding a row to a Google Sheet or sending an email with the order details.
Links represent a connection between a shop and a channel. Once linked, new shop orders are forwarded to the linked channel for fulfillment.
For finer control over the fulfillment process, matches can be created on the product level. Matches represent a connection between your shop products and your channel products. When a match is created between a shop product and channel product, Openship will automatically process that order.
- Frontend: Next.js 15 with App Router
- Backend: KeystoneJS 6 with GraphQL API
- Database: PostgreSQL with Prisma ORM
- Styling: Tailwind CSS with shadcn/ui components
- Authentication: Session-based with role-based permissions
- Foundation: Built on next-keystone-starter
openship/
├── app/ # Next.js App Router
│ ├── dashboard/ # Admin interface
│ ├── (storefront)/ # Customer-facing pages
│ └── api/ # API endpoints and webhooks
├── features/
│ ├── keystone/ # Backend models and GraphQL schema
│ ├── platform/ # Admin platform components
│ ├── storefront/ # Frontend components and screens
│ └── integrations/ # Shop and channel integrations
└── components/ # Shared UI components
- Node.js 20+
- PostgreSQL database
- npm, yarn, pnpm, or bun
-
Clone and install dependencies:
git clone https://github.com/openship-org/openship.git cd openship npm install -
Configure environment variables:
cp .env.example .env
Update
.envwith your configuration:# Required - Database Connection DATABASE_URL="postgresql://username:password@localhost:5432/openship" # Required - Session Security (must be at least 32 characters) SESSION_SECRET="your-very-long-session-secret-key-here-32-chars-minimum" # Optional - SMTP configuration for email notifications SMTP_FROM="[email protected]" SMTP_HOST="your-smtp-host" SMTP_PASSWORD="your-smtp-password" SMTP_PORT="587" SMTP_USER="your-smtp-user" # Optional - Shop Integrations SHOPIFY_APP_KEY="your-shopify-app-key" SHOPIFY_APP_SECRET="your-shopify-app-secret" # Optional - Channel Integrations SHIPPO_API_KEY="shippo_test_..."
-
Start development server:
npm run dev
This will:
- Build KeystoneJS schema
- Run database migrations
- Start Next.js development server with Turbopack
-
Access the application:
- Dashboard: http://localhost:3000 - Order routing interface
- GraphQL API: http://localhost:3000/api/graphql - Interactive API explorer
-
Create your first admin user: On first visit to the dashboard, you'll be prompted to create an admin user account at
/init -
Connect your first shop and channel: After creating your admin account, start by connecting a shop (where orders come from) and a channel (where orders are fulfilled)
npm run dev- Build Keystone + migrate + start Next.js dev servernpm run build- Build Keystone + migrate + build Next.js for productionnpm run migrate:gen- Generate and apply new database migrationsnpm run migrate- Deploy existing migrations to databasenpm run lint- Run ESLint
- Automatic order routing from shops to channels
- Multi-channel fulfillment support
- Real-time order synchronization
- Flexible routing rules and conditions
- Shopify: Native integration for order import
- WooCommerce: WordPress e-commerce support
- Custom APIs: Build custom shop connectors
- Webhook Support: Real-time order notifications
- Shopify: Route orders to supplier Shopify stores
- 3PL Services: Integration with fulfillment partners
- Custom Channels: Email, Google Sheets, webhooks
- Dropshipping: Direct supplier integrations
- Intelligent product matching between shops and channels
- Bulk matching capabilities
- Variant-level matching support
- Flexible matching rules and exceptions
- Real-time order tracking and status updates
- Automated fulfillment workflows
- Error handling and retry mechanisms
- Comprehensive order history and analytics
For comprehensive technical documentation, see docs.openship.org/openship/ecommerce which covers:
- Complete integration guides
- API reference and operations
- Custom shop and channel development
- Webhook configuration and security
- Advanced routing configurations
Openship is production-ready and can be deployed to:
- Vercel: One-click deployment with the button above
- Railway: One-click deployment with the button above
- Docker: Containerized deployment with included Dockerfile
- Self-hosted: Deploy to any Node.js hosting environment
- Database optimization for high-volume order processing
- Background job processing for order routing
- Webhook reliability and retry mechanisms
- Monitoring and alerting for failed orders
This project is built on next-keystone-starter, which provides:
- Modern full-stack architecture
- KeystoneJS 6 integration with Next.js 15
- Authentication and session management
- Database setup with Prisma
- Development tooling and configuration
We welcome contributions! Please see our contributing guidelines for details on:
- Code standards and conventions
- Testing requirements
- Pull request process
- Issue reporting
This project is licensed under the MIT License - see the LICENSE file for details.
- Documentation: Check our comprehensive documentation at docs.openship.org/openship/ecommerce
- Issues: Report bugs and feature requests on GitHub Issues
- Community: Join our community discussions
- Enterprise: Contact us for enterprise support and custom integrations
Openship - Order Routing Platform
Built with Next.js 15 and KeystoneJS 6 on next-keystone-starter