> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vortexiq.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Vortex Backup settings and field reference

> Manage Vortex Backup settings for real-time and manual backup across 19 Shopify entity types, plus the full per-field rollback reference and practical use cases for product, customer, collection, gift card, page, and blog rollback.

This page consolidates the V1 Settings, Field Reference, and Use Cases articles. The Settings section covers how to enable, disable, and trigger backups. The Field Reference section is the per-entity, per-field detail of what is restored. The Use Cases section gives practical scenarios where you would actually run a rollback.

<h2 id="settings">
  Settings \\
</h2>

The Settings page is where you control real-time backup (enable / disable per entity) and trigger manual backups for the entities that do not have webhook support.

The data entities are grouped into tab sections.

<img src="https://mintlify.s3.us-west-1.amazonaws.com/vortexiq/vortex-apps/vortex-backup/images/Settings1.png" alt="Settings tabs" />

### Catalogue data

* Products
* Collections

### Customer data

* Customers
* Orders
* Discount Codes
* Discount Automatic

### Content data

* Blogs
* Pages
* Files

### Settings data

* Themes
* Gift Cards
* Navigation Menus
* URL Redirects

### Commerce and markets data

* Markets
* Delivery Profiles (Shipping)
* Locations
* Price Lists
* Catalogs

### Metafield and metaobject data

* Metafield Definitions
* Metaobject Definitions
* Metaobjects

### Grid information

Each grid item displays as follows:

* **Entity** shows the name of the data backup entity (for example, Products).
* **Backup Type** shows whether the entity is Realtime or Manual.
* **Status** allows you to enable or disable real-time backup sync.
* **Date and Time** shows the date and time of the last sync status.
* **Action** displays the Backup button for Manual backup type only.

If you click the Status of a Realtime backup type entity and change it to Disabled, the app stops listening to webhook changes for that entity.

### Realtime backup enabled

<img src="https://mintlify.s3.us-west-1.amazonaws.com/vortexiq/vortex-apps/vortex-backup/images/Settings2.png" alt="Realtime backup enabled" />

Enabling real-time backup will display the dashboard as follows:

<img src="https://mintlify.s3.us-west-1.amazonaws.com/vortexiq/vortex-apps/vortex-backup/images/Settings3.png" alt="Dashboard with realtime active" />

### Realtime backup disabled

<img src="https://mintlify.s3.us-west-1.amazonaws.com/vortexiq/vortex-apps/vortex-backup/images/Settings4.png" alt="Realtime backup disabled" />

Disabling real-time backup will display the dashboard as follows:

<img src="https://mintlify.s3.us-west-1.amazonaws.com/vortexiq/vortex-apps/vortex-backup/images/Settings5.png" alt="Dashboard with realtime disabled" />

### Manual backup

Clicking Backup corresponding to a Manual backup type entity triggers the Backup Now popup so you can click Confirm to start the backup.

<img src="https://mintlify.s3.us-west-1.amazonaws.com/vortexiq/vortex-apps/vortex-backup/images/Settings6.png" alt="Manual backup popup" />

<img src="https://mintlify.s3.us-west-1.amazonaws.com/vortexiq/vortex-apps/vortex-backup/images/Settings7.png" alt="Manual backup confirmed" />

Take a full backup manually before any major changes by clicking the Backup button for the following data entities (which do not have webhooks and therefore no real-time backup):

* Discount Codes
* Discount Automatic
* Blogs
* Pages
* Files
* Themes
* Gift Cards
* Navigation Menus
* URL Redirects
* Markets
* Delivery Profiles
* Locations
* Price Lists
* Catalogs
* Metafield Definitions
* Metaobject Definitions
* Metaobjects

### Help button

Clicking the Help button opens the Help page in the knowledge base.

<h2 id="field-reference">
  Field reference \\
</h2>

This section provides detailed information about how each field is restored during a rollback operation.

### Products

#### Basic product information

| Field              | Restored | Rollback behaviour              |
| ------------------ | -------- | ------------------------------- |
| Title              | Yes      | Restored to saved value         |
| Description (HTML) | Yes      | Full HTML content restored      |
| Handle (URL slug)  | Yes      | Restored (ID used for matching) |
| Product Type       | Yes      | Category restored               |
| Vendor             | Yes      | Supplier name restored          |
| Tags               | Yes      | All tags restored               |
| Status             | Yes      | Active, Draft, Archived         |
| Product Category   | Yes      | Shopify category restored       |
| Template           | Yes      | Custom template preserved       |

#### SEO information

| Field           | Restored | Rollback behaviour           |
| --------------- | -------- | ---------------------------- |
| SEO Title       | Yes      | Search engine title restored |
| SEO Description | Yes      | Meta description restored    |

