How to Replace order.{anything} with checkout.order_id in Additional Scripts

Tomas Janu

|

July 5, 2024

How to Replace order.{anything} with checkout.order_id in Additional Scripts

If you are using order.{anything} in your additional scripts, you likely get an "action required" e-mail from Shopify. In this article, we'll explain how to fix the issue using the new checkout field.

How to Replace order.{anything} with checkout.order_id in Additional Scripts

In February 2023, Shopify announced the depreciation of the infamous checkout.liquid file and the platform shift to the new Checkout Extensibility approach for modifying checkout.

While the checkout.liquid and Checkout Extensibility are available only for Shopify Plus merchants, the change also impacts Additional Scripts available to all merchants.

E-mail from Shopify sent to merchants using the order field on the thank you page
E-mail from Shopify sent to merchants using the order field on the thank you page

Recently, all merchants with additional scripts using the variable "order.{anything}" received an e-mail "Action required: Use "checkout.order_id" on the Thank You page" from Shopify asking them to replace the variable with the new "checkout.order_id". This has raised several questions from merchants about how to do that, so we put together this guide.

Updating the additional scripts step-by-step

  • Log in to your store admin and navigate to Settings > Checkout
  • Scroll down to the Order status page additional scripts
  • In the input box, find all "order.anything" (i.e., order.order_number, order.currency, etc.) instances. You actually need to search for "order." in your browser (CTRL + F in Windows or command ⌘ + F on Mac)
  • Replace all order instances with the new variable per the table below
  • Confirm by clicking on Save, and make sure to test the new script
Finding the order field in additional scripts
Finding the order field in additional scripts
Order Object Propery (old) Checkout Object Property (new)
order.name checkout.order_id
order.number checkout.order_id
order.id checkout.order_id
order.order_number checkout.order_id
checkout.order_number checkout.order_id
checkout.order_name checkout.order_id
order.currency checkout.currency
order.email checkout.email
corder.created_at

If you are missing any checkout parameters, please see the full list of checkout liquid object properties. Alternatively, get in touch with us, and our agency team will be happy to help.

Why you should do it

The problem is the field "order.{anything}" is populated during the order creation. With the new Checkout Extensibility, it happens independently, so the thank you page loads faster.

However, in most cases, the field "order.{anything}" won't be available, which could affect your store analytics and marketing tracking. The checkout field will work reliably.

Keep in mind the additional scripts will be discontinued

Anyway, keep in mind that all additional scripts will be discontinued on August 28, 2025. The proper solution is to use app pixels, custom pixels, or app blocks.

Additional scripts will be turned off on August 28, 2025
Additional scripts will be turned off on August 28, 2025

By removing the additional scripts today and using any of the above, you will also get access to the brand-new checkout editor, which allows you to customize the checkout steps. It works even on the Shopify Basic plan.

Tomas Janu

Tom loves writing about upselling, conversion optimization, and e-commerce trends. He is one of our co-founders, and you can sometimes talk to him if you contact our support team. Make sure to follow him on LinkedIn for more Shopify-related tips and news.
Try for freeCandy Rack preview

Latest articles

All articles

Boost your Shopify business with our apps

All our apps are designed to help you grow your Shopify business. Check them out and take advantage of the free trial period.

Boost my Shopify