---
title: Shop API
description: The API for interacting with shop.
api_version: 2025-07
api_name: checkout-ui-extensions
source_url:
  html: >-
    https://shopify.dev/docs/api/checkout-ui-extensions/2025-07/target-apis/platform-apis/shop-api
  md: >-
    https://shopify.dev/docs/api/checkout-ui-extensions/2025-07/target-apis/platform-apis/shop-api.md
---

Migrate to Polaris

Version 2025-07 is the last API version to support React-based UI components. Later versions use [web components](https://shopify.dev/docs/api/checkout-ui-extensions/latest/polaris-web-components), native UI elements with built-in accessibility, better performance, and consistent styling with [Shopify's design system](https://shopify.dev/docs/apps/design). Check out the [migration guide](https://shopify.dev/docs/apps/build/checkout/migrate-to-web-components) to upgrade your extension.

# Shop API

The API for interacting with shop.

### Support Targets (54)

### Supported targets

* Checkout::Actions::Render​Before
* Checkout::Cart​Line​Details::Render​After
* Checkout::Cart​Lines::Render​After
* Checkout::Contact::Render​After
* Checkout::Customer​Information::Render​After
* Checkout::Delivery​Address::Render​Before
* Checkout::Dynamic::Render
* Checkout::Pickup​Locations::Render​After
* Checkout::Pickup​Locations::Render​Before
* Checkout::Pickup​Points::Render​After
* Checkout::Pickup​Points::Render​Before
* Checkout::Reductions::Render​After
* Checkout::Reductions::Render​Before
* Checkout::Shipping​Method​Details::Render​After
* Checkout::Shipping​Method​Details::Render​Expanded
* Checkout::Shipping​Methods::Render​After
* Checkout::Shipping​Methods::Render​Before
* Checkout::Thank​You::Cart​Line​Details::Render​After
* Checkout::Thank​You::Cart​Lines::Render​After
* Checkout::Thank​You::Customer​Information::Render​After
* Checkout::Thank​You::Dynamic::Render
* purchase.​address-autocomplete.​format-suggestion
* purchase.​address-autocomplete.​suggest
* purchase.​checkout.​actions.​render-before
* purchase.​checkout.​block.​render
* purchase.​checkout.​cart-line-item.​render-after
* purchase.​checkout.​cart-line-list.​render-after
* purchase.​checkout.​chat.​render
* purchase.​checkout.​contact.​render-after
* purchase.​checkout.​delivery-address.​render-after
* purchase.​checkout.​delivery-address.​render-before
* purchase.​checkout.​footer.​render-after
* purchase.​checkout.​header.​render-after
* purchase.​checkout.​payment-method-list.​render-after
* purchase.​checkout.​payment-method-list.​render-before
* purchase.​checkout.​pickup-location-list.​render-after
* purchase.​checkout.​pickup-location-list.​render-before
* purchase.​checkout.​pickup-location-option-item.​render-after
* purchase.​checkout.​pickup-point-list.​render-after
* purchase.​checkout.​pickup-point-list.​render-before
* purchase.​checkout.​reductions.​render-after
* purchase.​checkout.​reductions.​render-before
* purchase.​checkout.​shipping-option-item.​details.​render
* purchase.​checkout.​shipping-option-item.​render-after
* purchase.​checkout.​shipping-option-list.​render-after
* purchase.​checkout.​shipping-option-list.​render-before
* purchase.​thank-you.​announcement.​render
* purchase.​thank-you.​block.​render
* purchase.​thank-you.​cart-line-item.​render-after
* purchase.​thank-you.​cart-line-list.​render-after
* purchase.​thank-you.​chat.​render
* purchase.​thank-you.​customer-information.​render-after
* purchase.​thank-you.​footer.​render-after
* purchase.​thank-you.​header.​render-after

## StandardApi

The base API object provided to `purchase` extension targets.

* **shop**

  **Shop**

  **required**

  The shop where the checkout is taking place.

### Shop

* id

  The shop ID.

  ```ts
  string
  ```

* myshopifyDomain

  The shop's myshopify.com domain.

  ```ts
  string
  ```

* name

  The name of the shop.

  ```ts
  string
  ```

* storefrontUrl

  The primary storefront URL. > Caution: > As of version \`2024-04\` this value will no longer have a trailing slash.

  ```ts
  string
  ```

## use​Shop()

Returns the `shop` where the checkout is taking place.

### Returns

* **Shop**

  ### ### 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:** \&gt; As of version \<code>2024-04\</code> this value will no longer have a trailing slash.

## Related

[Reference - Targets](https://shopify.dev/docs/api/checkout-ui-extensions/targets)

[Reference - Components](https://shopify.dev/docs/api/checkout-ui-extensions/components)

[Reference - Configuration](https://shopify.dev/docs/api/checkout-ui-extensions/configuration)

[Learn - Tutorials](https://shopify.dev/apps/checkout)