Skip to main content
Migrate to Polaris

Version 2025-07 is the last API version to support React-based UI components. Later versions use web components, native UI elements with built-in accessibility, better performance, and consistent styling with Shopify's design system. Check out the migration guide to upgrade your extension.

Shop API

The API for interacting with shop.

The base API object provided to purchase extension targets.

required

The shop where the checkout is taking place.

Returns the shop where the checkout is taking place.

Shop

id
string

The shop ID.

myshopifyDomain
string

The shop's myshopify.com domain.

name
string

The name of the shop.

storefrontUrl
string

The primary storefront URL.

Caution

> As of version 2024-04 this value will no longer have a trailing slash.

Was this page helpful?