Locksmith uses the idea of locks to restrict access to specific content in your store. You can granularly control which content is restricted by adding a lock to the applicable resource.

Use the search bar within Locksmith to place a lock on any content within your Shopify "Online Store". To use it, search for your resource by name:

What is searchable

Here are the types of resources that you are able to lock (and search for) from within Locksmith:

• Products

• Collections

• Pages: more info on Shopify pages here

• Variants: more info on Shopify product variants here

• Blogs: more info on Shopify blogs here

• Blog posts (also called articles): You must tag an article first, and then the article tag will be searchable. More info on blog posts here

• Product vendors

Specifying a resource type when searching

Locksmith allows you to specify the resource type to search for. This is helpful when you get many results from search term, but they aren't what you're looking for.

Try this syntax in the search bar:

• product:snowboard

• collection:snowboards

• page:about snowboards

• blog:life is snowboarding

What is not searchable

• Product tags: to lock a group of products with the same tag create an Automated Collection, and then lock the collection using Locksmith.

• Third party apps

• Any page that is not located inside of your Online Store

• Menus and menu links: Menu links are not directly searchable, but they can still be hidden from unauthorized access, as long as they point to one of the resource types in the list at the top of this page. In this case, just make sure the option to "Hide any links to this [resource] in your shop’s navigation menus" is turned on (under Settings) for the corresponding lock.

Locking your entire store

Simply click into the search bar:

Once you do that, you'll see "Entire store" show up in the dropdown as an option to lock:

Excluding resources form the store lock

The store lock's settings page has a few options for excluding resources from the store lock, so they remain accessible to everyone. Those options include:

• Allow access to the home page

• Allow access to policy pages

• Allow access to customer areas

For resources that you would like to exclude form the store lock that aren't covered by those lock options, we have guide on excluding content from locks here:

Locking all products in your store

By default, Shopify stores feature an 'All' collection that automatically encompasses all products in the store. Locking this collection offers an efficient method to secure all products in your Shopify store simultaneously, without the need to lock the entire store. This collection can be locked just like any other collection. Search for the collection title 'all', select 'Collection: All' from the list of results, and follow the steps to create your lock.

Still having trouble?

If you are searching for something like a product or a collection (or something else that is definitely searchable), and it just isn't showing up, you may just need to switch up your search terms.

• Try using fewer (but more specific) search terms.

• Keep in mind that pasting in the URL of the item you are trying to search will not work in most cases, you will need to search by name.

• For variants that aren't appearing in search results, try including some information about the variant option. For example: "Color" equals "blue".

Updating Locksmith

If you've created something recently and it's not showing up, an update to Locksmith can help.

1. Open the Locksmith app and navigate to the "Help" page 2. Click on the "Update Locksmith" button:

3. When the green bar at the bottom of the screen disappears, the update is finished. This should only take a handful of seconds.

A note about Liquid locks

Locksmith also gives you the ability to create "Liquid locks". This can allow you to target nonstandard resources or groups of pages in your store with Locksmith locks that are otherwise not directly searchable. You can start a Liquid lock by clicking into the search bar and selecting "Start a Liquid Lock":

If you think a Liquid lock could help you, try your hand at some Liquid code, or you can always write in to us for any questions about a specific use case.

Our more in depth guide on that is here:

As always, if you have questions or issues please feel free to get in touch with us at team@uselocksmith.com.

Locksmith works in and around the online storefront theme layer – an arena shared by many, many other apps. Locksmith's interoperability is excellent; its internal Liquid engine is very good at injecting its code in the right places, without causing issues for themes or apps. Because of this, in the vast majority of cases, you won't need to worry about Locksmith's compatibility.

Having said that, there are a few places where there are specific points of compatibility or incompatibility.

Locksmith and the Shop App

We're pleased to announce that Locksmith is now compatible with the Shop app. Shopify has updated its policies to allow stores using Locksmith to remain eligible for the Shop app, provided all other Shop app eligibility requirements are met.

Shopify's policies prohibit the use of password control and age verification apps, such as Advanced Registration, B2B Login Access Management, Login to View Price, and MagicPass Wholesale, for stores wishing to use the Shop app. However, Locksmith is now explicitly listed as an exception to this rule.

When you use Locksmith to lock certain products, your store will still remain eligible to display on Shop, and your locked products will not be included in your Shop Store. This ensures that merchants can maintain the control Locksmith provides while remaining eligible for the Shop app.

For more details on Shop app eligibility requirements, including prohibited product types or other restrictions, please refer to Shopify's Shop app eligibility requirements. Variant Locks and the Shop App

Locksmith’s variant-level locks don’t automatically remove locked variants from the Shop app, as the app manages visibility at the product level. While Locksmith adds a metafield to exclude locked products or collections from the Shop app, Shopify doesn’t support sales channel visibility controls for individual variants.

If a product includes locked variants, the Shop app will flag it with a warning (“This product is hidden by a third-party app”) and prevent it from being listed.

Workaround for Variant Visibility on the Shop App To keep unlocked variants available while hiding locked ones, you can create duplicate products:

• One product with only unlocked variants, published to the Shop app.

• Another product with locked variants, excluded from the Shop app.

This solution offers greater control but may increase inventory management complexity. For guidance on using duplicate products, refer to our tutorial on price tiers. You can also explore inventory management tips.

Officially unsupported apps

The following apps have known compatibility issues with Locksmith - although they may work in some cases, with the correct settings.

• Any other access control apps that work in a similar way to Locksmith will almost certainly not work well alongside Locksmith, as they tend to inject code into the same areas of your theme.

• Bold Custom Pricing: Wholesale - but only when using Locksmith's variant locking and manual locking features.

• Any app that controls price at the variant level - but only when using Locksmith's variant locking and manual locking features.

• Locksmith's manual locking feature, and many times full-page locks, can not generally be used to hide content being displayed by other third-party apps, including prices, buttons, widgets etc.

• Gempages - while it is possible to use the apps together in some cases, there are still many compatibility issues between the two apps.

• Weglot - Locksmith's location detection key condition is not compatible with Weglot, but you should otherwise be fine using both apps at the same time if not using location detection.

Other areas of incompatibility

• Predictive searches - Locksmith generally cannot remove products from searches that dynamically show search results as you type. This includes built-in theme searches, and most apps that add predictive searches to your theme. That being said, it is possible to manage the appearance of specific products in store searches using product metafields: more information on that here.

• The Checkout area - Apps are pretty heavily limited in their ability to make changes to the checkout area, for security reasons. This means that Locksmith cannot restrict access to payment methods, shipping methods, shipping addresses, or anything else that is shown during the checkout process. If you wish to use Locksmith to restrict customers ability to check out,

  you now have two options:

  1. Use Locksmith on the cart page, before checkout begins. This is the traditional approach—more on that here.

  2. Use our checkout validation feature, which allows you to set up a single rule: products with a specific tag can only be purchased by customers who have a specific customer tag. This can help block unauthorized purchases—without modifying the checkout UI itself. Learn how to set that up here.

• Protecting against bot/resellers - Locksmith can’t fully prevent purchases made by bots or resellers—especially when they’re using direct-to-checkout links, which bypass the Online Store entirely. Since Locksmith works within the Online Store channel, it can’t intervene at the checkout layer directly. However, we do now offer a checkout validation feature, which can help you block unwanted purchases after a customer reaches checkout. This is a powerful way to add another layer of control over who gets to buy what. Learn how to set it up here: Setting up checkout validation with Locksmith There are also other strategies you can use alongside Locksmith to reduce the risk of bot purchases. While these aren't built into Locksmith itself, we've outlined a helpful approach here: Protecting against bots (without using Locksmith directly)

• Locksmith cannot block RSS feeds from locked blogs.

• Locksmith can only hide products published to the Online Store sales channel, and absolutely cannot help with protecting, hiding, or restricting purchases on other channels.

Use the arrow on the sidebar to browse the full list, or simply use the search bar in the header to quickly find the topic that you're looking for!

Locks

Locks are created using the search bar within our Locksmith app. You can search for most resources in your store by name. More in depth information on the in-app search bar here:

A lock restricts access to something on your shop.

You can lock:

• Your entire shop

• Pages

• Products

• Collections

• Prices - more information here.

• The shopping cart

• The login page

• The registration page (type 'register' into the Locksmith search bar)

• Product variants

• And more, with custom Liquid locks: Create a custom lock by clicking the Start a Liquid Lock link above the Locksmith search bar..

After searching, once you select the search result you want to hide and click Save. You'll see some useful options, such as:

• Is the lock currently active?

• Should it also protect the products in this collection? (Disabling this means only the collection page itself will be locked.)

• Should it hide the collection, and it's products, from search results and other lists?

• Should it hide links to this resource from navigation?

• Under Advanced: Is this a manual lock? (More on that here.)

You'll see different options depending on what type of resource you’ve locked.

Keys

A key permits access to the locked resource based on your criteria. They are created on the lock page using the "+ Add key" button:

Keys allow you to specify the exact conditions that give your customers access to the locked resource.

• Check out the full list of keys in the dropdown menu on a lock page.

• You can also create your own custom keys with Liquid. Create a custom key by choosing custom Liquid from the keys menu.

More information on creating keys here:

Chaining (Combining) conditions together: OR versus AND

Locksmith gives you flexibility to add multiple keys and logically combine them together to create unique unlock conditions.

OR

• When you set up your key, you can create another key right away, by clicking on Add Another Key. This button allows you to add another separate key to your lock.

• Keys connected by the OR operator can individually open your lock whether or not the conditions on the other keys are met.

This allows you to specify multiple different conditions that a customer can use to access. When used, a customer only needs to meet one of the conditions in order to access.

Notice that there are multiple key symbols, and each key is preceded by "Permit if the customer..." text:

AND

• Adds another condition to the current key. Choose your first key, and click on the "+ add key condition" below the condition. You'll see another selector to add your next condition.

• If you connect key conditions with AND, all of those conditions must be met before the visitor gets access.

Notice that there is only one key symbol for each key, and each condition is inset under the symbol and text:

Inverting Keys

Use the inverse of a key for added flexibility.

• In the key, click the "invert" box in the upper right.

• This creates the opposite effect for the key.

• For example: Permit if the customer is not visiting from the United States. --When used on the Locations key.

Our guide that explains this a bit more is here:

The "force open other locks" setting

If you have created several locks that cover overlapping content (e.g. locked collections with some of the same products inside), you may want to turn ON the "force open other locks" key setting. This setting tells Locksmith to grant access to all of the content covered by the current lock, even if other locks might apply:

Setting up cart/checkout validation

Locksmith has a feature you can use to create a checkout rule that ensures that products tagged with a specific product tag cannot be purchased without a specific customer tag:

Let us know if you have any questions for us! You can contact us via email at team@uselocksmith.com.

If you've been using Locksmith to protect your shop, uninstallation means two things:

1. Removing Locksmith from your theme

2. Removing Locksmith from your Shopify apps list

The order is important! Locksmith is NOT able to clean up its code from your theme after you remove it from your apps list (and neither can Locksmith staff), so it's critical to have Locksmith remove itself from your theme before removing the app from your list.

1. Removing Locksmith from your theme

1. To start, open the Locksmith app from within Shopify.

2. Click on the "Help" link under "Locksmith" from the Shopify admin navigation menu.

3. Click the red "Remove Locksmith" button.

After clicking this, you'll see a status bar at the bottom of the screen, which is Locksmith letting you know that it's syncing your settings with Shopify. When this status bar goes away, the removal has completed - it should only take a handful of seconds. Wait for this to complete before continuing.

