Shopify's one-page checkout for native mobile apps and web storefronts.
Checkout Kit preserves your checkout customizations, including Checkout UI extensions, Shopify Functions, branding, Shop Pay, and supported payment methods.
Choose your platform for installation instructions and API details:
- Swift — Present checkout in an iOS app.
- Android — Present checkout in an Android app.
- React Native — Use the iOS and Android SDKs from React Native. Requires the New Architecture.
- Web — Open checkout with the
<shopify-checkout>web component.
For SwiftUI Shop Pay and Apple Pay buttons on iOS 16+, see Accelerated checkouts.
The Shopify.dev overview covers end-to-end integration and product concepts. For specific workflows:
- Authenticate checkouts
- Monitor the checkout lifecycle
- Offsite payments
- Privacy compliance
- Accelerated checkouts
- Swift samples — Storefront API cart flow, checkout presentation, Customer Account API, and accelerated checkout buttons.
- Android samples — Storefront API cart flow, checkout presentation, protocol lifecycle events, file chooser, and geolocation callbacks.
- Web sample — Local playground for the
<shopify-checkout>component andec.*events.
| Capability | Swift | Android | React Native | Web |
|---|---|---|---|---|
| Checkout URL | Yes | Yes | Yes | Yes |
| Cart permalinks | Yes | Yes | Yes | Yes |
| Color schemes | Yes | Yes | Yes | N/A |
| Dismiss/fail callbacks | Yes | Yes | Yes | Close/error events |
| Typed protocol events | Yes | Yes | Partial | Yes |
| File chooser and permissions | System | Host callbacks | Host callbacks¹ | Browser |
| Pickup geolocation | System prompt | Host callback | Helper/custom¹ | Browser |
| Offsite payment return | Universal Links | App Links/deep links | Platform-dependent | Tab/popup |
| Accelerated buttons | iOS 16+ | No | iOS 16+ | No |
- Checkout URL means
cart.checkoutUrl. Color schemes include light, dark, and web. - React Native protocol events depend on the underlying native SDK.
- ¹ React Native Android: File chooser and web permissions use host callbacks. Geolocation uses the default helper or a custom handler. Native Android requires a host callback for geolocation.
Package names link to their integration guides. These are the versions tracked by this repository.
| Package | Version | Installation |
|---|---|---|
ShopifyCheckoutKit |
4.0.0 |
Swift Package Manager, CocoaPods |
ShopifyAcceleratedCheckouts |
4.0.0 |
Swift Package Manager, CocoaPods subspec |
com.shopify:checkout-kit |
4.0.0 |
Maven Central |
@shopify/checkout-kit-react-native |
4.0.0 |
npm latest |
@shopify/checkout-kit |
4.0.0 |
npm latest |
Supporting packages: Embedded Checkout Protocol
These internal/supporting clients handle Embedded Checkout Protocol messages.
Checkout Kit is the current home for the SDKs previously published as Checkout Sheet Kit.
- Platform releases are versioned independently and follow semantic versioning. Each platform records its changes in its own
CHANGELOG.md, managed with Changesets (see contributing).
Migrating from Checkout Sheet Kit
The legacy standalone repositories remain available for apps that have not migrated.
| Platform | Legacy package | Final legacy line |
|---|---|---|
| iOS | checkout-sheet-kit-swift |
3.8.x |
| Android | com.shopify:checkout-sheet-kit |
3.5.x |
| React Native | @shopify/checkout-sheet-kit |
4.0.x |
This repository contains the platform implementations, samples, and protocol bindings. Issues and pull requests are welcome; see the contribution guide.