--- title: Shop description: The API for interacting with shop. api_version: 2025-10 api_name: checkout-ui-extensions source_url: html: https://shopify.dev/docs/api/checkout-ui-extensions/latest/apis/shop md: https://shopify.dev/docs/api/checkout-ui-extensions/latest/apis/shop.md --- # ShopAPI The API for interacting with shop. ## 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 ``` ```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-04` 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-04` 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-04\` 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-04` this value will no longer have a trailing slash. */ storefrontUrl?: string; /** * The shop's myshopify.com domain. */ myshopifyDomain: string; } ``` ## Related [![](https://shopify.dev/images/icons/32/blocks.png)![](https://shopify.dev/images/icons/32/blocks-dark.png)](https://shopify.dev/docs/api/checkout-ui-extensions/targets) [ReferenceTargets](https://shopify.dev/docs/api/checkout-ui-extensions/targets) [![](https://shopify.dev/images/icons/32/apps.png)![](https://shopify.dev/images/icons/32/apps-dark.png)](https://shopify.dev/docs/api/checkout-ui-extensions/components) [ReferenceComponents](https://shopify.dev/docs/api/checkout-ui-extensions/components) [![](https://shopify.dev/images/icons/32/gear.png)![](https://shopify.dev/images/icons/32/gear-dark.png)](https://shopify.dev/docs/api/checkout-ui-extensions/configuration) [ReferenceConfiguration](https://shopify.dev/docs/api/checkout-ui-extensions/configuration) [![](https://shopify.dev/images/icons/32/tutorial.png)![](https://shopify.dev/images/icons/32/tutorial-dark.png)](https://shopify.dev/apps/checkout) [LearnTutorials](https://shopify.dev/apps/checkout)