For the complete documentation index, see llms.txt. This page is also available as Markdown.

Why is Locksmith adding information to my orders?

Why is this happening?

For key conditions like passcodes, secret links, and location limits, Locksmith adds system information to the visitor's cart. This is how we keep things fast – the cart is the only place that Shopify can store visit-specific information.

This means that, on checkout, this data can make it all the way into your order records. If this is happening, you'll see something like this in your order information:

If you have a large number of keys in your shop, this value can get quite large!

Note: You may see Locksmith notes in the order even if the order came from a customer that does not have access to any of your locked content. Depending on your Locksmith settings, it may be necessary to cache the fact that the current customer does indeed not have access, which still keeps server pings to a minimum (and helps speed things up, as per the above).

What does the value actually mean?

The Locksmith attribute value can tell you how a customer interacted with your locked content during their visit. There are two parts to look for: the colon and any numbers in front of it.

When the value starts with a colon (for example, :6e5deb114b44), with no numbers in front, it means the customer interacted with a locked page during their browsing session but did not unlock it. Even just landing on a locked page is enough to generate this — it doesn't mean they gained access.

When there are numbers before the colon (for example, 471092:6e5deb114b44), those numbers correspond to the key ID(s) the customer satisfied. In other words, the customer did use a key to open the lock, and the number points to which key. If a customer met the conditions of several keys, you may see more than one ID here.

Note: This information is added for server-side key conditions (like passcodes, secret links, and location limits — any key that shows a loading spinner). It can appear whether or not the customer was ultimately granted access, so seeing a value here is not on its own a sign that a customer got past a lock.

This can be a useful diagnostic clue. For example, if you're investigating an order on a locked product and the value starts with a colon (no key ID), that tells you the customer likely never unlocked the product page itself — which can point to the item being added to the cart another way, such as through a cart permalink, a third-party app, or another sales channel.

A (partial) solution

To allow Locksmith to automatically remove its information from an order's "Additional Details", head to your Locksmith Settings area, and enable the "Remove Locksmith information from orders" setting next to Advanced on the page. The setting looks like this:

After you enable this setting, Locksmith may ask you for the additional permissions needed for updating your order records. Once you grant permission, Locksmith will take care of keeping its data out of your orders from that point onward.

Locksmith notes still appearing in confirmation emails or third party apps?

In most cases, this information won't be customer-facing. However, some third party invoicing apps will automatically include cart.attributes in their invoices. If your invoices include the Locksmith information in them, you may need to contact the support for your invoice service and ask them to exclude cart attributes from invoices.

The above setting does NOT help in all cases, particularly when your order information is sent off before Locksmith has the chance to remove its own information.

If you are having issues with this, your best bet is to contact us via email at team@uselocksmith.com and we can go through your other options with you.

Removed Locksmith but still noticing order notes?

The notes are stored on the customer's browser, and the traces of this can still end up in the "Additional Details" section of some incoming orders. If you've deleted Locksmith, seeing these in your orders is not an indication that Locksmith is still embedded in your theme, just that the customer in question is running on the same browser "session" that they were running when you still had Locksmith installed on your store. You should see these drop off over time. However, if they are causing you issues, let us know at team@uselocksmith.com - we can help you out by adding a script to your theme that will delete the Locksmith cache from their browser as soon as customers visit (and before they place their next order).

Last updated

Was this helpful?