# Shop

The API for interacting with shop.

## OrderStatusApi

The API object provided to this and other `customer-account.order-status` extension targets.

### Docs_OrderStatus_ShopApi

### shop

value: `Shop`

  - Shop: 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-10` this value will no longer have a trailing slash.
   */
  storefrontUrl?: string;
  /**
   * The shop's myshopify.com domain.
   */
  myshopifyDomain: string;
}
Shop where the purchase took place.

### Shop

### id

value: `string`

The shop ID.

### myshopifyDomain

value: `string`

The shop's myshopify.com domain.

### name

value: `string`

The name of the shop.

### storefrontUrl

value: `string`

The primary storefront URL.

> Caution: As of version `2024-10` this value will no longer have a trailing slash.

## useShop

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

### UseShopGeneratedType

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

#### Returns: Shop
export function useShop<
  Target extends RenderOrderStatusExtensionTarget = RenderOrderStatusExtensionTarget,
>(): Shop {
  const api = useApi<Target>();
  const extensionTarget = api.extension.target;

  if (!('shop' in api)) {
    throw new ExtensionHasNoFieldError('shop', extensionTarget);
  }

  return api.shop;
}


### Shop

### id

value: `string`

The shop ID.

### myshopifyDomain

value: `string`

The shop's myshopify.com domain.

### name

value: `string`

The name of the shop.

### storefrontUrl

value: `string`

The primary storefront URL.

> Caution: As of version `2024-10` this value will no longer have a trailing slash.