Extension

API

The API version that was set in the extension config file.

The allowed capabilities of the extension, defined in your shopify.ui.extension.toml file.

• api_access: the extension can access the Storefront API.

• network_access: the extension can make external network calls.

• block_progress: the extension can block a buyer's progress and the merchant has allowed this blocking behavior.

Whether your extension is currently rendered to the screen.

Shopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.

Your extension might also continue to run after the buyer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the buyer navigates back.

The URL to the script that started the extension target.

The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.

Information about the editor where the extension is being rendered.

The value is undefined if the extension is not rendering in an editor.

The published version of the running extension target.

For unpublished extensions, the value is undefined.