Skip to content
Kepvia LogoKepvia
Kepvia Technical Documentation

App Reference & Documentation

Explore technical specifications, JSON schema blueprints, restore mechanisms, and cross-store migration procedures for all 19 Shopify resource types.

19
Protected Resources
Real-Time
Webhook Deltas
1-Click
Point-in-Time Restore
0%
Storefront Overhead
22 guides
OverviewCore Engine

Architecture & How Kepvia Works

Kepvia is an automated data protection and migration platform purpose-built for Shopify. It communicates exclusively via Shopify’s official Admin GraphQL and REST APIs through isolated background worker queues.

Restoration Behavior

All data operations are non-blocking and streamed in constant memory to prevent browser timeouts or memory exhaustion during large operations.

Performance & Best PracticesKepvia never injects scripts, tracking pixels, or theme liquid tags into your online store. Your storefront performance, Lighthouse scores, and Core Web Vitals remain 100% unaffected.
OverviewAutomation

Automated Continuous Backups

Unlike traditional backup tools that only run once a day, Kepvia combines daily baseline snapshots with real-time webhook listeners to capture changes as they occur.

What is captured & preserved

Daily scheduled baseline full scans across all configured resources
Real-time webhook triggers that register deltas when products, themes, or pages are modified
Immutable snapshot creation that preserves historical state without overwriting good records
Configurable retention windows: 1 month (Free), 6 months (Starter), or 1 year (Pro & Enterprise)
Item-Wise ResourcesCatalog

Products & Variants

Plan: All Plans

Captures the complete product catalog including titles, handles, HTML descriptions, vendor, product types, tags, options, and all variant combinations.

Webhook Listeners:products/create, products/update, products/delete

What is captured & preserved

Product Core: ID, title, handle, body_html, vendor, product_type, status, tags, template_suffix
Variant Details: SKU, barcode, price, compare_at_price, position, inventory_policy, inventory_management, weight, weight_unit
Options: Option names (e.g. Size, Color) and attribute values
Inventory: Stock quantities mapped per configured location
Associated Media: Image gallery references, featured images, and alt descriptions

Restoration Behavior

When restoring a product, Kepvia allows single-product rollback or whole-catalog restore. If a product handle already exists, you can choose to overwrite live attributes or recreate the missing variant.

Migration Mapping

During migration to a second store, products are created with matching handles and variants. Media binaries are streamed directly to the destination store’s CDN.

schema-snapshot.json
{
  "id": 8920194812,
  "title": "Classic Oxford Cotton Shirt",
  "handle": "classic-oxford-cotton-shirt",
  "status": "active",
  "vendor": "Acme Apparel",
  "variants": [
    {
      "sku": "OXF-BLU-S",
      "price": "68.00",
      "inventory_quantity": 42,
      "option1": "Blue",
      "option2": "Small"
    }
  ]
}
Item-Wise ResourcesMedia

Product Media & High-Res Images

Plan: All Plans

Preserves original high-resolution product photography, 3D models, and video attachments in durable encrypted object storage, rather than merely saving transient CDN URLs.

What is captured & preserved

High-resolution original image source URLs and binary blobs
Media positions and gallery sequence ordering
Alt text tags for accessibility and image SEO
Embedded video URLs and 3D GLB model specifications

Restoration Behavior

If an image is deleted in Shopify, restoring the product automatically re-uploads the stored image binary to Shopify and re-attaches it to the proper variants.

Migration Mapping

When cloning to another store, media is transferred directly between servers without requiring you to download and re-upload gigabytes of photos.

Item-Wise ResourcesCollections

Smart Collections (Automated)

Plan: All Plans

Protects rule-based dynamic collections, including complex filtering logic, match conjunctions, sort orders, and promotional banner imagery.

Webhook Listeners:collections/create, collections/update, collections/delete

What is captured & preserved

Title, handle, body_html, and collection banner image
Rules Array: column (e.g. tag, title, price), relation (e.g. equals, starts_with), and condition
Disjunctive Flag: true (match any condition) vs false (match all conditions)
Sort Order: manual, best-selling, price-ascending, alphabetical, or created-descending
SEO metadata title and meta description tags

Restoration Behavior

Restoring a smart collection re-creates the definition rules and sort orders. Shopify then automatically populates the corresponding products based on the restored logic.

Item-Wise ResourcesCollections

Custom Collections (Curated Manual)

Plan: All Plans

Preserves manually curated product collections, custom sort positioning, and manual product inclusions.

Webhook Listeners:collections/create, collections/update, collections/delete

What is captured & preserved

Collection metadata: title, handle, description HTML, banner image
Product Collects: specific product IDs linked to the collection
Explicit manual ordering positions of each item

Restoration Behavior

Restores the collection wrapper and re-links every product back in its exact manual drag-and-drop sort position.

Item-Wise ResourcesContent

Content Pages & Landing Layouts

Plan: All Plans

Backs up all standard and custom landing pages, policy layouts, author attributions, and HTML formatting.

Webhook Listeners:pages/create, pages/update, pages/delete

What is captured & preserved

