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.

Choose a version:

Shop API

The API for interacting with shop.

Anchor to standardapiStandardApi

The base API object provided to purchase extension targets.

Anchor to shop shop required: The shop where the checkout is taking place.

Shop

id
The shop ID.
```
string
```
myshopifyDomain
The shop's myshopify.com domain.
```
string
```
name
The name of the shop.
```
string
```
storefrontUrl
The primary storefront URL. > Caution: > As of version `2024-04` this value will no longer have a trailing slash.
```
string
```

Anchor to useShop
useShop()

Returns the shop where the checkout is taking place.

Anchor to useShop-returnsReturns

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.
Caution: > As of version <code>2024-04</code> this value will no longer have a trailing slash.

Shop

id
The shop ID.
```
string
```
myshopifyDomain
The shop's myshopify.com domain.
```
string
```
name
The name of the shop.
```
string
```
storefrontUrl
The primary storefront URL. > Caution: > As of version `2024-04` this value will no longer have a trailing slash.
```
string
```