#### Product variants

| Field             | Restored | Rollback behaviour            |
| ----------------- | -------- | ----------------------------- |
| Title             | Yes      | Variant name restored         |
| SKU               | Yes      | Product code restored         |
| Barcode           | Yes      | UPC / EAN restored            |
| Price             | Yes      | Selling price restored        |
| Compare At Price  | Yes      | Original price restored       |
| Weight            | Yes      | Value and unit restored       |
| Requires Shipping | Yes      | Shipping flag restored        |
| Taxable           | Yes      | Tax setting restored          |
| Inventory Policy  | Yes      | Continue / stop when sold out |
| Option Values     | Yes      | Size, Colour, etc. restored   |
| Image             | Yes      | Variant image association     |

#### Inventory

| Field              | Restored | Rollback behaviour                |
| ------------------ | -------- | --------------------------------- |
| Available Quantity | Yes      | Stock levels restored by location |
| Location           | Yes      | Matched by location name          |
| Cost per Item      | Yes      | Unit cost restored                |

Inventory is matched by location name. Ensure location names match between backup and current store.

#### Product images and media

| Field     | Restored | Rollback behaviour          |
| --------- | -------- | --------------------------- |
| Image URL | Yes      | Image files restored        |
| Alt Text  | Yes      | Accessibility text restored |
| Position  | Yes      | Image order preserved       |

#### Custom fields (metafields)

| Field type         | Restored | Notes                          |
| ------------------ | -------- | ------------------------------ |
| Text fields        | Yes      | Single line and multi-line     |
| Numbers            | Yes      | Integer and decimal            |
| Dates              | Yes      | Date and datetime              |
| URLs               | Yes      | Link values                    |
| True / False       | Yes      | Boolean values                 |
| JSON               | Yes      | Structured data                |
| File references    | Separate | Requires file rollback first   |
| Product references | Separate | Referenced products must exist |

### Customers

#### Basic information

| Field          | Restored | Rollback behaviour              |
| -------------- | -------- | ------------------------------- |
| Email          | Yes      | Restored (ID used for matching) |
| First Name     | Yes      | Restored                        |
| Last Name      | Yes      | Restored                        |
| Phone          | Yes      | International format preserved  |
| Note           | Yes      | Internal notes restored         |
| Tags           | Yes      | All customer tags restored      |
| Locale         | Yes      | Language preference restored    |
| Tax Exempt     | Yes      | B2B status restored             |
| Tax Exemptions | Yes      | Specific exemptions restored    |

#### Addresses

All customer addresses are restored, including Address Line 1 and 2, City, Company, Country, Province / State, Zip / Postal Code, and Phone.

#### Marketing consent

Email and SMS marketing state, opt-in level, and consent date are all restored.

### Collections

Manual collections restore Title, Handle, Description, Sort Order, Template, Image, Alt Text, and Products. Smart collections restore Title, Handle, Description, Sort Order, Rules, and Rule Condition. Collection rules restore Column, Relation, and Condition.

### Gift cards

| Field             | Restored | Rollback behaviour              |
| ----------------- | -------- | ------------------------------- |
| Initial Value     | Yes      | Original amount                 |
| Expiration Date   | Yes      | If applicable                   |
| Note              | Yes      | Internal notes                  |
| Customer          | Yes      | Linked by original customer ID  |
| Recipient Message | Yes      | Gift message                    |
| Code              | New      | New code generated for security |

Original gift card codes cannot be restored. New codes are generated and must be communicated to customers.

### Pages, Blogs, Articles

Pages restore Title, Body HTML, Handle, Published, Published At, Template. Blogs restore Title, Handle, Comment Policy, Template. Articles restore Title, Body HTML, Summary, Handle, Author Name, Tags, Template, Featured Image, Blog Association.

### Files and media

Files restore File URL (via Azure Blob Storage SAS), Alt Text, Content Type (IMAGE / VIDEO / FILE), and Filename. Supported file types: images (JPG, PNG, GIF, WebP), videos (MP4, MOV), external videos (YouTube reference), 3D models, documents (PDF, etc.).

### Themes

Themes restore Name and Role. Settings may require manual verification. Theme files and customisations may need manual review after rollback.

### Discount nodes

Discount Type (Code or Automatic), Title, Status, Value, Applies To, Minimum Requirements, Usage Limits, Start / End Date, and Combination Rules are all restored.

### Navigation menus

Title, Handle, Menu Items, Nested Structure, and Item URLs are all restored.

### Markets

Name, Enabled, Regions, Currency Settings, and Web Presence are all restored.

### URL redirects

Path and Target are restored.