2. Removing Locksmith from your Shopify apps list

Delete Locksmith from your apps list in the standard way. Namely, from your Shopify admin, go to Apps > App and Sales Channel Settings > Locksmith > Delete.

More information from Shopify about deleting apps here.

Cancelling your Locksmith subscription

Important: If you have decided to NOT delete the Locksmith app from your apps lists, as outlined above, please make sure to cancel your subscription manually, to avoid being charged unexpectedly:

You can use Locksmith to only grant access to your content to registered customers that you approve.

Step 1: Creating the lock

To get started with this, you'll want to first create the lock that covers the content that you want to restrict. Since Locksmith gives you flexibility to decide what content you want to lock, you can apply this restriction to your entire store, or just to specific pages or collections in your store. Our full guide on locks contains all the information you need to create your lock, including how to create a lock to cover your entire store:

If you are choosing a more granular approach, you will need to create multiple locks that span the different products, collections, and pages that you want to lock.

Step 2: Creating the key

Once the lock is created, you'll want to create the key next. When setting up an approval process, the simplest way to do it is to use the key condition labelled "Permit if customer is tagged with...". This means that only accounts that have the specific tag can gain access to the locked content. That will look like this:

Using customer tags to grant access is the easiest way to approve accounts. However, you can technically use any customer data to grant access. More information on that here:

Step 3: Choosing how customer accounts are created

The above two steps outline how you use Locksmith to approve customer access to content. However, it's also important is to decide how the customer accounts are created to begin with.

You have some options:

1. Allow customers to register their own accounts, then approve as appropriate.

2. Create preapproved customer accounts, and send email invitations.

Option 1: Allow customers to register their own accounts, then approve as appropriate.

This would be considered the default way, and doesn't require any extra steps. Customers will simply register their accounts as normal, using your default registration form, and you can choose the ones you want to "let through" to your locked content. You'll simply use Shopify's "Customers" area to tag the customers appropriately.

If you need email alerts when customers sign up...

Shopify does NOT send registration notifications. If this is important to you try this customer email alert task from Mechanic.

If you need to collect additional information from customers in your registration form...

Option 2: Create pre-approved customer accounts, and send email invitations.

If you already have the email addresses of those to whom you'd like to grant access, you can use Locksmith's customer import/creation tool to create their accounts. The customer import tool allows you to pre-tag any customer accounts that you create this way, so they'll automatically be granted access once they begin using your site.

You also have the ability to place a lock on the registration form directly, so that customers cannot register their own accounts. Note that this will only work with Legacy Customer Accounts:

A complete guide on the importing tools is here:

Beyond entering the customers' email addresses, make sure to use the "Customer tags" field and enter "approved" as the tag, so that all of the customers imported this way are tagged. There are also some other options worth taking a look at:

Why this is useful

If you are using Locksmith's passcode, secret link, newsletter, or location key-condition types on your Shopify store, Locksmith remembers access of specific visitors via browser cache. Once the lock is open, the locked content will be accessible and will begin to appear in searches and collection view (if applicable) for the rest of the visitor's browser session.

If you want to re-test what a new user would, you will need to use a browser with clean cache. Keep in mind that you may find it easier to simply open up an incognito window, or use a different browser or device. However, those steps can be tedious if you would like to test multiple times in quick succession.

Following the steps in this guide will help you clear the cache for a single website, without needing to clear the cache for all websites. GIFs included!

Browser-specific steps

Chrome

1. Right click, choose "Inspect"

2. In the Dev Tools menu that shows up, find the "Application" tab

3. In the Application tab, make sure that "Storage" is selected in the left menu.

4. Click, "Clear site data", and you're done!

Firefox

1. Directly to the left of the URL bar, click on the lock icon.

2. Choose "Clear Cookies and Site Data" and the very bottom of the drop down

3. Make sure you choose your site only, and click Remove.

4. You're done!

Safari

1. Go to Safari > Preferences > Privacy

2. Search for your website.

3. Click on your website, and click "Remove"

4. You're done.

Internet Explorer

1. Go to your website (that you want to delete cookies and cache for)

2. Launch Developer Tools ( or press F12)

3. Go to the Network tab

4. Click the Clear browser cache button, or press Ctrl + R.

Most of the messages that Locksmith shows to your customers on the front end of your store are completely customizable!

You can edit the text itself as much as you need, plus you can add code, just like you would a template in your theme. That means you can use the following:

• HTML

• CSS (via the <style> tag)

• Javascript (via the <script> tag)

In general, your messages can be edited in two places...

Lock-specific messages:

To customize your messages for one lock only, go to the lock page and scroll down to the "Messages" area.

Default messages:

You can also customize the default messages, which will be used for all applicable locks when a lock-specific message is not present. To edit these, head over to the "Content" area of the "Settings" page:

Locksmith will only show the type of messages in the "Messages" area that apply to the key conditions you've selected in your lock(s). Most of the key conditions in Locksmith use customer data, and therefore require a sign in. In these cases, Locksmith will show you the following two editable messages:

• Guest message content: shown to customers that are not yet signed in.

• Access denied content: shown to customers that are signed in, but don't meet the requirements for the lock (e.g. don't have the specific customer tag that is required for access, if applicable)

Passcode and newsletter key conditions:

There are two other types of messages that will show up if you have selected the applicable key conditions:

These conditions both show a special prompt to the customer, asking for their submission before continuing. You can customize the message in the same places as outlined above.

Condition-specific messages

For merchants that have multiple passcode or newsletter conditions in one lock, you can customize the messages at the condition level. This is done inside the condition popover in the input labelled "Custom input prompt, as shown below.

In most cases, you won't need to set the prompt at the condition level - simply use the lock level messages, as shown above - this is a convenience feature for when it's needed.

Important: If a message is set at this level, it will override any messages set at the other levels. If this is the case, you'll see a warning, just to let you know what's going on:

Customizing the Continue button and loading message

Additionally, you can customize the submit buttons and loading text. To do this, head over to your theme's "Edit default theme content" settings:

... and open the "Locksmith" tab:

Locksmith will use the values you customize here when displaying content to your visitors.

Related articles:

Many, many merchants use Locksmith for managing different price levels within the same store.

Frequently, this means wholesale and retail. We'll use those terms in the rest of this article, but feel free to substitute them for whatever applies to your situation - for example:

• Members vs Non-members

• EU customers Vs. Non-EU customers

...or any other situations that require price tiers.

Customer management

Before setting up your product tiers, you'll need to decide how you want your customers to gain access to the separate tiers. The most common way to do this is to use approved customer registrations. More information on setting this up here:

So in this case, you would use customer tags to denote the customer tiers. So, for example, customers with the "wholesale" customer tag are considered wholesale customers, while customers without the "wholesale" tag are regular/retail customers.

Deciding between product duplicates or variants

Using Locksmith to sell products at two different prices levels means that your products need to be duplicated in some way. This can be achieved using either product duplicates or by using variant tiers.

Keep in mind that Locksmith itself does not create these alternate versions. No matter which one you choose, the work to duplicate the products will be done on your end.

Pros -

• Allows you to have distinct sections in your store that are dedicated to different types of customers.

• A straightforward approach

Cons -

Pros -

• Uses the same products, collections, and navigation menus

Cons -

• This is not a good option if your products already have many variants. Adding a price tier variant essentially doubles the number of product variants that each product has. The Shopify-wide maximum number of variants per product is 100.

• Can be seen as more complicated since managing individual variants is less straightforward than managing products.

Option 1 - Using product duplicates

Basic steps:

1. Use your Shopify admin area to create duplicate versions of every single one of your products that will be sold at more than one price.

That's it for the basic setup! There are some optional steps below...

Optional: Locking your retail products

You may want to consider also adding a lock to your retail products, so that wholesale customers don't get confused after they sign in. We'll use a new lock with the opposite condition, to make sure that the customer can only view your retail products if they're not approved.

To add a corresponding lock to your retail products, following these steps:

1. Create a collection that covers all of your non-wholesale products.

