What is Catalog Versioning?
Catalog versioning lets you create separate working copies of your catalog. Think of it like making a draft copy of an important document—you can edit the copy without affecting the original, then merge the changes back when you’re ready. This is especially useful when you want to:- Test product changes before customers see them
- Reorganize your catalog structure
- Work on seasonal updates while keeping current catalog live
- Experiment with different product descriptions or pricing
- Make large-scale changes with a safety net
How Versioning Works: Fork, Edit, Merge
1. Fork (Create a Version)
Forking creates an exact copy of your catalog at that moment in time.- Your main catalog remains unchanged and continues serving customers
- Your fork is a separate working copy where you can make any changes you want
- Changes in the fork don’t affect the main catalog
2. Edit (Make Changes)
In your forked version, you can:- Add new products
- Edit existing products
- Remove products
- Change prices
- Update descriptions
- Reorganize everything
3. Merge (Apply Changes)
Merging brings your changes from the fork back into the main catalog. Once you’re happy with your changes and everything looks good, you merge the fork back. The main catalog updates with your changes and customers see the new version.When to Use Versioning
✓ Use Versioning When:
- Making structural changes (renaming products, reorganizing attributes)
- Testing significant price or description updates
- Preparing seasonal catalog updates
- Working on large reorganization projects
- Multiple team members working on different changes simultaneously
✗ Don’t Need Versioning When:
- Making small, quick fixes (just edit directly)
- Adding a few new products (just add them)
- Making one-off changes that need immediate release
- You’re confident in what you’re changing
Step-by-Step: Create and Merge a Version
Creating a Fork
- Open the catalog you want to version
- Click the “Version” or “Create Fork” button
- Give your fork a descriptive name (e.g., “Summer 2025 Update”, “Price Testing”, “New Descriptions”)
- Click “Create”
Working in Your Fork
- Switch to your fork (you’ll see which version you’re in at the top)
- Make all your changes—add products, edit descriptions, update prices, etc.
- Take your time. Test everything. There’s no rush.
- When you’re happy with your changes, you’re ready to merge
Reviewing Before Merge
Before merging back to the main catalog:- Compare your fork to the main catalog—most systems show a side-by-side comparison
- Look for any unexpected changes
- Verify prices, descriptions, and product names are correct
- Check that the structure looks good
- If you find issues, go back and fix them in the fork
Merging Your Fork Back
- In your fork view, click “Merge” or “Request Merge”
- Confirm which version you’re merging into (usually your main catalog)
- Review the merge summary
- Click “Confirm Merge”
Real-World Examples
Example 1: Seasonal Update
Example 2: Wholesale vs Retail
Example 3: Multi-Team Changes
Important Concepts
What Happens When You Fork?
- Copied: All products, attributes, descriptions, images, prices
- Preserved: The exact state at fork time
- Not Copied: Customer orders or published status
What Gets Merged?
When you merge a fork back:- All new products you added
- All edits you made to existing products
- All deletions
- Product order/organization
- But NOT: Customer data, order history, integration connections
Can I Have Multiple Forks?
Yes! You can create multiple forks from the same catalog. This is useful when:- Multiple team members are working on different updates
- You want to A/B test two different approaches
- You’re preparing multiple seasonal collections
What If There Are Conflicts?
A conflict happens when:- You edit a product in your fork
- Someone else edits the same product in the main catalog while you’re working
- The system doesn’t know which version to keep
Can I Delete a Fork?
Yes! If you decide not to merge a fork:- Open the fork
- Click “Delete Fork” or “Discard”
- Confirm
When Versioning Saves the Day
Scenario 1: Oops, Wrong Changes- You made changes in a fork but realized they’re wrong
- Solution: Delete the fork, start over
- Your main catalog? Perfectly fine—untouched the whole time!
- You and a colleague both need to update the catalog
- Solution: Each create your own fork, work in parallel, merge separately
- No stepping on each other’s toes!
- You’re preparing a major seasonal catalog update
- Solution: Create a fork, make all changes, review thoroughly, then merge when ready
- Confidence that everything’s correct before customers see it!
Best Practices for Versioning
Do:- Use descriptive fork names (what are you changing?)
- Review changes before merging
- Keep forks focused on one type of change when possible
- Delete forks you’re not using anymore
- Communicate with your team about active forks
- Keep old forks around forever (clean them up)
- Merge back without reviewing changes
- Create a fork for every tiny edit (use direct editing for quick fixes)
- Forget to merge when you’re done (updates sit in forks indefinitely)
For Technical Users
For detailed information about versioning architecture, API integration, and advanced workflows, see our Catalog Management Guide and Catalogs Concepts.Next Steps
- Publishing your catalog — Make your changes live for customers
- Adding products — Add items to your versions
- Importing products — Bulk upload products to your versions