Title, handle/URL slug, author, published status
Raw HTML content markup and embedded styling
Assigned page template suffix (e.g. page.contact, page.faq)

Restoration Behavior

Safeguards against accidental page overwrites by page builder apps or team members. One-click restores previous HTML copy.

Item-Wise ResourcesEditorial

Blogs & Articles

Plan: Starter, Pro, Enterprise

Captures blog channels, comment moderation preferences, published articles, author tags, rich content, and featured hero images.

Webhook Listeners:blogs/create, blogs/update, articles/create, articles/update

What is captured & preserved

Blog: title, handle, comment moderation settings (moderated, open, closed)
Article: title, handle, author name, tags list, summary HTML, body HTML
Featured image URL, alt text, and published timestamp

Restoration Behavior

Restores deleted articles or accidental edits with author attribution and tags intact.

Item-Wise ResourcesStorefront

Navigation & Menus

Plan: All Plans

Captures your store’s header navigation, footer linklists, and deeply nested multi-level dropdown menu structures.

What is captured & preserved

Menu title and handle (e.g. main-menu, footer)
Nested menu items: title, URL, link type (collection, product, page, http)
Hierarchical child link arrays and display order

Restoration Behavior

A broken menu damages conversion instantly. Kepvia restores full navigation trees in seconds.

Item-Wise ResourcesCode

Themes & Liquid / JSON Assets

Plan: Starter, Pro, Enterprise

Complete backup of both your published live theme and all unpublished backup themes in your library, including all Liquid code, JSON templates, stylesheets, and assets.

Webhook Listeners:themes/create, themes/update, themes/delete

What is captured & preserved

