Choose a version:

Shop
API

The API for interacting with shop.

Anchor to standardapiStandardApi

The base API object provided to purchase, and customer-account.order-status extension targets.

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

Docs_Standard_ShopApi

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

export interface Docs_Standard_ShopApi extends Pick<StandardApi, 'shop'> {}

Shop

id
The shop ID.
```
string
```
name
The name of the shop.
```
string
```
storefrontUrl
The primary storefront URL.
```
string
```
myshopifyDomain
The shop's myshopify.com domain.
```
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.
   */
  storefrontUrl?: string;
  /**
   * The shop's myshopify.com domain.
   */
  myshopifyDomain: string;
}

Was this section helpful?

Anchor to useShop
useShop()

Returns the shop where the checkout is taking place.

Anchor to useShop-returnsReturns

Shop

id string: The shop ID.
name string: The name of the shop.
myshopifyDomain string: The shop's myshopify.com domain.
storefrontUrl string: The primary storefront URL.

UseShopGeneratedType

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

Shop

Shop

export function useShop<
  Target extends RenderExtensionTarget = RenderExtensionTarget,
>(): Shop {
  return useApi<Target>().shop;
}

Shop

id
The shop ID.
```
string
```
name
The name of the shop.
```
string
```
storefrontUrl
The primary storefront URL.
```
string
```
myshopifyDomain
The shop's myshopify.com domain.
```
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.
   */
  storefrontUrl?: string;
  /**
   * The shop's myshopify.com domain.
   */
  myshopifyDomain: string;
}

Was this section helpful?