Shop

Shop is Shopify's consumer commerce surface, used by hundreds of millions of shoppers to discover products, track orders, and check out faster. Use the Shop platform's APIs and SDKs to connect with Shop users on your storefront, manage custom data on user profiles, and create product lists like wishlists and favorites.

Developer preview

The Shop platform is in early access. Features and APIs may change before general availability.

GET STARTED

Anchor to Set up your Shop integrationSet up your Shop integration

Get the credentials and SDK you need before building use cases. Create an app in the Dev Dashboard to get your client ID and secret.

Create an app

Set up an app in the Dev Dashboard to get the credentials you need for Shop APIs and SDKs.

Set up the Shop SDK

Web components for embedding Shop functionality directly into any storefront via a script tag.

USE CASES

Anchor to Build for Shop usersBuild for Shop users

Connect with Shop users on your storefront, handle sign-in, capture leads, and manage user data.

Sign in with Shop

Add a Sign in with Shop button to your self-hosted login page using the <shop-login-button> web component and OpenID Connect.

Recognize returning users

Use the Shop SDK's onRecognized event to silently detect returning Shop users and personalize your storefront.

Lead capture

Capture leads on your storefront by recognizing returning Shop users and collecting email addresses.

Wishlist

Let users save products to wishlists using the Shop Users API's product list mutations.

Store metafields

Store custom data on Shop users as metafields and read it from Shopify Functions and Checkout UI extensions.

RELATED APIS

Anchor to Explore the full API surfaceExplore the full API surface

Reference documentation for the GraphQL APIs and extended surfaces powering Shop use cases.

Shop SDK

Web components for embedding Shop functionality directly into any storefront via a script tag.

Shop Partners API

Partner-level API for managing metafield definitions, issuing user tokens, and handling media on the Shop platform.

Shop Users API

User-scoped API for reading and writing metafields, managing product lists, and accessing favorites.

Shop Minis

Build immersive, full-screen shopping experiences inside the Shop app with the Shop Minis React SDK.