Integration
After connecting Shopify in Clerk.io, this page is your reference for the Shopify-specific sync settings in my.clerk.io > Data > Configuration.
Use this guide together with Get Started and Sync Data.
Settings reference #
This is a complete lookup reference for Shopify sync settings in my.clerk.io > Data > Configuration.
Sync method #
Choose which Shopify connector type you are using. Most setups should use Shopify from the Dev Dashboard flow.
Shopify domain #
The store’s .myshopify.com domain, for example example-store.myshopify.com. You can find it in Shopify admin and in the store URL.
Shopify API Key #
The API key from the Shopify app you created for Clerk.io in the Shopify Dev Dashboard.
Shopify API Access Token #
The access token from the same Shopify app. Clerk.io uses it to read sync data.
Shopify API Secret Key #
The API secret key from the same Shopify app.
Default Image Size #
Controls which Shopify image resolution Clerk.io imports.
Common formats:
800x800800x
Shopify generates image sizes on demand. If the source image ratio differs, Shopify returns the closest matching size.
Shop Market #
Use this when the store uses Shopify Markets. Enter the market name exactly as configured in Shopify (for example Denmark, Europe, or United States).
Markets can affect available products, prices, languages, and inventory context.
Shop Locale #
Use this for multi-language setups. Enter the standardized 2-letter language locale code (for example da, sv, es).
Use language code, not country code.
If you are unsure which locale to use, ask Shopify Sidekick for the locales configured on the store.
Prefix Urls with Locale #
Controls whether localized URLs include the locale path prefix.
Example:
Yes:/da/product-nameNo:/product-name
Force Relative Urls #
Controls whether Clerk.io imports relative URLs or full absolute URLs.
Yes: force relative pathsNo: allow full URL with domain
Custom attributes #
Comma-separated list of additional Shopify attributes to import, including meta fields and other custom attributes.
Inventory Locations #
Comma-separated list of one or more inventory locations to sync from Shopify.
Use this when product availability differs by warehouse/location.
Include Pages #
Imports Shopify pages as page objects in Clerk.io, including content like blog pages and other CMS pages.
Include All Out-Of-Stock Products #
If enabled, products that are fully out of stock are still imported.
Include Continue Selling When Out-Of-Stock Products #
Controls whether products using Shopify’s “continue selling when out of stock” behavior are imported.
Shopify Published Status #
Controls which product publish states are eligible for import.
Typical usage:
- only published products
- all products (including unpublished)
Shopify Category Published Status #
Same as above, but for category publish state.
Shopify Pages Published Status #
Same as above, but for page publish state.
Sync Time #
Sets the schedule window for the next sync run (UTC).
Enable Realtime Updates #
If enabled, Clerk.io receives updates from Shopify as changes happen (for example stock or price changes), instead of waiting for the next full sync cycle.
Only Import In Stock Variant Data #
Controls whether variant-related attributes should include only in-stock variants.
Example variant output:
variant_names:["Xs", "M"]variant_option_size:["Xs", "M"]variant_stocks:[1, 7]variants:["55970989179259", "55970989244795"]
When the setting is Yes, variant lists only include in-stock variants.
Separate Variant Options #
Splits variant options into separate attributes so each option can be used independently in filtering and designs.
Order History #
Controls how much historical order data is imported per run.
Available ranges include:
- 1 month
- 3 months
- 6 months
- 1 year
- all time
A common approach is all time for the first import, then a shorter period (for example 1 month) for recurring imports.
Import Tags #
Controls tag import strategy.
Available modes:
- import all tags
- exclude specific tags
- include specific tags
- do not import tags
Specific Tags #
Comma-separated tags used when Import Tags is set to include/exclude specific tags.
Destructure Tags Separator #
Character used to split tag name and value when destructuring tags.
Example:
- Tag:
sale_10 - Separator:
_
Destructure Tags Prefix #
Prefix removed from destructured tags before storing the value.
Using sale_10 with separator _ and prefix sale allows using 10 as the value.
Include Subscriber State #
Imports subscriber state for customers (newsletter/subscription state) when available from Shopify.
Import Parcels & Order Statuses #
Imports parcel/tracking information and order status values from Shopify.
This data is used by Chat when answering shipping and order-status questions.
Uninstalling #
Below you’ll find a guide on removing tracking scripts and general steps to uninstall Clerk from your Shopify store.
Removing tracking scripts #
To remove Clerk tracking from your webshop, you’ll need to remove both the Visitor and Sales tracking scripts from your Shopify theme files and " Additional Scripts" section.
- First, you’ll remove your visitor tracking scripts from the theme file where you initially placed the embed code during setup.
Visitor Tracking is likely within the webshop’s “theme.liquid”, “index.liquid” file.
You can access this file by logging into your Shopify admin portal, then select “Online Store” > “Themes”. Then, under “Live Theme”, choose “Edit Code” from the “Actions” dropdown.
Locate your main theme file, then find the Visitor Tracking script, and delete:
- Next, you’ll need to remove both tracking scripts from the " Additional Scripts" section.
You can find this in your Shopify admin portal by clicking “Settings” at the bottom-left corner. Then, simply delete both scripts from the “Additional Scripts” text box.
Updating private app permissions #
You can also change the permissions for the Clerk private app you created during setup to ensure there is no access to the specified data fields.
You can find your app’s API permissions by logging into your Shopify admin portal, selecting “Apps” > “Manage Private Apps” > “Clerk.io”.
In “Admin API Permissions”, adjust each of these dropdowns where they currently say “Read Access” to “No Access”:
Updating my.clerk.io #
You can also remove the Shopify API Key, password, and secret from your store’s my.clerk.io backend.
Log in, choose “Data” from the left side menu, and go to “Configuration”. Be sure to click “Save” once done: