Openship 3.0 🎉

Release v3.0

🚀 New Features

• Complete UI Overhaul with Tailwind CSS

  Rebuilt the entire user interface from scratch using Tailwind CSS (and shadcn/ui), ensuring a modern, responsive, and customizable design. This overhaul enhances the user experience with faster load times and a more consistent look and feel across all components.

• Enhanced Integration with Shop and Channel Platforms

  Introduced shopAdapters and channelAdapters folders to streamline integrations with various e-commerce platforms and sales channels. These adapters abstract the complexities of different APIs, allowing easier and more scalable connections. New channel and shop platforms can be integrated by adding to them as files to these folders.

• Inventory and Price Synchronization

  Added inventory and price syncing for matches. This allows users to keep inventory and prices in sync based on the created matches.

• Advanced Linking Between Channels and Shops

  You can now link multiple channels to a shop and add filters. This works in two modes:

  1. Simultaneous mode: Send orders to all connected channels that match the order's filters.
  2. Sequential mode: Channels are ranked, and Openship checks each in order. The order goes to the first channel where filters match.

  This flexibility lets you create powerful custom fulfillment workflows.

🛠 Improvements

• Database Schema Enhancements

  Updated models for Channel, Shop, and related entities with new fields and relationships. Added unique constraints and indexes to optimize query performance and maintain data integrity.

• API Enhancements

  Introduced new API endpoints for order management, webhook handling, and tracking. Deprecated outdated routes to streamline API interactions and improve security.

• Performance Optimizations

  Refactored key components to reduce load times and improve responsiveness. Optimizations in data fetching and state management contribute to a smoother user experience.

🐛 Bug Fixes

• Resolved issues with order filtering that caused inaccuracies in displayed data.
• Fixed UI glitches in the dashboard when accessing multiple channels simultaneously.
• Addressed synchronization errors that led to inconsistent inventory counts.
• And more...

📚 Migration Notes

Recommended Migration Path:

1. Set up a new environment for v3 alongside your existing v2 setup
2. In the v3 environment:
   • Add your shops and channels
   • Use the GraphQL API to migrate your matches
3. Go to the Shops and Channels page in the v3 dashboard UI
4. For each shop and channel:
   • Delete old webhooks
   • Create new webhooks
5. New orders will now come into v3
6. Continue processing existing orders in v2
7. Once all v2 orders are processed, shut down the v2 server and fully switch to v3

Breaking Changes:

• Changes to database schema for shops and channels
• Updates to API endpoints and responses
• Modifications to authentication mechanisms
• Custom channels and shops work differently now and will need to be tweaked

Alternative Upgrade Method (Use with Caution):

Note: It is possible to upgrade your existing v2 installation by pulling the v3 changes directly. However, this method carries risks:

• Your database might be wiped due to breaking changes
• Ensure you have a complete backup of your data before attempting this method
• This approach is recommended only for advanced users who are comfortable resolving potential conflicts and data migration issues

Access to Openship v2:

If you need to access the v2 version of Openship, it can be found in the v2 branch: https://github.com/openshiporg/openship/tree/v2

Openship 2.0 🎉

Rebuilt from ground-up using Next.js, Keystone.js, and Mantine. New features:

• Revamped website and docs
• Openship is multi-tenant now
• GraphQL API
• Mobile mode
• Dark mode