API to identify which App Blocks are (or aren't) installed

[edhgoose]

Please list the related package(s)

checkout-ui-extensions

If this related to specific APIs or components, please list them here

N/A

Is your feature request related to a problem? Please describe.

We've had many clients who've installed our app, but completely miss the "adding the App Block" step. They install the app, configure it, but then don't actually add anything into their Checkout. Or, they add it in only one of the three places we need them to add it.

We expect users to add something into the Pre Purchase, Thank You and Order Status pages, and in 100% of cases where they've not done this it's been a misunderstanding on the users part.

While better documentation and guidance is something we can provide, it would make a big difference if we could expose that information in the Settings of our App.

Describe the changes you are looking for

A way to programmatically query a store and identify:

• What AppBlocks are added onto each page (doesn't need to be all AppBlocks, just the ones related to our app is fine from our perspective)
• And, where in the page are they added? This is particularly important for the dynamic app blocks where they can be positioned in more than one location.
• Any configuration related to the App Block would be awesome too - for instance, has the user clicked the "Available in Shop Pay" checkbox.

Describe alternatives you’ve considered

At the moment we use two processes:

1. We can look at calls to our API to identify some data (i.e. is the extension even loading), but this doesn't tell us where it is
2. We can manually go through the checkout for each client and visually check.

Additional context

Related, but not exactly the same as:

#1911

[patryk-smc]

This would be nice to have! It's common that merchants forgot to add them and contact the support. With this, we could display in-app warning.

[edhgoose]

Highlighting a use case for this: #2218 (comment)

We had a major issue where having this data would have been helpful.

[edhgoose]

As requested in #2521, I have re-raised this issue as: https://community.shopify.dev/t/feature-request-api-to-identify-which-app-blocks-are-or-arent-installed/6394