Introduction
This user manual explains how to use the JSON format to import and export data in Omnium. This is useful for transferring data between test and production environments, and for troubleshooting.
Use Cases
- Data Transfer: Move data between test and production.
- Troubleshooting: Export and edit data locally for testing.
Supported Document Types for JSON
The following data types can be imported and exported:
- Orders
- Projects
- Project Types
- Custom dashboards (project dashboards)
- Stores
- Products
- Categories
- Purchase orders
- Deliveries
- Suppliers
- Private Customers
- Business Customers
- Customer club member
- Invoices
- Carts
- Promotions
- InventoryItems
- Inventory rules
- UnallocatedInventoryItems
- Subscriptions
- Event subscriptions
- Gift cards
- Notifications
- Ratings
- Vouchers
Exporting JSON Data
- Go to Configuration → Export → JSON.
- Select the desired document type from the dropdown.
- Enter one or more IDs (separated by commas). Note: You must know the ID of the object you want to export.
- Click Export.
- Click Copy to clipboard to copy the JSON. This copied JSON can then be pasted into the import form.
Importing JSON Data
- Go to Configuration → Import → JSON.
- Select the desired document type in the Type field.
- Paste the raw JSON data into the Data field.
- Click Import.
Important: The import will overwrite any existing documents with the same ID. Double-check your data before importing.
Tips and Recommendations
- Validate your JSON before importing (e.g., using jsonlint.com).
- Always test in the test environment first.