Installing the app

Installing takes a few minutes. Getting a good first result takes about ten — see the quickstart once you're through this page.

Before you start#

Shopify plan

any plan that supports apps. Shopify Plus is not required.

Theme

any Online Store 2.0 theme. Vintage themes can run the app embeds but not the section blocks.

Access

you need to be able to install apps and edit the theme, or have someone who can.

The scopes we ask for#

1. Catalog access — read_products, write_products, read_product_listings, read_inventory Titles, variants, SKUs, prices, inventory and product metafields: the data that gets indexed. The write scope creates two metafield definitions (wysync.universal_fit, wysync.fitment_note) so the fitment editor has somewhere to store your overrides.
2. Fitment storage — read_metaobjects, write_metaobjects Holds your fitment sources and mapping configuration inside your own store.
3. Theme — read_themes Detects whether the app's blocks are installed on your published theme. We never modify your theme's own templates.
4. Orders — read_orders Reads back the vehicle and verdict the app itself wrote as line item properties, for merchant reporting.
5. Customers — read_customers, write_customers One metafield, wysync.garage, so a logged-in shopper's saved vehicles follow them across devices. No other customer field is touched.
6. Publications — read_publications, write_publications Publishes generated vehicle landing pages to your Online Store channel. Unused if you never turn that feature on.

What happens immediately after install#

1. Your shop record is created and a Typesense collection is provisioned for it.
2. A full catalog index starts automatically. A 40,000-SKU store is usually finished within ten minutes; larger catalogs scale roughly linearly.
3. Your 30-day trial starts.
4. The admin opens on the Dashboard, which will show the index job running.

You can watch progress under Indexing. Products that fail to index are listed there with the reason, rather than disappearing silently.

Installing the storefront widgets#

Widget placement is done in Shopify's theme editor — it cannot be done from the CLI or by pushing theme JSON, because Shopify strips app block references from theme files pushed that way.

1. Open Storefront → Widgets in the app Each widget shows live install status for your published theme, plus a deep link that opens the theme editor at the right panel.
2. Turn on the app embed first The WySync app bootstrap embed loads the shared vehicle state. Nothing else works properly without it.
3. Add the section blocks you want Add section → Apps for the hero, collection replacement, fitment table and so on. See placing widgets for where each one belongs.
4. Publish Save the theme. Storefront changes go live immediately; extension version updates can lag by a minute or two.

Uninstalling#

Uninstalling from Shopify removes the app's access immediately and queues your data for deletion — see uninstalling for exactly what goes and when. Your products, collections, tags and metafields are untouched, because they were never ours.