### Delivery profiles (shipping)

Name, Product Associations, Shipping Zones, and Location Groups are all restored.

### Locations

Name, Address, Fulfils Online Orders, and Active are all restored.

### Price lists

Name, Currency, Price Adjustments, and Catalog Association are all restored.

### Catalogs

Title, Status, Price List, and Context Rules are all restored.

### Metafield definitions

Name, Namespace, Key, Type, Description, Validations, Owner Type are all restored.

### Metaobject definitions

Name, Type, Description, Field Definitions, Display Name Key, Access are all restored.

### Metaobjects

Handle, Type, Field Values, Status are all restored.

<h2 id="use-cases">
  Use cases \\
</h2>

### Use case 1. Accidental product price change

Scenario: you accidentally updated the price on a specific product and need to restore the correct price.

Solution: identify the product's document ID, select the products index, roll back that specific product. Result: the product's pricing (including all variant prices, compare-at prices) is restored to the stored version.

### Use case 2. Product description corrupted

Scenario: a product's description was accidentally overwritten or corrupted during an edit.

Solution: find the product's ID, roll back. What gets restored: title and description (HTML), SEO title and meta description, all variant information, tags and categories.

### Use case 3. Deleted product recovery

Scenario: a product was accidentally deleted and you need to bring it back.

Solution: find the deleted product's ID from your stored versions, roll back. Result: the product is recreated with all its original data, including variants and images.

### Use case 4. Collection rules changed incorrectly

Scenario: you edited a smart collection's rules and now the wrong products are appearing.

Solution: identify the collection's ID, roll back. Result: smart collection rules restored, product matching conditions restored, collection settings restored.

### Use case 5. Customer data needs restoration

Scenario: a customer's information was incorrectly modified and you need to restore their original data.

Solution: find the customer's ID, roll back. What gets restored: customer name and contact info, all saved addresses, tags and notes, marketing preferences.

### Use case 6. Page content restoration

Scenario: someone edited your About Us page incorrectly and you need the previous version.

Solution: find the page's ID, roll back. Result: page content, HTML formatting, and all styling restored.

### Use case 7. Gift card restoration

Scenario: a gift card record was incorrectly modified.

Solution: find the gift card's ID, roll back. For re-created gift cards, new codes are generated for security; communicate new codes to affected customers.

### Use case 8. Blog article recovery

Scenario: a blog article was accidentally deleted or modified.

Solution: find the article's ID, roll back. What gets restored: article title and content, author attribution, tags, featured image.

### Use case 9. Navigation menu broken

Scenario: a navigation menu was incorrectly modified, breaking your site's navigation structure.

Solution: find the menu's ID, roll back. Result: all menu items and links restored, nested structure and hierarchy preserved.

### Use case 10. Shipping profile misconfigured

Scenario: a delivery profile was modified incorrectly, causing wrong shipping rates.

Solution: find the delivery profile's ID, roll back. Result: shipping zones and rates restored, product assignments to the profile restored.

### Use case 11. URL redirect broken

Scenario: a URL redirect was deleted or modified, causing 404 errors for customers.

Solution: find the URL redirect's ID, roll back. Result: source and target paths restored, redirect immediately active.

### Best practices

Before rolling back: verify the ID, check dependencies (if rolling back a collection, ensure referenced products exist), document changes (note what you are rolling back and why).

After rolling back: verify the item, test functionality, check related items.

## FAQ

### Should I disable real-time backup ever?

Most teams leave it enabled for all four real-time entities (Products, Collections, Customers, Orders). The toggle exists for the rare scenario where you are running a high-volume bulk operation that would generate a large queue of webhook events; you can disable real-time temporarily, run the bulk operation, then re-enable. Even then, run a manual full backup of the affected entity once the bulk operation is complete.

### How long does it take for a Disable to take effect?

It may take up to 10 minutes for the disable to fully take effect. Changes made just before disabling may still appear in the backup.

### Why is "Backup" the only Action button on Manual entities?

Manual entities have no webhook support, so there is no real-time toggle. The Backup button captures a full snapshot on demand. Run it before and after any major change.

## Related pages

* [Getting started](/vortex-apps/vortex-backup/getting-started), the four-step rollback walkthrough
* [Change logs and restore](/vortex-apps/vortex-backup/change-logs-and-restore), the audit log and Restore Centre
* [What we backup and rollback](/vortex-apps/vortex-backup/what-we-backup-and-rollback), per-entity coverage
* [Understanding the dashboard](/vortex-apps/vortex-backup/understanding-the-dashboard), the dashboard layout
* [FAQs and known issues](/vortex-apps/vortex-backup/faqs-and-known-issues), platform constraints