That's it! Your wholesalers will now be prevented from seeing retail products once they're logged in. (Note: this trick doesn't prevent the wholesaler from arriving at your shop as a guest, adding retail products to the cart, then logging in to their wholesale account!)

Optional: Pointing your wholesale customers to your wholesale collection

Now that you have a wholesale collection set up, you will want give your wholesale customers a way to find their content. You can do this by adding a "Wholesale" link to your navigation menu, that points directly to the Wholesale collection. This link will be visible to everyone, but once it's clicked, Locksmith will ask for access credentials.

Locksmith will automatically use the login template and style from your theme. The message is easily customizable:

Optional: Hiding wholesale product prices

If you prefer to leave your wholesale offerings open to the public, but still want to hide the prices, this is also possible!

This requires a few more steps, and we have a guide that covers that kind of thing here:

Option 2 - Using variant tiers

To create price tiers using product variants, you'll need to use your Shopify admin area to create an "Audience" option on each of your products that you want to add tiers to:

Next, create a variant lock in the Locksmith app:

Create a key. If you are using customer tags to grant access, that will look like this:

Additionally, create a corresponding lock for the retail variant. You should end up with two locks:

Inventory

Managing inventory across multiple price tiers is a very common concern

Separate inventory for each tier

Some merchants love the ability to set inventory separately for wholesale and retail customers. If that is you, then you're already good to go, no matter which option you have chosen, since each product and variant has separate inventory.

Same inventory across tiers

If you have more retail purchases than wholesale, one option is to let Shopify track the retail products, and manually update your retail inventory when you receive a wholesale order.

Locksmith allows you to restrict access to any content in your Online store, so it is a great solution for those wanting to add wholesale products that can only be purchased by select customers. Plus, Locksmith works with whatever Shopify plan you're on!

Scenario 1: Selling wholesale and retail in the same store

You can set up your store so that both sides of your business are run out of the same shop.

This is done by creating price tiers in your store. This requires that you create two versions of each of your products in the backend. This can be achieved by either duplicating products, or by using variant tiers.

In-depth setup instructions for this can be found here:

Scenario 2: Creating a wholesale-only store

If your store is going to only be used for wholesale, and you don't need multiple price tiers in the same store, your setup will be more simple.

You can simply create a lock that covers your entire store:

For your key, you have options for how to grant access, but the recommended option here would be to simply use approved customer accounts:

Or, if you prefer not to use customer accounts, and want to grant access with a simple code, try passcodes:

If you have special content that you want to monetize, and it lives in your Shopify store, Locksmith allows you to sell access to it via in-store purchases.

Step 1: Create your restricted content

Common choices for this are to add your restricted content to one of the following:

Again, for best results, your content should live in your online store. However, there are some other options that might apply to you:

Secure file viewing or downloading

Secure video viewing

Other general content that doesn't live in Shopify

If your content must live elsewhere, consider using iframes to embed your content into a Shopify page, which you can then lock. This is more of an advanced technique and would require someone familiar with code. Locksmith support won't be able to code this kind of thing for you. This is also less secure because the original source of the iframe can't be locked by Locksmith.

Step 2: Create your "access product"

Requiring a simple one time purchase

You'll need to have at least one product that is clearly marked as the product that customers will purchase, in order to gain access to the locked content. Something like this:

Requiring a recurring subscription charge for access

You'll need to use a third party app to set up the subscription service. We recommend ReCharge or PayWhirl, and we have in-depth guides for those here:

Step 3: Setting up the lock

Step 4: Making sure your customers are signed in when purchasing your "access product"

In order for Locksmith to register that a customer has actually purchased your "access product", it is important that you require that customers are actually signed in when the purchase is made.

You can do that with either of the following ways:

Optional: Directing customers to your content after purchase

You may wish to direct customers to the content that they just purchased.

... in order confirmation emails

We can use some custom code to conditionally add a link to your locked content if the customer has purchased the right product.

To set this up: head to Settings -> Notifications in your Shopify admin, then select "Customer notifications" and click the link for "Order confirmation". To edit the code for this email, you'll need to click the "Edit code" button in the top right of the page. Insert this code and adjust as needed:

Feel free to add multiple copies of this code, if you need to send the customer to one of several pages.

... and in the order confirmation page, after checkout

The code above can also be modified to suit the order confirmation screen that your customers see, right after completing an order.

To set this up, locate the "Additional content and scripts" box, near the end of the Settings -> Checkout area in your Shopify admin.

Use this code:

... adjusting the "Some Product" for your actual product title, and "/pages/some-locked-page" part for the address to your locked content.

Feel free to add multiple copies of this code, if you need to send the customer to one of several pages.

Use Case: Defer access to the restricted product until some time after the required product is purchased.

Let's say you want to grant access based on the purchase, but not immediately. You can grant access later using two conditions in your key. For example, this key will grant access 12 weeks (84 days) after the purchase of the Starter Pack:

Here is an example of a product page that has been setup properly with Locksmith to hide prices:

Then, when the customer meets the conditions, the product pages will appear normally:

You can also setup Locksmith to hide from collection pages and searches (as long as the default Shopify search is used).

You have flexibility! For example, you can require accounts to be approved in addition to signed in. Our whole library of key conditions is at your disposal here. You can also set it up on only some of your products if you want to leave some products available. Or, you can simply hide the add-to-cart button and leave the product prices visible.

Use the following two steps to set it all up:

1. Create lock

The first step to hiding your prices using Locksmith is to create a lock that covers the products that you would like to hide prices on. To do this, open up Locksmith and use the search bar on the main page of the app. If this is all of your products (most common), you can simply search for "all" and choose the "All Products" collection:

If you are only wanting to apply pricing hiding to some of your products, you can instead create a lock on different collection(s) or products that you want prices hidden for

Once you've created the lock, you'll choose the conditions for access. Many merchants use the "Permit if customer is tagged with..." key condition, which lets you manually approve accounts for price access by adding a customer tag:

That's the most common way to set it up, but you have the freedom to choose whatever key conditions work for your setup.

Before saving, turn on "Enable manual mode" right there in the lock (Clicking "Advanced" will show the option):

Done with step one!

2. Updating your theme for manual locking

You'll now need to add the code to your theme to let Locksmith know which parts need to be hidden.

Because each theme is a bit different, this feature does require manual coding. If you install a new theme down the road, these changes will need to be re-applied.

The rest of this guide gets a bit technical, we'll happily to the coding portion for you! If you've already created the lock described in step 1, simply write us a message at team@uselocksmith.com to request help.

If you are a developer type, and prefer to do the coding portion yourself, read on... You'll need to start by locating the places in your theme that show the price. Here are some examples of files that you might find the price in:

• snippets/product-card-grid.liquid

• templates/product.liquid

• snippets/product-card-list.liquid

• snippets/product-price.liquid

Each theme is very different, so those are simply examples. You'll need to go to each of the files that display price, and do the following steps:

1. Open up the Liquid file, and add this to the very top of the file:
2. Find the code you want to hide from unauthorized viewers, and wrap it with:
3. To hide prices, you'll be looking for elements like:

   ... or:

   Example:

   This shows Locksmith manual locking code wrapping an entire price section, which I've highlighted.

4. Save!

Remember, those 4 steps need to be done for each file that display the price.

Configuring Locksmith to hide the add-to-cart button only

You can still restrict purchasing products, while leaving the product details visible to the customer. This also a good option for those wanting to make sure that products are available for search engines to index.

As a reminder, we can help guide you through this process, including adding the code, so don't hesitate to get in touch.

Step 1 is exactly the same, but the code you add in step 2 will be slightly different.

Find the product-template or product-form file in your theme, and locate the code that generates the "add-to-cart" button. This is different for all themes, so it won't be possible to give you an exact location for this. Then, add the code that you want to render, inside of a Liquid "else" statement. For example:

This results in the add-to-cart button being replaced, in cases where the customer doesn't have access. What is shown depends on what is added above. Just make sure your key conditions on the lock match the conditions that you want your customers to meet before being able to purchase.

If you need to render a "Login to purchase" button, use the following code (the button classes may need to be edited). This button includes a redirect to return customers after login:

If you need to render a "Login to purchase" button, use the following code (the button classes may need to be edited). This button will return customers after login:

For locks using passcode keys:

If you need to render a passcode prompt button, use the following code (the button classes may need to be edited):

For locks using location keys:

You can add an access denied message of location keys by adding paragraph tags and some text within the Liquid "else" statement, for example:

When using the "is tagged with..." key condition you can display a "Login to purchase" button or an access denied message depending on a visitors access:

Here are some visual examples of the result

Requiring, a sign-in:

A passcode:

A country-specific visitor:

Whenever you use Locksmith to require your visitors to log in with their customer account, Locksmith will automatically pull in your theme's customer login form, with a message of your choosing added just above it.

You can customize the message in two places:

• Using the sidebar navigation, go to Settings > Messages > Guest message content. This is where you can edit the default message that is applied to all locks.

• On the lock page, find Messages > Guest message content. This is where you can edit the lock-specific message, which overrides the default.

<p><strong>This content is protected</strong> - please log in with your customer account to continue.</p>

You can customize this message using as much HTML, CSS, and Liquid as you need!

Also, keep in mind that the "Guest message content" only applies to pages locked by keys that actually require a login. If your lock does not require a login, you may need to edit one of the other fields under "Lock Messages".

There are many ways to customize this page which the rest of this guide will cover!

1. Customizing the login form itself

Since Locksmith is just grabbing the login template directly from your theme, you'll need to head into your theme to edit it. Shopify has a guide dedicated to doing this here (please note: this is for Legacy customer accounts only ). Using that guide you can do things like remove the "Register" link from your login form or edit the styling in other ways. If you have a theme from a third-party developer, feel free to contact them for more personalized guidance on your specific theme's login template.

2. Adding the registration form to this page

Easy! Just add the following into the "Guest message content" area.

{{ locksmith_customer_register_form }}

Once again, this is just grabbing the registration page from your theme. If you've edited your registration template and you aren't seeing it updated here, head to the "Help" area within the Locksmith app and press the "Update Locksmith" button to see the latest version on your lock page.

3. Editing the placement of the login form in relation to your lock message

By default, the "Guest message content" is displayed in its entirety as the first thing on the page (after the header) followed by the login form. You have the ability to change this: display the message after the login form, or perhaps add content before and after the login form. To do this, use the following in your "Guest message content" area:

{{ locksmith_customer_login_form }}

This will determine the placement of your login form and you're then free to add any content before/after it.

4. Remove the login form from the page entirely, or prevent Locksmith from adding it's version of your login form.

If you don't want your customers to see the login form on this page for whatever reason, you can remove it by just adding this to your "Guest message content":

{% comment %}
  {{ locksmith_customer_login_form }}
{% endcomment %}

You can then add the rest of your message alongside that code.

5. The Locksmith message isn't visible on the locked page, or its partially hidden

If the message is nowhere to be seen, it's probably just hidden under your header. Some themes don't add padding directly to the header and rely on the template to have its own padding. Since Locksmith replaces the template's code with its own content, it may be necessary to add the padding to it. This is usually as easy as adding this to the beginning of your "Guest message content":

<p style="padding-top: 150px"></p>

Of course, you can adjust the number as needed.

As always, feel free to contact us at team@uselocksmith.com if you need help with this.

6. Centering the message on the lock page

To get the text on this page centered, change the beginning <p> tag to the following:

<p style="text-align: center">

If you've removed the beginning <p> tag, just add a new one :) And, of course, make sure to close it with </p> at the end of your text.

7. Including other form types

If you have multiple key condition types on the same lock, it might be useful to include other form types within the prompt, so that they display on the same page. We have a guide on doing this here:

8. Placing the lock message within the login form itself

There are a few reasons you might want this. For example, if your login form is preceded by a heading or some breadcrumbs, you may want to insert the Locksmith-specific message beneath the heading, but above the email and password fields.

This gets a bit technical, so if you need a hand, just hit that message button in the lower-right corner! :)

To customize where your guest content message appears, open up the code editor for your Shopify theme ( here's how!), and open the file templates/customers/login.liquid. You might see something like this:

<h1>Login</h1><br><br>{% form 'customer_login' %}<br>  {{ form.errors | default_errors }}

  <label for="customer_email">Email Address</label>
  <input type="email" name="customer[email]">
  <label for="customer_password">Password</label>
  <input type="password" name="customer[password]">
  <input type="submit" value="Sign In">
{% endform %}

Add the code <!-- locksmith-message --> wherever you'd like your guest message to appear, like so:

<h1>Login</h1>

<!-- locksmith-message -->

{% form 'customer_login' %}
  {{ form.errors | default_errors }}


  <label for="customer_email">Email Address</label>
  <input type="email" name="customer[email]">
  <label for="customer_password">Password</label>
  <input type="password" name="customer[password]">
  <input type="submit" value="Sign In">
{% endform %}

Next, head to the "Settings" tab of your Locksmith account, and scroll down to the "Guest message content" field. Use a value like the example below to (a) customize your guest message, and (b) have Locksmith display your login template with your custom message injected into it:

{% capture locksmith_message %}<br>  <p>Please login below! :)</p><br>{% endcapture %}<br><br>{{ locksmith_customer_login_form | replace: '<!-- locksmith-message -->', locksmith_message }}

That's it! :D You've just customized the login form's display using pure Liquid - congratulations, and feel free to experiment until the result is just right for your shop. :)

Something else not covered here?

Let us know by emailing us at: team@uselocksmith.com

Responsive background image for the passcode formResponsive background image for the passcode formResponsive background image for the passcode formHere are some of the many different ways you can edit the passcode form!

Add content that is displayed before the form.

This is the default behavior for the message. You can add as much content as you need, including text, images and backgrounds, by simply adding code directly to the "Passcode prompt" area, found on the lock page, under Messages:

Any code that you add to this area will be rendered normally, as if adding it to the theme. Including:

• HTML - using regular HTML tags

• CSS - using <style> your CSS code here </style>

• Javascript - using <script> your javascript code here </script>

• Liquid - using regular Liquid syntax

Add content after the form

Simply use {{ locksmith_passcode_form }} to denote where the form itself will go, and then add in content that you want to display before and after it.

<p>Please enter the passcode to continue: </p>

{{ locksmith_passcode_form }}

<p> Content to be displayed after the form </p>

Editing the "Continue" and "One moment..." text

This is not done in the Locksmith app, but rather in the theme's "Edit default theme content" settings:

Once in the "Theme content" settings, you'll need to go to the "Locksmith" tab, which is typically not visible right away:

So then finally, you can edit the text itself, under the Locksmith tab:

<style>
    .or-cancel a:nth-child(1) {
        visibility: hidden;
        position: relative;
    }
    .or-cancel a:nth-child(1):after {
        content: "Close";
        visibility: visible;
        position: absolute;
        top: 0;
        left: 0;
        color:black
    }
</style>

Including other form types

If you have multiple key condition types on the same lock, it might be useful to include other form types within the prompt, so that they display on the same page. We have a guide on doing this here:

Please note that this is NOT compatible with replacing/editing the form itself (as detailed in the next section).

Replacing or editing the form itself

