Choose a version:

Shop

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
```

export interface Shop {
  /**
   * The shop ID.
   * @example 'gid://shopify/Shop/123'
   */
  id: string;
  /**
   * The name of the shop.
   */
  name: string;
  /**
   * The primary storefront URL.
   *
   * > Caution:
   * > As of version `2024-04` this value will no longer have a trailing slash.
   */
  storefrontUrl?: string;
  /**
   * The shop's myshopify.com domain.
   */
  myshopifyDomain: 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.

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
```

export interface Shop {
  /**
   * The shop ID.
   * @example 'gid://shopify/Shop/123'
   */
  id: string;
  /**
   * The name of the shop.
   */
  name: string;
  /**
   * The primary storefront URL.
   *
   * > Caution:
   * > As of version `2024-04` this value will no longer have a trailing slash.
   */
  storefrontUrl?: string;
  /**
   * The shop's myshopify.com domain.
   */
  myshopifyDomain: string;
}