Checkout Kit

Shopify.dev docs  |  Contributing  |  Code of Conduct  |  License

Shopify Checkout Kit lets native mobile apps and web storefronts present Shopify's one-page checkout while preserving checkout customizations such as Checkout UI extensions, Shopify Functions, branding, Shop Pay, and supported payment methods.

Warning

Alpha - early preview. This software is an early preview and is not production-ready. Stability is not guaranteed, and breaking changes may occur in any release. See Packages.

What is in this repo

This repository contains the Checkout Kit implementations, samples, and protocol bindings. Use it to inspect platform behavior, run samples, report bugs, and contribute fixes. The Shopify.dev mobile storefront docs remain the primary place for end-to-end product guidance and conceptual walkthroughs.

Packages

Package	Checkout Kit release	Install channel	Status	Description	README
ShopifyCheckoutKit	4.0.0-alpha.1	Swift Package Manager, CocoaPods	Alpha	iOS checkout presentation SDK.	Swift
ShopifyAcceleratedCheckouts	4.0.0-alpha.1	Swift Package Manager, CocoaPods subspec	Alpha	SwiftUI Shop Pay and Apple Pay accelerated checkout buttons for iOS 16+.	Swift
com.shopify:checkout-kit	4.0.0-alpha.1	Maven Central	Alpha	Android checkout dialog SDK.	Android
@shopify/checkout-kit-react-native	4.0.0-alpha.1	npm next dist-tag	Alpha	React Native wrapper for the iOS and Android native SDKs.	React Native
@shopify/checkout-kit	4.0.0-alpha.2	npm next dist-tag	Alpha	Web component for opening Shopify checkout from a web page.	Web
ShopifyCheckoutProtocol	Source package	Swift Package Manager	Internal/supporting	Swift client for Embedded Checkout Protocol messages.	Protocol Swift

Swift, Android, and React Native rows show the planned first Checkout Kit alpha releases. Web is already published as 4.0.0-alpha.2.

Platform Support

Capability	Swift	Android	React Native	Web
Present checkout from cart.checkoutUrl	Yes	Yes	Yes	Yes
Cart permalink support	Yes	Yes	Yes	Yes
Light, dark, and web color schemes	Yes	Yes	Yes	Not applicable
Checkout cancel/fail callbacks	Yes	Yes	Yes	Close/error events
Typed checkout protocol events	Yes	Yes	Partial/native-dependent	Yes
File chooser and web permissions	iOS system behavior	Host callbacks	Android host callbacks	Browser behavior
Geolocation for pickup points	iOS system prompt	Host callback required	Android default helper or custom handler	Browser behavior
Offsite payment return routing	Universal Links	App Links/deep links	Platform-dependent	New tab/popup routing
Accelerated checkout buttons	iOS 16+	No	iOS 16+	No

Integration Guides

Start with the platform README for package installation and API details:

• Swift
• Android
• React Native
• Web

Use the Shopify.dev guides for broader product workflows:

• Checkout Kit overview
• Authenticate checkouts
• Monitor the checkout lifecycle
• Offsite payments
• Privacy compliance
• Accelerated checkouts

Samples

Platform	Sample README	What it demonstrates
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> web component and checkout:* events.

Versioning

Checkout Kit is the current home for the SDKs that were previously published as Checkout Sheet Kit. The renamed packages use a shared 4.0.0-alpha.X version format while the new package line settles:

• Swift, Android, and React Native start at 4.0.0-alpha.1.
• Web is currently 4.0.0-alpha.2 and is published under the npm next dist-tag.
• React Native requires React Native New Architecture.
• Stable releases will continue on the same 4.x package line after the alpha period.

The legacy standalone Checkout Sheet Kit 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

Contributing

Issues and pull requests are welcome. See CONTRIBUTING and our Code of Conduct.