Some merchants want more control over the form itself, not just the text that is shown alongside it. This could just be for more granular edits to the way it looks, or to perform more complicated javascript operations on the text input.

Although we can help troubleshoot, if you choose to override the form, the coding and style is up to you, we are not able to create a new form for you.

To do this, simply use the "Passcode prompt" area to put in your new form. Since you're overriding the form, you'll need to add in all the code for the new form. To begin, copy/paste this entire section (including the script!) into the Messages > Passcode prompt area. Then, edit as needed:

<div class="locksmith-passcode-container container page-width">
  <form id="locksmith_passcode_form">
    <p>Enter the passcode to continue: </p>
    <p><input autofocus id="locksmith_passcode" class="locksmith-passcode {% if locksmith_passcode_attempted %}failed{% endif %}"></p>
    <p><button type="submit" class="button button-primary btn btn-primary action-button action_button">CONTINUE</button></p>
  </form>
</div>

<script>
  var passcodeForm = document.getElementById("locksmith_passcode_form");
  passcodeForm.addEventListener('submit', function (event) {
    event.preventDefault();
    var passcode = document.getElementById("locksmith_passcode").value;
    /* REMOVE THIS LINE and insert any desired transforms to passcode here */
    Locksmith.submitPasscode(passcode, event);
  });
</script>

If you need to perform text transforms (e.g. downcasing the text for case-insensitivity), do that in the marked area in the script above.

Editing tips

• Changing the form too extensively (editing the text input, script, classes/ids) could cause the passcode not to be submitted correctly, so try to stick as close to the above as possible.

• Locksmith will look for the <form> tag with the "locksmith_passcode_form" id, so that's something to keep in mind if you see that Locksmith is still rendering the default form when overriding:

<form  id="locksmith_passcode_form">
  ...rest of form code...
</form>

5. Editing other specific elements on the form

Here are a few examples of how you might use CSS to style your passcode messages. You can put these directly in your passcode messages in Locksmith (making sure to surround them with the <style> ... </style> tag), or add them to the stylesheets in your theme.

Target the 'Continue' button by ID

#locksmith_passcode_submit { color: blue; }

Target the input field by class

#locksmith_passcode { border 1px solid red; }

Center the continue button

.locksmith-passcode-container p:last-child { text-align: center; }

Showing a message when the customer enters the wrong passcode

form.locksmith-authorization-failed::before {
  content: 'The passcode you have entered is invalid. Please enter another passcode.';
  color: red;
}

Add a background image to the entire page

body {
  background-image: url('https://YOUR-URL-HERE') !important;
}

Add a background image to only the form area

#locksmith-content {
  background-image: url('https://YOUR-URL-HERE');
  background-size: 100%;
  background-repeat: no-repeat;
}

Add a responsive background image to the entire page

  #MainContent {
    background: url(//https://YOUR-URL-HERE') center bottom no-repeat;
    background-size: cover;
    padding-top: 10%;
    padding-bottom: 10%;
    max-width: 100%;
  }

.locksmith-passcode-container {
    content: "";
    display: block;
    padding-top: 56.25%; /* Adjust this value based on the actual aspect ratio of your background image. For example, here is a calculation of the aspect ratio for an image of size 1080*1920 pixeles: ((1080 / 1920) * 100)% = 56.25% */
    flex-direction: column;
    justify-content: center; /* Aligns content vertically center */
    align-items: center; /* Aligns content horizontally center */
    height: 100%; /* Ensures the container takes full height of its parent */
}
#locksmith-content::before {
    content: "";
    position: absolute;
    top: 0;
    left: 0;
    width: 100%;
    height: 100%;
    background-image: url('https:// your image source here');
    background-size: cover;
    background-repeat: no-repeat;
    z-index: -1;
}

#locksmith-content {
    position: relative;
}

#locksmith-passcode-form {
    position: absolute;
    top: 50%; /* Aligns content vertically center */
    left: 50%; /* Aligns content vertically center */
    transform: translate(-50%, -50%); /* Adjusts the position of the passcode from so that its center aligns with the center of the div. */
    box-sizing: inherit;
    max-width: 475px; /* Sets the maximum width of the passcode form */
    width: 100%;
    padding: 20px 25.45px;
    z-index: 1;
}

Add placeholder text to the passcode entry field using javascript

With jquery:

<script> setTimeout(() => { $('#locksmith_passcode').attr('placeholder', 'This is a placeholder!'); }, 10); </script>

With vanilla javascript:

<script>document.querySelector('#locksmith_passcode').setAttribute('placeholder', 'Enter password');</script>

While we cannot make extensive custom edits to your form for you, if you have any questions you can contact us via email at team@uselocksmith.com

This applies to Klaviyo and Mailchimp key condition types - the setup instructions for which are linked below:

• Klaviyo

• Mailchimp

Adding a regular prompt

You can add any text prompt to the "Mailing list signup prompt" area, and it will be displayed right before the email input. The default prompt is shown below:

In addition, you can add any code to this area, and it will be rendered normally, as if adding it to the theme. Including:

• HTML - using regular HTML tags

• CSS - using <style> your CSS code here </style>

• Javascript - using <script> your javascript code here </script>

• Liquid - using regular Liquid syntax

Adding content after the form

Use {{ locksmith_email_form }} to denote where the form (input and button) itself will go, and then add in content that you want to display before and after it.

<p>Subscribe to our mailing list to continue! </p>

{{ locksmith_email_form }}

<p> Content to be displayed after the form </p>

This results in the following:

Editing the "Continue" and "One moment" text

To edit the text for the button, you'll need to follow Shopify's guide to "Edit default theme content":

Once there, you'll find a Locksmith tab in which you can edit the text as needed:

Translating messages

We have a dedicated guide on adding translated messages here:

Including other form types

If you have multiple key condition types on the same lock, it might be useful to include other form types within the prompt, so that they display on the same page. We have a guide on doing this here:

Please note that this is NOT compatible with overriding/editing the form itself (as detailed in the next section).

Overriding or editing the form itself

Use the following steps in order to override the form. The screenshots are taken from Chrome, but the steps are similar if using other browsers.

1. Once you've created a Mailchimp or Klaviyo key condition, open up your locked page in your storefront.

2. Right click on the email list signup form to inspect the code.

1. This should take you to the "Elements" tab. There, find the <div> element with the "locksmith-email-container" class:

   Copy

   <div class="locksmith-email-container container page-width">

   You can copy the entire element and all child elements like so:

1. Paste this directly into your "Mailing list signup prompt". You should end up with something like this:

1. Save that, and open your locked page again on your storefront. If everything worked, your email list signup prompt and form should look exactly like it did before. But now you have the ability to edit it as needed. Please note that you must always include a <form> tag with an id of locksmith_email_form - otherwise Locksmith will try to include the form itself, and you'll end up with two forms - so don't remove that when editing the code.

Locksmith access denied content is presented to customers who are signed in, but don’t meet the access requirements of the lock (e.g. the customer doesn’t have the specific customer tag that is required for access). Or when the lock has no keys.

Key conditions that use the “Access denied content" filed:

• is tagged with…

• has one of many email addresses

• has an email address from an input list…

• the customer's email contains…

• has placed at least x orders

• has purchased…

• (custom Liquid) in some cases

1. Modifying the default message

The "Access denied content" message field can be modified in the same way as Locksmith’s other access messages, including using code to modify the appearance and functionality of the message.

The following code can be used in this field:

• HTML

• CSS (via the <style> tag)

• Javascript (via the <script> tag)

• Liquid (Shopify's template language for themes)

2. Adding the registration form to this page

Simply add the following Liquid to the "Access denied content" message field:

{{ locksmith_customer_register_form }}

This will render the theme’s default registration form.

3. Adding a custom registration form or content

Liquid code can be used to render a snippet or section from your theme that contains a custom form or message.

1. render - Renders a snippet

{% render 'filename' %}

1. section - Renders a section.

{% section 'name' %}

4. Automatically redirecting customers to another part of your store

A JavaScript redirect can can be added to the “"Access denied content" message field if you would like to automatically send customers who are denied access to your lock, to some other part of your store.

This might be useful for a few different reasons:

• To take customers to a specific product they can purchase for access. For example, to buy a product, or membership, or subscription for access.

• To take customers to an information page.

• To take customers to a custom registration form

• To direct customers to an alternative resource

Simply add the following code to the "Access denied content" message field and modify the URL to your desired location.

<script>
    window.location.replace("http://www.example.com");
</script>

Related articles:

Something else not covered here?

Let us know by emailing us at: team@uselocksmith.com

Step 1: Add your inputs to an external file

Input lists are stored externally! So you'll need to create a file that is accessible via a URL, adding all of the values to it that you would like to use.

Google Sheets must be formatted as a document having a single column of input values, one value per row.

Supported file formats

In addition to Google Sheets, sources may be of the following formats:

• TXT (one input value per line)

• CSV (a single column of input values, one value per row)

• JSON (an array of strings)

• Microsoft Excel XLSX (a spreadsheet having a single column of input values, one per row)

Step 2: Locksmith Configuration

Input lists are configured in your Locksmith account settings. To find this area, open the Locksmith app and go to the Settings area (using the left-hand navigation):

Input lists are available in the "Extensions" area:

Options

An input list has four options:

• Name

• Source URL

• Input values are case-sensitive (enable to require an exact case match)

• Default usage limit per input list item - allows you to specify a default usage limit for any items that you add to the list. This is a great way to add unique inputs - simply enter 1 as the usage limit and each input can only be used once.

Syncing

When an input list is synchronized with its source, any new items found in the source file will be added to Locksmith's copy of the list. Any items that are no longer found in the source file will be removed from Locksmith's copy of the list.

Input lists that are sourced from Google Drive will be automatically synchronized whenever the source file is changed. (When used with Google Sheets, this allows for interesting flexibility: one could use a Google Form that saves data to a Google Sheets file, which then feeds into an input list. Whenever the form is submitted, Locksmith would automatically sync a new value into the input list.)

All input lists may be synchronized manually, by using the "Sync input list" button for the respective list.

Step 3: Use with specific key conditions

Once you've created at least one input list, you may use it when configuring a new key condition in your lock settings, by choosing one of the "Permit if..." options that mentions input lists. When adding keys to you locks, use the corresponding options...

Email Addresses

When configuring your key condition, select the "Permit if the customer has an email address from an input list…" option to have Locksmith compare customer inputs with items in your input list:

More information on using customer account key conditions here:

Passcodes

When configuring your key condition, select the "Permit if the customer gives a passcode from an input list…" option to have Locksmith compare customer input with items in your input list

As with Locksmith's other passcode conditions, you may configure this condition to "remember" returning customers who are logged in. If this option is enabled, Locksmith will compare previously-accepted passcodes from the customer's records with current items in the selected input list. This means that removing previously-used items from the input list will result in the relevant returning customers being "forgotten".

More information on using passcodes here:

Secret links

When configuring your key condition, select the "Permit if the customer arrives using a secret link code from an input list…" option to match the visitor's current URL with items in your input list:

As with standard secret link keys, Locksmith will be trying to find matching secret link codes in the following parts of the URL:

• The URL's "search" portion. For example, in a URL that looks like "https://example.com/?foo=bar&baz&ls=qux", Locksmith will consider items in your input list having the value "foo=bar&baz&ls=qux".

• Any component in the URL's "search" portion. For example, in a URL that looks like "https://example.com/?foo=bar&baz&qux", Locksmith will consider items in your input list having one of these values: "foo=bar", "baz", "ls=qux".

• The "ls" query parameter, if present. For example, in a URL that looks like "https://example.com/?foo=bar&baz&ls=qux", Locksmith will consider items in your input list having the value "qux".

This means that you may form your shared URLs in any of the following ways, using an example secret link code of "foobar" to illustrate:

Feel free to combine either option with other query parameters, like so:

As with Locksmith's other secret link condition, you may configure this condition to "remember" returning customers who are logged in. If this option is enabled, Locksmith will compare previously-accepted secret link codes from the customer's records with current items in the selected input list. This means that removing previously-used items from the input list will result in the relevant returning customers being "forgotten".

More information on using secret links here:

Many merchants that sell collectors items, limited edition items, or other types of highly exclusive items are plagued by bots purchasing their products, and come to Locksmith for help.

Without using a checkout rule, Locksmith is NOT able to prevent bots and other unapproved resellers from purchasing from your store.

This is because direct-to-checkout links, which allow products to be purchased without even visiting the Online Store, exist within the Shopify platform, and it's not possible for apps to get involved with this layer.

While Locksmith itself cannot help here, there is a way you can prevent this from happening without the need for any apps.

The solution: discount codes

So, for example, you could create a customer segment that's based on a specific customer tag:

And then give the customer segment a description name:

When setting up the discount code, use the "Customer eligibility" section to select the customer segment that can use this discount:

The result of this is that you now have an avenue to make sure that only the customers you designate have a pathway to purchase that is secured all the way to the completion of the sale.

You can absolutely use this strategy without further involvement with any apps, including Locksmith. The customers will simply use the product pages as normal, and enter the discount codes at checkout.

Again, the price they'll see here will be higher than what the customer is most likely expecting, so make sure you do everything you can to communicate with your customers about using the discount code. You can do this in the product description, in customer mailers, or when they contact you (more on that below).

That's it for the basic setup!

How Locksmith can help

Optionally, Locksmith can still help get your product pages to a place that helps direct your non-bot customers to the right place. Locksmith has features that will help hide the price and add-to-cart buttons so that the public facing price doesn't scare customers away that stumble onto your product pages. More information, and set up guide, on hiding the price and add to cart button here:

So basically, when set up correctly, your customers would see something like this when they land on your product pages:

Then, when signed in with an approved account, they will be able to add to cart and purchase.

For questions or help with setup, contact us via email at team@uselocksmith.com!

Locksmith has a feature to create "Liquid" locks, which allows you to lock pages in your store that are otherwise not searchable using the basic "Add lock" resource search in Locksmith.

Moving on - to begin, click in the "Add a new lock" search field and select "Start a Liquid lock", or type "Liquid" in the search field:

Then click "Start a new lock":

This will bring up the following form:

The "Liquid condition"

The "Liquid condition" is the condition that is evaluated to decide if the lock will be engaged on the current page. The Liquid condition simply needs to evaluate to true or false.

Useful examples

Any condition that evaluates to true will result in a locked page. So, imagine if you created a lock with this condition:

That would result in every single page in your store becoming locked. This isn't advisable, it's just a proof of concept :)