Theme role (main live theme, unpublished backup themes, development themes)
Template files: templates/*.json, templates/*.liquid
Section definitions: sections/*.liquid
Snippets: snippets/*.liquid
Config schemas: config/settings_data.json, config/settings_schema.json
Assets: CSS, SCSS, JavaScript, font files, and icons
Locales: locales/en.default.json and translation files

Restoration Behavior

Preview code diffs before restoring. You can restore an individual modified Liquid file or duplicate the entire historical theme back into your theme library safely.

Performance & Best PracticesA theme restore can be directed to create a NEW unpublished theme instead of overwriting the live one, allowing safe verification before publishing.
Item-Wise ResourcesLegal

Store Policies

Plan: All Plans

Tracks legal policies configured in Shopify admin: Refund Policy, Privacy Policy, Terms of Service, Shipping Policy, and Legal Notices.

What is captured & preserved

Policy title, body content HTML, URL slug, and updated timestamp

Restoration Behavior

Roll back policy terms after unintended updates or during compliance audits.

Item-Wise ResourcesFiles

Files & Uploaded Media

Plan: Starter, Pro, Enterprise

Stores documents and media uploaded via the Shopify Admin Files section, including downloadable PDFs, size charts, lookbooks, banners, and vector assets.

What is captured & preserved

Filename, file size, MIME type, original URL, and binary content
Created and updated timestamps

Restoration Behavior

Restores deleted asset files directly back to your Shopify Files directory.

Item-Wise ResourcesCommerce

Orders & Sales Transactions

Plan: Starter, Pro, Enterprise

Historical order records, line items, fulfillments, transactions, notes, and financial states.

What is captured & preserved

Order details: order number, processed timestamp, financial status, fulfillment status
Line items: title, SKU, variant ID, quantity, price, discount allocations
Customer linkages, shipping and billing addresses
Payment transactions and order timeline notes
Performance & Best PracticesProtected Customer Data access: Access to customer personal information in orders requires Shopify protected customer data approval.
Item-Wise ResourcesCustomers

Customers & Customer Segments

Plan: Starter, Pro, Enterprise

Customer directories, lifetime metrics, contact details, tags, addresses, and saved customer segmentation queries.

What is captured & preserved

Customer profile: first name, last name, email, phone, marketing consent states
Shipping and billing address books
Metrics: orders count, total spent, customer currency
Segments: Shopify customer query language (CQL) formulas and segment names
Item-Wise ResourcesAdvanced

Metaobjects (Custom Data Models)

Plan: Starter, Pro, Enterprise

Structured custom data definitions, schema validations, and all dynamic entry records created via Shopify Metaobjects.

What is captured & preserved

Definition: type handle, name, display name, description, access controls
Field definitions: name, key, type (e.g. rich_text, reference, color, number), validation rules
Metaobject entries: handle, status, field values, and referenced entity IDs

Restoration Behavior

When restoring, Kepvia recreates definition schemas first if missing, then maps and restores all entry records with validation checks.

schema-snapshot.json
{
  "type": "creator_profile",
  "name": "Creator Profile",
  "fields": [
    { "key": "bio", "type": "multi_line_text_field" },
    { "key": "instagram", "type": "url" },
    { "key": "featured_product", "type": "product_reference" }
  ]
}
Item-Wise ResourcesAdvanced

Metafield Definitions & Values

Plan: Starter, Pro, Enterprise

Namespace/key schemas, pinned definitions, and attribute values attached across products, variants, collections, pages, customers, orders, and shop-level settings.

What is captured & preserved

Metafield definition: namespace, key, name, description, type, pinned flag
Owner resource ID and type (Product, Variant, Collection, Page, Customer, etc.)
Value payload and type validation constraint

Restoration Behavior

Restores metafield definitions and reapplies values to their respective owner records.

Item-Wise ResourcesSettings

Shipping Zones & Rates

Plan: All Plans

Geographic shipping zones, country and province selections, weight-based rates, flat rates, and carrier service links.

What is captured & preserved

Zone name, countries list, sub-regions (states/provinces)
Rate conditions: weight ranges, price thresholds, shipping cost amounts
Restore EngineRecovery

1-Click & Granular Restoration

How to roll back an entire store or pinpoint individual deleted records without overwriting unaffected store assets.

What is captured & preserved

Item-level restore: browse historical versions of a single product or collection and restore just that item
Side-by-side diff highlight: compare live Shopify data against the snapshot version with highlighted additions and deletions
Point-in-time full recovery: restore the entire catalog, themes, and configuration back to a specific timestamp
Undo functionality: every bulk restore creates an activity log entry with a 1-click Undo action
Performance & Best PracticesRestores run on background workers. You can close your browser or navigate away without interrupting the recovery process.
MigrationCloning

Store-to-Store Migration Process

Step-by-step workflow for cloning a full backup or selective resources into a staging store, expansion market, or client account.

What is captured & preserved

Step 1: Obtain an Admin API token in the destination store and connect in Kepvia
Step 2: Pre-flight handshake automatically verifies API permissions, read/write scopes, and store status
Step 3: Select whether to clone the full store or selectively pick resource categories
Step 4: Monitor background worker progress with real-time log streaming and old-to-new ID mapping
Performance & Best PracticesTarget store tokens are encrypted with AES-256 at rest and only decrypted in memory on the active worker.
MigrationCustom App

How to Get an Admin API Access Token (Custom App)

Plan: Starter, Pro, Enterprise

Step-by-step instructions for creating a Custom App in your target Shopify store and obtaining an Admin API Access Token required for store-to-store migration.

Step-by-Step Instructions

01

Log in to the destination Shopify store

Log in to the Shopify Admin panel of the destination store where you want to migrate or clone data (e.g., Development, Staging, or a new Regional store).

02

Navigate to Apps and Sales Channels settings

Access your store’s app development settings from the bottom-left gear menu.

  • Click Settings (⚙️ gear icon) in the bottom-left corner of the Shopify admin.
  • Select "Apps and sales channels" from the left-hand navigation menu.
  • Click the "Develop apps" button in the upper-right corner.
  • (If opening for the first time, click "Allow custom app development" to confirm).
03

Create a new Custom App

Create an internal app dedicated to data migration.

  • Click the "Create an app" button.
  • Enter an App name (e.g. "Kepvia Migration" or "Store Sync").
  • Select an App developer from your team and click "Create app".
04

Configure API Scopes and Permissions

Click "Configure Admin API scopes" and enable Read & Write permissions for all resources you plan to migrate:

  • Products: write_products, read_products
  • Product listings: read_product_listings
  • Themes: write_themes, read_themes
  • Files & Content: write_files, read_files, write_content, read_content
  • Metaobjects: write_metaobjects, read_metaobjects
  • Publications, Orders & Customers: check according to your migration needs
  • Click the "Save" button in the top-right corner to apply the permissions.
05

Install App and generate Access Token

Install the app to reveal and copy your Admin API access token:

  • Navigate to the "API credentials" tab at the top.
  • Click the "Install app" button and confirm the installation modal.
  • Under the "Admin API access token" section, click "Reveal token once".
  • Copy the token string (it starts with "shpat_xxxxxxxxxxxxxxxxxxxxxxxx").
⚠️
Important Note: Shopify will only display this token ONCE. Copy and save it in a secure password manager or paste it directly into the Kepvia Migration page. If lost, you will need to uninstall and recreate the app.
schema-snapshot.json
# Example Shopify Admin API Access Token format
shpat_a1b2c3d4e5f67890123456789abcdef0
ExportsCloud Sync

Exports & Google Drive Cloud Delivery

Your store data belongs to you. Kepvia allows direct ZIP archive downloads and automated cloud delivery to external storage providers.

What is captured & preserved

On-Demand ZIP Download: package selected resources or the full catalog into standalone ZIP files
Scheduled Google Drive Delivery (Pro & Enterprise): automated weekly or monthly export archives delivered directly into your Google Drive folder
Archive Import: import any Kepvia ZIP archive into another store to restore state
SecurityCompliance

Security, Privacy & Shopify Compliance

Details on encryption standards, Shopify App Bridge authentication, and GDPR webhook handling.

What is captured & preserved

Shopify OAuth authentication — no passwords or manual API keys stored for the primary store
AES-256 encryption at rest for migration destination tokens and stored payload records
Mandatory GDPR Webhooks: customers/data_request, customers/redact, and shop/redact implemented fully
Zero storefront injection: 0KB JavaScript on your public theme, zero impact on page load times

Ready to safeguard your Shopify store?

Install Kepvia in seconds. Free forever plan available with automated daily backups.