Is the Analytics API actually available on the Order Status Page?

Hi everyone,
I’m running into an issue where the Analytics API is not available on the order status page, even though the Shopify documentation states that it should be.

I’m importing useApi from the correct package @shopify/ui-extensions-react/customer-account and using the appropriate extension target (customer-account.order-status.block.render) for the order status page but I’m still getting this error:

Uncaught Error: The analytics API is not available on the order status page

This makes it unclear whether the API is truly supported in this context or if the documentation is outdated.


Is the Analytics API supported on the Order Status Page? If yes, are there any special requirements to make it available (e.g. target types, packages, extension setup, etc)?

Hi there :waving_hand:

You’re doing all the right things, it’s the documentation that’s misleading here. The Analytics API is currently not implemented on the Order Status page (or any other customer account page), but it will be available very shortly. Once it is available, you can take this same approach and you’ll be able to interact with Web Pixel events.

Apologies for the confusion!

1 Like