One of the most useful variables that you can use is the canonical_url variable. This variable contains the full url of the current page, so it is a good way to lock pages that aren't usually searchable. For example you have an app that lives at my-store.myshopify.com/apps/bulk-order-form-app, you could lock it with the following condition:

Another useful variable is the template variable. For example, an easy way to lock only the home page would be:

If your home page template is called something else, you have the flexibility to lock it by adjusting the condition above.

The "Liquid prelude"

The "Liquid prelude" will be evaluated before the liquid condition, and is where you'll add any code that helps you set up the Liquid condition, and can span multiple lines. For example, you can assign to a specific custom variable, which can then be used the the Liquid condition later.

For example, if you have a large number of pages that you want to lock at once, normally you'd need to do that by creating a separate lock on each page. You could use the Liquid lock feature to lock them all at once. Perhaps something like the following:

In your Liquid prelude:

In your Liquid condition:

This would result in all "Pages" in your store that contain "member" or "secret" in the title becoming locked.

Related resources

You can also create Liquid keys! While the function of Liquid keys is fundamentally different than what is covered on this page, the concepts while setting them up are very similar:

Locksmith can be used to show different content depending on what Market a customer is visiting.

The first step is to divide up the content in your store. If you already know what products or collections you want to show or hide in different Markets, then you do not need to create extra collections here.

Once the lock is created, you'll need to create the correct Locksmith "Key". Markets are typically set up by either creating subdomains on your store, or by creating subfolders. Depending on which one of those you are using, you'll need to set up Locksmith a bit differently...

When using subdomains

This will usually look something like www.my-store.eu, or ca.my-store.com, where the subdomain of the URL represents a different region that you're selling to. In this case, simply use Locksmith's "domain" key condition:

When setting this up, Locksmith will automatically show you suggestions for which domain to use, based on the domain settings for your store.

When using locale + country subfolders

Next, you'll add in something like the following as the "Liquid condition", making sure to edit the last part to match the subfolder you are wanting to grant access to:

{% ifrequest.locale.root_url == "/en-us" %}

Note that only the bolded part needs to be entered, as the rest is included automatically.

You'll end up with something like this:

If you want to set up a key condition for your primary domain, use "/" as your root_url. In specifically: {% ifrequest.locale.root_url == "/" %}

Using the "localization" object

Your condition will look something like the following - where "CA" is the ISO code for Canada: {% iflocalization.country.iso_code == "CA" %}

All Shopify themes come with a registration form that includes Name, E-mail, and Password fields.

Many merchants want to collect more information from a customer when they register. Although Locksmith doesn't get involved directly with this process, you do have options here.

1. Simply request that your customers e-mail you the information

This is a simple solution to the issue and does work for some merchants. Use the Locksmith access-denied "Messages" area, which you can customize in the app, to let your customers know the contact email.

2. Edit the registration form in your theme directly

Pros:

• Editing your own theme is free

Cons:

• Extra fields in the registration form end up as customer "notes". Saving unique customer data to the customer note doesn’t allow much flexibility for using that data, or segmenting customers accordingly.

• Changes the registration form for everyone which means that your different types of customers(I.e. wholesale and retail, if applicable) would be using the same registration form. You can still make the form usable for everyone by making the extra fields optional.

• There is not an option to get notified when customers register.

3. Use a dedicated Shopify app

Pros:

• Extremely easy to set up

• Install forms nearly anywhere on your storefront (no coding required)

• Choose whether to automatically create customer accounts in Shopify or require admin approval before an account is created

• Create unique forms for different customer groups, or use conditional logic to show/hide fields for different users on one form

• You can get notified by e-mail when the form is filled out!

• Plenty of other features

Cons:

• It is, naturally, a paid app

4. Use a third party form-creating service

If you just need to collect information, and don't need to automatically do anything with it, it is always an option to use Google forms, Wufoo, or other online forms. There are some other great services out there that let you create a fully customized HTML form.

Pros:

• Free

• Can be used to create a second registration to be used by some of your customers while leaving your regular registration form alone. (These accounts will still be funneled back to the same customer database.)

• You can get notified by e-mail when the form is filled out!

Cons:

• The accounts are not automatically created which means you'll need to manually move the information over to Shopify from the third party app

You can use Locksmith alongside a dedicated subscription app to lock content so that the content can only be accessed by active subscribers. This guide covers how to use PayWhirl, but any recurring payment service that offers the "auto-tagging" feature would work with Locksmith.

PayWhirl Setup:

If you haven't already, install the PayWhirl app and use their instructions to set up a recurring subscription for one of your products. Start by creating a product on your store, and then linking it to a subscription through PayWhirl. You can find the full setup instructions here:

Important: You'll need to configure PayWhirl to tag customers who subscribe. To do this, click on the Workflows tab in PayWhirl, and then click on "Create customer tagging":

Next, click on "Tag active subscribers", and then "Create and activate workflow". Your setup should look something like this on the Workflows screen when you're done:

Locksmith Setup:

Open up the Locksmith app and create a lock by searching for the page, product, collection, etc that you want to limit access to.

Once the lock is created, add the following key:

Here's a refresher on how to create keys:

That's all it takes! Locksmith will now only grant access to accounts tagged with "Active Subscriber", which will be added to accounts that have an active subscription via PayWhirl. Based on the Workflow settings you set up already, the tag will be removed when the customer cancels or is otherwise unsubscribed. As a result, they'll also automatically lose access to the locked content.

Advanced setup for multiple tiers:

If all of your plans are accessing the same content...

E.g. - you have a monthly, yearly, etc option - no additional setup needed: the same tag will get added to a customer account to matter what plan they have, and customers using all plans will be able to access the content.

If you have multiple plan tiers to access different content, depending on the tier...

E.g. Gold, Silver, Bronze tiers, but the access for each tier is different.

In PayWhirl, you'd create a recurring order product for each of your tiers.

In Locksmith, add a lock to the content that is associated with a particular membership level. You will end up with at least one lock for each tier, maybe multiple, depending what content you are locking!

Use the following key:

Make sure to fill out the "Only look at orders in the last..." field with the appropriate subscription length that matches your PayWhirl subscription:

If there is any content that can be accessed by more than one type of membership level, just add them both as Locksmith keys:

Feel free to ask questions if you're having any issues with any of that! We can be contacted via email at team@uselocksmith.com.

When testing Locksmith configurations, it's frequently useful to open a private browsing session, thus guaranteeing that neither Locksmith nor Shopify will remember any of your previous activity, giving you a clean slate to test with.

All major web browsers support private browsing. Here's how to start a session, in each browser:

• Google Chrome: File → New Incognito Window (Ctrl+Shift+N, or Command+Shift+N)

• Safari: File → New Private Window (Command+Shift+N)

• Firefox: File → New Private Window (Ctrl+Shift+P, or Command+Shift+P)

• Microsoft Edge: File → New InPrivate Window (Ctrl+Shift+N, or Command+Shift+N)

For more information, from the sources, on how to use "private session" (sometimes called an incognito window), use the following links:

• Chrome

• Safari on Mac

• Safari on iOS

• Firefox

• Edge

This is a straightforward key condition that allows access solely based on if the customer confirms the prompt that you set. Something like the following:

To use, simply choose the key condition labelled "Permit if the customer confirms the prompt":

Set the desired prompt

Common use-cases/examples include:

• Please confirm that you are over the age of 21

• By clicking 'Yes', you agree to our Terms of Service for accessing this page

• Confirm if you have read the prerequisite material to access this advanced module

• Please confirm that you have not experienced any recent health complications that could prevent you from fully engaging with this experience

• etc

Any message that you decide to use can be added directly to the Messages area:

Changing the button text

If you need to use something other than "Confirm" as your button text, this is done through your theme.

1. Go to Online Store > Themes > "Edit default theme content". More info on that, from Shopify, here.

2. Find the Locksmith tab, and edit the button as needed:

Adding text after the button

If you want to add text that shows up after the button, simply use {{ locksmith_confirmation_form }} to denote where the form will show up. Then add more text as desired:

This results in the following, when Locksmith renders the prompt on button for your visitors:

Including other form types

If you have multiple key condition types on the same lock, it might be useful to include other form types within the prompt, so that they display on the same page. We have a guide on doing this here:

Translations

You'll need to follow the regular workflow for translating anything in your theme. To get started with that, you'll likely want to use Shopify's free Translate and Adapt app, or one of the paid apps from the app store. More info on this, from Shopify, here.

Once you have a language/locale/translation set up for your theme, you'll see a Locksmith > "Confirmation button text" area which you can edit as needed, for each of your languages. In the Translate and Adapt app, that looks like this:

To add translatable messages to the input prompt, check out or guide here:

By default, our Klaviyo key condition signs up your customers for your Klaviyo mailing list, when they submit their email address. However, this key condition also supports using Klaviyo to establish a list of email addresses who are preauthorized for your content.

Once you've created a lock, select "subscribes to your Klaviyo list" from the list of available key conditions.

Then, after choosing your Klaviyo list, check the box labeled "Only grant access if the customer is already on this list".

As noted in the form, with this mode enabled, Locksmith won't add anyone to your Klaviyo list. Instead, access will only be granted for confirmed email addresses that are already on your list.

You may also want to edit the prompt under Messages > "Mailing list signup prompt" further down on the page - to reflect the fact that you're checking for preauthorized access, instead of looking for signups!

It's possible to use Locksmith's passcode keys to redirect visitors to specific URLs, based on which passcode they enter. Using this technique, a single page (or other locked resource) can act as a kind of switching station, pointing visitors to the content that's appropriate for them.

To accomplish this, set up multiple passcode keys, each one having a distinct passcode value. Then, for each key, use the triple-dot menu on the right to set a redirect URL, sending the visitor to the appropriate destination when they enter that passcode.

A demonstration:

Related articles

With Locksmith, it is simple to lock down a specific collection, so that it can only be viewed by a specific set of customers. However, some merchants want to take it one step further and make sure that those customers can only access their collection, while the rest of the store is restricted to them.

Part 1: Create the collection lock

Add a lock to the collection that you want these customers to access. Use the search bar in Locksmith to search for the collection by name:

Under "Keys", choose how these customers will gain access. You can use whatever method of access you want. The most common way of granting access in this scenario is to use "customer tags" to grant access:

Make sure the "Force open other locks" setting is turned on for this lock. Use the following guide to do this: Using the "Force open other locks" setting . This setting is important.

Part 2: Create a lock covering the rest of the store

In order to make sure that these customers can't see the rest of your store, you need to actually add a lock to your "entire store":

For your key condition, you need to use the "invert" option to obtain the opposite of the first key condition:

Use the guide here if you need more guidance on how to invert your key condition:

The best way to hide out-of-stock products is to create a automated collection containing these products, which is then protected with Locksmith.

For more automation options around out-of-stock products, see Mechanic's "out of stock" task library.

1. Create an "out-of-stock" collection

In the "Collections" area of the Shopify admin, create a new collection. Under "Collection type", select the "Automated" option, and configure its conditions such that products match an inventory stock level of less than 1. Save the collection. The result: a collection that only contains products that have been sold out.

2. Lock the collection

Open up Locksmith, and use the "New lock" form on its homepage to search for your new collection, using the collection title that you specified earlier.

Click on the matching collection, and follow the steps to save its new lock.

On the next screen, update the lock's settings so that "Hide this collection and its products" is enabled.

Save your settings. You're done! The result: this collection, and its products (representing all out-of-stock products in your store) are now fully hidden from visitors.

Locksmith won't lock by tag using the Locksmith search bar. The good news is that you can make this happen with an automated collection in Shopify.

1. In your Shopify Admin, click on Products then Collections

2. In the upper right, click Create Collection

3. Name your collection something relevant, and then scroll down and click on the Automated option for the collection.

4. In the conditions area, choose "Product Tag... is equal to" and then add your product tag into that field:

5. Click Save.

Once that's done, search for your new collection by name in the Locksmith search bar, and lock it that way. You'll likely want to enable the "hide from search and lists" option on that collection lock.

Any time you tag a new product with that tag, it'll automatically be in that collection and therefore locked by Locksmith. :)

"What happens in the other collections that these products are in?"

Once you create your collection lock, you'll be presented with these options:

The highlighted option here controls whether or not the tagged (and therefore locked) products will appear elsewhere. With the option enabled, Locksmith will automatically hide these products (unless the customer is already qualified for access). In that scenario, the customer will be able to see the products in your other collections – they won't be prompted for access until they click through to an individual product. With the option disabled, the products will remain visible in your other collections. (Note that the customer will still be prompted for access when they click through to a product, even in this scenario.)

In this tutorial, we'll talk about configuring a Shopify store to...

• Prompt the visitor to enter their postal code upon arrival

• Only display variants that have their "Postal code" option set to equal the postal code that the visitor entered

To do this, we'll use a series of variant locks, and one shop lock. We'll also use passcode key conditions, leveraging the ability to use a single passcode entry to activate many passcode keys at once.

Demo store

We've set up a store that contains a couple of sample products, with a handful of supported postal codes.

View demo store (password: locksmith)

Instructions

1. Configure your product variants

For each of your products, add an option labeled "Postal code". Add one variant for each postal code that you want to support.

In the demo store linked above, here's how the variants are displayed in Shopify, for one of the sample product:

2. Lock each variant option

Open the Locksmith app. Using Locksmith's search box, locate each variant option, one at a time:

Select the matching item, and continue to save the lock.

On the next screen, add a passcode key, setting the passcode to the same value as the postal code:

Save the lock.

Repeat for each of your postal codes, resulting in one lock per postal code variant option.

3. Create a lock for the entire online storefront

Back on the home screen of Locksmith, use the "Add lock" form to create a lock that covers the entire online store.

On the next screen, add a key that permits if the visitor enters one of many passcodes. Configure the passcode list to contain each of the postal codes that you support.

4. Test! :)

You're done! When visitors arrive at your online store, they'll be prompted to enter their postal code. If it's one of the codes on your list, Locksmith will let them in, and will now only show them variants that match the postal code they entered.

Your final Locksmith locks list should look something like this:

To try out the customer side of this, see the demo store linked at the beginning of this article.

This can be useful for merchants that don't need a product to be "secure", but still want to keep customers from finding the product by accident.

Locksmith also has a secret link feature, which is more heavily used and different than what this guide describes. The secret link feature is more secure. If you are looking for that, simply use the key condition labelled "Permit if customer arrives from the secret link" when setting up your key. If not, read on... Use the following steps:

1. Create a lock on the product in question - to do so, open Locksmith app and search for a product by name.

2. On the next page, under Keys, select the "(custom Liquid)" condition

3. Paste template == "product" into the "Liquid condition" box

4. Make sure the "hide this product from search results and other lists" option is checked!

You're done :)

If this technique isn't working, it's possible that your theme uses a non-standard template name (other than "product"). To fix this, just update "product" in the lock to whatever your theme uses.

If you would like more information on Liquid key conditions, checkout the guide linked below.

Something else not covered here?

Let us know by emailing us at: team@uselocksmith.com

Locksmith can be used to create separate areas of your store for different teams, clubs, vendors, organizations, or other groups. These areas are intended to be private, only for the eyes of those members. This guide also applies even if there is only a single customer that should gain access to each area.

To summarize, you will create a landing page that you can link all of your customers to, and then use Locksmith to lock down and redirect customers to their own content. The rest of the guide explains, in greater detail, how to do all of this.

Step 1: Create the content for each group

For each group, create the collection of products that applies to them. Or, if you prefer that your customers are redirected to a single product, or some other page, you can use those instead.

Step 2: Create the landing page

Call it whatever makes sense for you. You don't have to actually add any content to the page, since customers will be immediately redirected away from this page.

Optional: Add a link to this page to your navigation menu. This is how customers will find their content. Label the link whatever applies to your store, such as "Shop", or "Your collection", or "Member area", etc. If you do not add a link to your navigation menu, you will need to have another method of making sure your customers find, or are sent, the link to your landing page.

Step 3: Decide how you want to grant access

Step 4: Add the lock and keys to your landing page

