Shopify.Checkout.OrderStatus.addContentBox seems to have stopped working

Technical Q&A

Topic summary

A Shopify developer reports that the Shopify.Checkout.OrderStatus.addContentBox JavaScript API has stopped functioning on order status pages.

Issue Details:

  • The official Shopify documentation provides instructions for using this API to add custom content boxes to order status pages
  • When following the documented example code, no content box appears on the page
  • The expected behavior was to display a custom content box (e.g., “Pick-up in store” information) above the order status

Current Status:

  • The developer seeks clarification on whether this is an intentional deprecation or a bug
  • If unintentional, they’re asking for a timeline to restore functionality
  • No responses or solutions have been provided yet

This appears to be an open issue affecting developers who rely on customizing order status pages through this JavaScript API.

Summarized with AI on November 15. AI used: claude-sonnet-4-5-20250929.
1

The instructions here for Shopify.Checkout.OrderStatus.addContentBox no longer work.

https://help.shopify.com/en/manual/orders/status-tracking/customize-order-status/order-status-javascript-asset

Is this intentional? If not, is there a timeline to restore it?

Reproduction instructions:
, - Visit an order status page on any store

  • Open console log
  • Use this example script
Shopify.Checkout.OrderStatus.addContentBox(
     '<h2>Pick-up in store</h2>',
     '<p>We are open everyday from 9am to 5pm.</p>'
    )

-Expected: The browser displays the above content box in the order status page

  • Actual: No changes occur in the browser (edited)