Upgrade to Polaris
Version 2025-07 is the last API version to support React-based UI components. Later versions use Polaris web components, native UI elements with built-in accessibility, better performance, and consistent styling with Shopify's design system. Check out the upgrade guide to upgrade your extension and avoid being blocked from updating your extension after October 1st 2026.
Shop API
The API for interacting with shop.
Anchor to StandardApiStandard
The base API object provided to purchase extension targets.
- Anchor to shopshopshopShopShoprequiredrequired
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 useShopuse
use
Returns the Shop where the checkout is taking place.
Anchor to useShop-returnsReturns
ShopShop
Was this page helpful?