2. For each of your customer groups, add a matching key that grants access to this landing page (we'll create the individual collection locks in the next step). This key should define how you want customers to ultimately gain access to their collection - so whatever you chose in step 3.

Step 5: Add the locks and keys to each of your collections

For each of your collections, add a lock to it and add a key that defines how you want customers to gain access. This key should match whatever key you used in Step 4. Except, of course, leave out the redirect on this one.

Once you follow those steps, you will end up with a landing page that redirects customers to their own content. The redirect will happen after the customer has gained access via signing in or giving the passcode (or whatever access method you've chosen).

Feel free to contact Locksmith support at team@uselocksmith.com for any questions regarding this.

To get started using Locksmith's Customers area, use the "Customers" button, found in the footer navigation on any page of the app:

There are two options for importing your customers: using a plain list of email addresses, or by loading in a CSV file that you create with your spreadsheet application.

Importing using email addresses

The only thing you'll need: a list of emails to be used, one per line(or separated by a space).

You'll also see options to:

• add one or more customer tags to each customer that's created (useful for pre-approving wholesale accounts, for example)

• set an account password (which would allow your customers to sign in immediately, using that password).

If you'd like to customize which tags or what password is used per customer, try using a CSV instead - read on!

Importing using a CSV

For the most flexibility, set up your customer records in your spreadsheet application (like Excel, Google Sheets), and load it into Locksmith for a bulk import:

Supported column names

All columns are optional, unless noted.

• Email (required!)

• First name

• Last name

• Accepts marketing (can be "true" or "false")

• Note

• Tags (comma-delimited)

• Password

• etc...

Results

Locksmith will give you a preview of the customers to be imported:

And after you click the "Start Import" button at the bottom of the page, you'll see the results:

In addition to skipping any invalid e-mails, you'll notice that Locksmith will also automatically skip any emails that already have a customer account, and it'll let you know which ones it skipped.

For questions, get ahold of us via email at team@uselocksmith.com

Mailchimp is a great way to stay in touch with your customers (and it's free!).

Connecting it to your Locksmith account lets you grow your mailing list subscription base, by making sure your visitors' email addresses are on record.

To try it out, use these steps:

3. On the lock page, under "Keys" choose the "Mailchimp" key condition from the list:

4. In that key, click on "Connect Mailchimp" and sign into your mailchimp account. You'll be prompted to close that window when done.

5. Choose your Mailchimp list, click off the pop-up, and then click Save.

Visitors who try to access your locked content will encounter a prompt to subscribe to your mailing list, and the email addresses they submit will be loaded into your Mailchimp account.

Tips

• For a brand-new mailing list, it can take a few minutes for new email addresses to appear in your Mailchimp account.

• Mailchimp will not show subscribers in your admin panel if you have any required fields besides "Email Address". Check on this by opening your list in Mailchimp, then heading to "Settings" -> "List fields and *|MERGE|* tags".

• To make it easy to see your subscribers that arrive through Locksmith, create a "Locksmith" segment for your list. Do this by opening your list in Mailchimp, then heading to "Manage subscribers" -> "Segments". Click "Create Segment", and set up your segment like so:

Hit the "Preview" button, then on the next screen click "Save as segment".

Step 1 - Edit your Locksmith message

Make sure to include the quotes. In the app that looks like this:

Saving a lock with any messages that contain the above formatting will trigger a Locksmith update which will automatically edit (all of) the locale files in your theme so that they include a new editable and translatable attribute. This is an example of what that might look like from within the locale files in your theme:

Step 2 - Adding the translations to your theme and locales

Default locale theme content

When editing the default theme content, you'll now see a Locksmith tab, with a section that corresponds to what you added to the section above:

Translations

If you've added the Translate and Adapt app to your store, you'll see the link to it from within the "Theme content" area. While you can open the app from your apps list, you can also open directly from there:

Once inside the "Translate and Adapt" app, scroll down to find the Theme > "default theme content" area and press on it.

Then, similarly to above, you'll see a Locksmith section that you are free to edit as much as you need.

Do this for all of your store languages.

Important caveat

The messages added with the above method are managed by Locksmith. If you delete the declaration in your messages (the {{ "locksmith.foo.bar" | t }} part), the corresponding messages will be deleted from (all of) your locale files.

If you want a persistent message, that isn't directly connected to, managed by, or deleted by Locksmith. You'll need to go with a more manual approach. Additionally, there are apps out there that can manage this kind of thing automatically.

Add this same entry into all desired locales files, and update the "Enter Passcode" to the specific language. Next, in your passcode prompt message, use the translate filter on that variable. Here's an example:

Locksmith's variant locking feature results in automatic hiding of variants that the visitor doesn't have access to. If you're using keys that are based on things that don't require customer input (say, "permit if the customer is signed in"), then revealing those variants is automatic: if the customer qualifies, the variants appear.

If you're using keys that require visitor input, like passcodes or email addresses, then an intermediate step needs to be added to the customer experience, allowing them to actually enter their information. This doesn't happen automatically, and without it, the visitor won't have a way of accessing the hidden variants.

Setup

1. Create a dedicated "sign in" page

In the Shopify admin area, head to the "Online Store" section, and open up your "Pages" list. Create a page that's just for customers who are shopping the particular variant(s) that you want to help them unlock. Add menu links to this page, if necessary and where appropriate.

2. Lock the page

Back in Locksmith, search for the page, and create a lock for it.

3. Add a passcode key to the page lock, using the same passcode as your variant lock

Here's where it comes together: by adding a passcode key that uses the same passcode as your variants, the customer's successful passcode entry here will result in the variant locks automatically opening, because they'll register the presence of the same passcode.

A bonus, if you're using multiple variant locks: Because locks can have multiple keys, there's an opportunity here for you to add multiple passcode keys here, one for each of the different variant locks you've got. This is a useful strategy if you're preparing variants for separate audiences - this allows you to have a single "sign in" page, where everyone can gain access to their respective variants.

4. Optional: configure the key to redirect to your product

If you like, use the key's advanced settings to add an automatic redirect, routing the customer to the right product page when they enter the right passcode. You can find this setting by clicking the triple-dot icon, to the right of the key condition.

As noted in step 3, this also works with multiple passcode keys. Simply add the right redirect to each passcode key, and the customers will be routed to the right place after entering their passcode.

Manage pricing and other options by creating multiple variants, and use Locksmith to manage access.

In addition to managing access to your products and collections, Locksmith can protect individual variants within your product listings.

New to product variants? Learn more here: help.shopify.com/manual/products/variants

This is a powerful feature! It can allow you to tune your product listings in a way that previously required elaborate coding, or deep manual integration with other apps.

With variant locking, you can:

• ... set up wholesale pricing on your existing products without creating duplicate products, then ensure that only your wholesalers can view those prices.

• ... reserve a certain amount of stock for a particular customer.

• ... allocate your inventory by distribution center, and restrict access regionally.

• ... add bulk quantities for your trade customers, only allowing pre-approved customers to access it.

Note: This feature may conflict with other apps. See the Incompatibilities section below for more.

Creating a variant lock

Start by ensuring you've got at least one product variant set up in your catalog. (Learn how to set these up for new products, and for existing products.)

Then, open Locksmith, and search for the name of your variant:

Note: if you don't see your variant in the search results, try opening up the "Help" page in Locksmith and pressing the Update Locksmith button there, and try your search again. This is sometimes necessary if you've very recently created your variant.

Next, select the variant and click Save. You may then add your keys.

That's it! :)

Compatibility with other apps and features

Because this feature allows you to filter out variants from view, it's likely that it will conflict with any other apps that also operate in this way. To learn more about this, see the page here:

Variant locking is not compatible with page builder apps. To learn more about this, see the page here:

To get started, search for "search" from within Locksmith, like so:

... and click on the "Search" search result. (So much searching!)

That's it! :)

Protecting search forms, using Liquid code

Out of the box, this lock only protects the /search url of your shop (as in https://myexampleshop.com/search).

To hide the search boxes that your theme may include elsewhere in your shop, open up the Liquid file that contains the search form in question, and locate the actual search form. Wrap it with Liquid that looks like this:

{% include 'locksmith-variables', locksmith_scope: 'search' %}

{% if locksmith_access_granted %}  
  <!-- your search form here! -->
{% endif %}

As you can see, this does require manual coding. If you need a hand with this, let us know! :)

Because Shopify doesn't provide any way to group pages (in the way that collections work for products), we need to get down to the code level in order to protect more than one page at a time.

To get started, you'll need to begin a "Liquid lock:

Lock all pages containing a certain word:

To lock all pages containing a certain word in the title, fill out the Liquid lock form like so:

Example code for "Liquid condition" from above image:

Submit the form to create your lock, then proceed by configuring keys as appropriate.

Lock all pages that use a certain custom template:

To lock all pages that use a certain custom template, use this:

Example code for "Liquid condition" from above image:

Submit the form to create your lock, then proceed by configuring keys as appropriate.

Lock a list of pages by page handle:

To lock a list of pages based on page handles using one lock:

To list pages handles that you would like to lock, you can do that by listing each handle in the "Liquid prelude" field where the "page_handles" variable is defined (see image below).

You can replace "first-handle,second-handle,third-handle" with your own handles and list additional handles by adding a comma "," between each handle with no spaces.

Liquid condition:

Example code for the "Liquid condition" from above image:

Liquid prelude:

Example code for the "Liquid prelude" from above image:

Submit the form to create your lock, then proceed by configuring keys as appropriate.

Additional notes:

Related articles

To try this out, open up Locksmith, and start typing "registration", like so:

Click on the "Customer Registration" result and then click "Save." Locksmith will create a lock that covers your shop's registration page. From there, feel free to add whatever keys you like!

Locksmith enforces variant locks at the Liquid level, which can result in a different set of DOM elements being present than the theme expects. For example, a list of product images might be filtered down to omit images belonging to protected variants; this could result in a DOM error when the theme tries to address an image that Locksmith has prevented from appearing.

Finding a solution

Solving this kind of problem usually involves some trial and error, all centered around making the theme's JavaScript more tolerant of elements being unexpectedly missing.

1. Start by locating the specific line of JavaScript that's raising the error.

   • All error messages come with a filename. Match this filename to the relevant JavaScript asset in your Online Store theme.

   • Look for line numbers at the end of the filename: theme.js:73 could mean that the error came from line 73 from that file.

2. Determine how that line of JavaScript is attempting to reference a DOM element on the page.

   • For example, the line group.querySelector('option[value="'+ value +'"]').disabled = true; is attempting to address an <option> element based on a product's option values. If Locksmith has filtered out that variant option, this DOM element might not exist.

3. Modify the relevant JavaScript to insulate it against the possibility of that DOM element being missing.

   • Using the example from above, we could separate the querySelector call from the attribute update.

     • assign optionElement = group.querySelector('option[value="'+ value +'"]')

     • if (optionElement) { optionElement.disabled = true; }

   • Or, we could wrap the entire thing in a try/catch block, logging the error if one was raised.

     • try { group.querySelector('option[value="'+ value +'"]').disabled = true; } catch (error) { console.error(error); }

Locksmith does its work by adding its code to your theme's files. Sometimes you may want to keep Locksmith from modifying a file in particular, whether it's for a customization, or some other reason.

To support this, Locksmith has a "Liquid assets to ignore" option. Configure it like so:

1. From within the Locksmith application, click "Settings".

2. Scroll to the bottom of the screen to the "Advanced" section.

3. For each Liquid asset you'd like to have Locksmith ignore, add its filename to the "Liquid asset blacklist" box.

That will look like this:

Out of the box, when a Locksmith lock is activated on a specific page, Locksmith will block acess to the main content of the page (i.e. everything in between the header and footer). The main content will then be replaced by Locksmith's access denied content, which might be a sign-in page, a passcode prompt, or simply a message letting the customer know that they don't have access (depending on what keys and settings you are using).

Then, of course, once a customer gains access, they will be shown the content of the page normally.

While that is the default behavior, you also have the ability to send customers to a different page before or after they gain access to the content. So in this way, there are two types of redirecting - redirecting customers right away once they arrive on the locked page, or redirecting customer once they gain access.

Redirecting customers immediately when they arrive on a locked page - before they can gain access

To redirect customers this way, you'll simply use a regular Javascript redirect script, and enter it into the "Messages" area in Locksmith. More information on the messages area here:

This is an example of a simple redirect script:

The only thing you'll need to change is the exact URL. Use the full URL whenever possible (as opposed to partial URLs).

In Locksmith, this will look something like the following:

Also keep in mind that in the case of customer account keys, you have the option to define different messages(or behavior, in this case) based on whether or not the customer is signed in when they arrive on the page. So, you could redirect customers that were signed in (but still didn't have access), for example. This would look like the following:

Redirecting customers to a login form and returning them after signing in

Sometimes, a theme's login form will include features that Locksmith is unable to present when replacing locked resources with Locksmith's access denied content. This redirect is a good way to ensure customers see the correct login form.

The following code provides an example of a JavaScript redirect that automatically redirects customers to the default login form in a Shopify store. This script includes a variable that captures the customer's current URL and sets it as the return URL after signing in. This script can be pasted into the "Guest messages content" area in Locksmith.

Redirecting customers after they've gained access

Locksmith also has the ability to redirect customers once they've arrived to a page that they have access to. This could be useful if you wanted to show different pages to different customers once they've gained access. Passcodes is an area that this is frequently used for.

So - for example: three customer groups that each need to see a different collection. If I have a landing page that I put a Locksmith lock on, we can use the redirect feature to send each customer to a different collection, depending on which passcode they've entered.

The redirect-after-access feature is found in the key settings, accessed with the edit link to the right of each key:

The Redirect URL field is in the Key options section, at the bottom of the keys settings card:

Since this is a key setting, you can set a different redirect for each key. Notice in this example that each key is redirecting to a different collection URL:

Redirecting customers from the product page to the parent collection page before access is granted:

To redirect customers in this way, you can use some Liquid code to check if a customer is on a product page and then include a regular JavaScript redirect script within that Liquid. This code can be entered into the "Guest message content" field or "Passcode prompt" area on the collection lock's settings page. More information on the messages area here:

The following code provides an example of some Liquid and a JavaScript redirect that automatically redirects customers to a collection page from a product page in a Shopify store. The Liquid code checks for the default product template to prevent the script from running on the collection page. This script includes the URL that can be modified to redirect customers to the collection page for the locked collection.

This script can be pasted into the "Guest message content" field or "Passcode prompt" field on the respective collection lock's settings page.

Related articles

Locksmith is a tool for merchants on Shopify to restrict access to the content in the "Online Store" sales channel of their Shopify store. It's a simple tool, and in some cases can be set up in only a few minutes.

To get started, open up Locksmith from your apps list.

You'll be presented with the main page. The "Add new lock" section will be your first stop:

For a more detailed overview of what Locksmith is and how the app works, see our guide linked below:

Create your first lock

To restrict access to something in your store, simply type in the name of a product, collection, page, variant, etc - you'll immediately start seeing search results. Alternatively, select a type from the dropdown to filter your search by resource type. Select the resource that you want, to place a lock on it:

More information on (and help troubleshooting) lock creation here:

Create a key

On the next page, press the "Add key" button to create a key:

Next, add at least one condition to your key. The most commonly-used key conditions will show up first, but you can search or keep scrolling for more options.

Simply select the condition that you want to use. Some conditions may ask you for some additional settings, you'll be prompted if appropriate.

There are over 20 out-of-the-box key conditions, and you can even create custom conditions! You can also combine key conditions in different ways to create unique access scenarios. For more information on that, and the complete list of key conditions, see the page here:

Wait for Locksmith to install to your theme

After you save the lock, Locksmith will usually take about 5-10 seconds to automatically update your theme. A green status bar will briefly show at the bottom of the page - once it is gone, the installation has finished.

You can now navigate to your locked content on your store front, and you should immediately see the restriction is now in place. Locksmith will automatically show the appropriate content, using the styling from your theme, on the page. The access denied content will correspond to the key condition that you used.

So, for example, if you chose a condition requiring a sign-in:

Or, if you chose a passcode-only entry method, you'll see a different prompt:

Each key condition type will have a slightly different landing page, the above two examples are not a complete list. The messages displayed on these pages can be customized as much as you need:

Out of the box, Locksmith automatically protects all content between the header and footer, for everything covered by your locks.

Sometimes this can be too aggressive - you might want to allow visitors to preview your products without being able to see pricing, for example. Or, you might want to protect just the checkout button in your cart.

Locksmith comes with an advanced manual mode that allows for this sort of thing. It disables Locksmith's full-page protection, stepping aside so that some custom code in your theme can take responsibility for hiding part of your content.

Two important notes:

• If a particular piece of content has multiple locks in play (for example, if the customer is viewing a product that is a part of several locked collections), manual locks will only work if all applicable locks have manual mode enabled.

• Remote keys require a special initialization step, when working with manual mode. For more on this, jump to the interactions with remote keys section, later in this article.

Purpose-specific guides

Use these if you already know that you're using manual locking for one of the following:

• Hiding product prices and/or the add to cart button

• Restricting checkout from the cart

General guide

Because each theme is a bit different, manual locking does require manual coding. If you install a new theme down the road, these changes will need to be re-applied.

Step 1: Enable manual mode

Moving on, the steps are as follows

1. Open up the Locksmith lock that you want to enable manual locking for.

2. Click on "Advanced" in the lock Settings section and tick the checkbox for "Enable manual locking". Then, hit save. Screenshot below...

That's it! Locksmith will hold off on its full-page protection with this enabled, and allow your custom code to enforce protection.

Step 2: Updating your theme for manual locking

Manual locking leverages Liquid variables to empower you to render content however you'd like, based on Locksmith's permissions.

Locksmith's variables are loaded via the locksmith-variables snippet. It can be included two ways, depending on context:

Using {% render %}

This usage supports "exporting" a single variable at a time, by informing the snippet of the object you're interested in (e.g. a specific product), capturing the rendered result, and performing any post-processing of the captured value necessary. For booleans and arrays, post-processing is necessary: the render tag necessarily results in a string. Boolean values are represented as their string equivalents, and arrays are represented as comma-delimited values.

The variable names that may be exported match Locksmith's standard list of variables; for variable names and definitions, see Locksmith variables.

To access any supported variable, use this approach:

{% capture var %}{% render 'locksmith-variables', variable: 'access_granted', scope: 'subject', subject: product %}{% endcapture %}
{% if var == 'true' %}
  {% assign locksmith_access_granted = true %}
{% else %}
  {% assign locksmith_access_granted = false %}
{% endif %}

For variants, one additional argument is required for the render tag: subject_parent, defining the product that contains the variant you're checking in on.

{% render 'locksmith-variables', variable: 'access_granted', scope: 'subject', subject_parent: product, subject: variant %}

Feel free to adjust this code to taste. Only the capture and render tags need to be used exactly as written; process the rendered value string in whatever way you need to. Use the support button in the corner if you've got any questions. :)

Using {% include %}

The include tag has been deprecated by Shopify. Locksmith still uses this variable itself, in situations where overriding variables is important. You shouldn't need to use this on a regular basis, but we document it here for completeness.

1. {% include 'locksmith-variables' %} – In this mode, Locksmith will autodetect the applicable locks for the current url, and set up its access variables accordingly.

2. {% include 'locksmith-variables', locksmith_subject: foobar %} – In this mode, you specify the exact object that Locksmith should base its access decisions upon. Use this if you need to load up Locksmith's variables based on the cart, or a certain product, or some other Liquid variable, regardless of what url the user is on

For the code following this tag, all of Locksmith's standard variables are now automatically available, their names being prefixed with "locksmith_". For example, you may now use "locksmith_locked", "locksmith_access_granted", and "locksmith_manual_lock". The values differ only in that arrays of integer IDs (e.g. "locksmith_lock_ids", "locksmith_opened_lock_ids", and "locksmith_key_ids") are exported as arrays of numeric strings.

For (unprefixed) variable names and definitions, see Locksmith variables.

After loading the Locksmith variables, wrap the code you'd like to conditionally hide like this:

{% if locksmith_access_granted %}
  You've got access!
{% endif %}

Interactions with remote keys

Some keys that you can configure in Locksmith require contacting our servers, remotely, in order to determine if access should be granted. Remote keys include:

• Passcode keys

• Secret link keys

• Newsletter keys

• Location keys

In most usages, remote keys don't require any theme configuration. Locksmith will render a loading screen, with a spinner animation; once it's finished initializing, it'll reload the page automatically, and your storefront's normal content will be displayed.

When using manual mode, Locksmith will show your storefront content immediately by design. Manual mode leaves you with the responsibility of updating your theme's code to show or hide content based on Locksmith's decisions. Without remote keys, this is a simple boolean: either access is granted, or denied. When combined with remote keys, we add a third state: either access is granted, or denied, or Locksmith hasn't finished initializing and the page should be refreshed.

To explain by example: in cases like price hiding, this means that there are three possibilities for the content you should display: either you should display the price (and add-to-cart form), or you should hide it, or you should display a "please wait" message, coupled with some JavaScript that reloads the page when Locksmith has finished initializing in the background. This is necessary when using location-based, IP address, and secret links keys.

To accomplish this, adapt this code for your own purposes:

{% if locksmith_access_granted %}
  <!-- the original add-to-cart button code -->
{% elsif locksmith_initialized %}
  <p>No access for you!</p>
{% else %}
  <p>Please wait&hellip;</p>
  <script>
    Locksmith.on('initialize', function () { window.location.reload(); });
  </script>
{% endif %}

The code above assumes that you've already exported the locksmith_access_granted and locksmith_initialized variables. Use one of these options to export those variables, making sure to do so before making any content decisions:

{% capture var %}{% render 'locksmith-variables', variable: 'access_granted', scope: 'subject', subject: product %}{% endcapture %}
{% if var == 'true' %}
  {% assign locksmith_access_granted = true %}
{% else %}
  {% assign locksmith_access_granted = false %}
{% endif %}

{% capture var %}{% render 'locksmith-variables', variable: 'initialized', scope: 'subject', subject: product %}{% endcapture %}
{% if var == 'true' %}
  {% assign locksmith_initialized = true %}
{% else %}
  {% assign locksmith_initialized = false %}
{% endif %}

{% include 'locksmith-variables' %}

By default, Locksmith will only automatically install itself to and update itself on the currently published theme, and does not automatically install itself to unpublished themes. However, there is a way to test Locksmith on unpublished themes.

To test Locksmith on an unpublished theme:

1. Head to the in-app "Themes" page.

2. Click the "Install" button for the theme you'd like to test Locksmith on:

1. To preview the lock configuration you just installed, click the three-dot menu (…) next to the theme name, and select Preview:

To remove Locksmith from an unpublished theme:

1. Head to the in-app "Themes" page.

2. Click the "Uninstall" button for the theme you'd like to remove Locksmith from:

Setting a secondary theme:

Locksmith supports setting a Secondary theme, which receives automatic updates along with your published theme when changes are made in Locksmith.

1. In the Unpublished themes section, locate the theme you want to set as a secondary theme.

2. Click the three-dot menu (…) next to the theme name.

3. Select Set as secondary theme:

This theme will now receive all future updates made in Locksmith, in addition to the published theme.

Keys are added, unsurprisingly, inside of the "Keys" section on the lock page:

Press that "Add the first key" button, and you'll be presented with the full list of key conditions that are available to you. There are quite a few options here!

These are all the key conditions that Locksmith supports:

Permit if the customer...

• is signed in This condition requires all customers to log in with a customer account. Once they're logged in, they'll be granted access to the locked resource. (When inverted: unless the customer is signed in)

• is tagged with… This condition first requires all visitors to log in with a customer account, by presenting your store's usual login form. (If that login form includes a link to customer registration, it'll be included here, too.) Once the customer has logged into their account, they'll be granted access if their customer account has the tag you've chosen in Locksmith. (When inverted: unless the customer is tagged with..., or is not signed in)

• gives the passcode… This condition prompts the visitor to enter a passcode, which must match the passcode you configure. If they don't enter a matching passcode, they'll be given the same prompt again.

• gives one of many passcodes… This condition allows you to configure a group of passcodes, and will grant access if the visitor is able to provide one of the passcodes on that list.

• arrives via a secret link… This condition generates a "secret" URL for the locked resource, containing a secret code. If the visitor arrives via that link, they'll be granted access. If they use any other link, they will be denied access.

• subscribes to your Mailchimp list This condition connects to your Mailchimp account, and grants access once a visitor has provided their email address, adding that address to your Mailchimp list.

• subscribes to your Klaviyo list This condition connects to your Klaviyo account, and grants access once a visitor has provided their email address, adding that address to your Klaviyo list. This option can be configured to only allow access if the submitted email address is already on that Klaviyo list.

• has one of many email addresses This condition requires the visitor to be logged in with their customer account, prompting them to log in if they aren't already. If their email address is on the list that you specify, they'll be granted access.

• has an email address from an input list… This condition requires the visitor to be logged in with their customer account, prompting them to log in if they aren't already. If their email address is on the input-list that’s specified on the key condition and has been previously synced with Locksmith, they'll be granted access.

• the customer's email contains… This condition requires the visitor to be logged in with their customer account, prompting them to log in if they aren't already. If their email address matches some text that you specify (say, "@mycompany.com"), they'll be granted access.

• has purchased… This condition requires the visitor to be logged in with their customer account, prompting them to log in if they aren't already. If their last 50 orders contain a certain product (identified by SKU, title, or by product tag), they'll be granted access.

• has placed at least x orders This condition requires the visitor to be logged in with their customer account, prompting them to log in if they aren't already. If their lifetime order count is at least the number that you specify, they'll be granted access.

• has a certain product in their cart This condition scans the visitor's current cart, and grants access if a certain product is found.

• has a certain variant in their cart This condition scans the visitor's current cart, and grants access if a certain product variant is found.

• has at least $x in their cart This condition checks the subtotal of the visitor's current cart, and grants access if the total is at least a certain amount.

• has a certain IP address This condition checks the visitor's IP address. If it matches the address or range that you specify, they'll be granted access.

• is visiting before a certain date and time This condition checks the current time, and grants access if it's before the time that you specify.

• is visiting after a certain date and time This condition checks the current time, and grants access if it's after the time that you specify.

• is visiting a certain domain This condition checks the domain of your store, and grants access if the visitors domains matches up . This is useful if you have multiple domains on your store that might be scoped to different regions of the world (or any other reason you have for creating multiple domains.

• the customer confirms the prompt This is a straightforward key condition that allows access solely based on if the customer confirms the prompt that you set.

• (custom Liquid) This condition allows you to write custom Liquid code, granting access if your Liquid condition evaluates to "true". This is the most powerful key condition, because it allows you to grant access under any circumstances that you can determine using Liquid.

Related articles

More information on how to combine key conditions together is covered in our "Overview" guide here:

Remember that all key conditions can be inverted!

Having issues with locks overlapping? Perhaps the "Force open other locks" setting is for you: