---
title: Shop
description: The API for interacting with shop.
api_version: 2024-10
api_name: customer-account-ui-extensions
source_url:
  html: >-
    https://shopify.dev/docs/api/customer-account-ui-extensions/2024-10/apis/order-status-api/shop
  md: >-
    https://shopify.dev/docs/api/customer-account-ui-extensions/2024-10/apis/order-status-api/shop.md
---

# Shop

The API for interacting with shop.

## OrderStatusApi

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

* shop

  Shop

  required

  Shop where the purchase took 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-10\` this value will no longer have a trailing slash.

  ```ts
  string
  ```

```ts
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;
}
```

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

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

### 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-10\` this value will no longer have a trailing slash.

  ```ts
  string
  ```

```ts
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;
}
```