Getting Started | Docs | Contributing | Code of Conduct | License
Shopify's Checkout Kit lets native mobile apps embed Shopify's one-page checkout while preserving store customizations like Checkout UI extensions, Shopify Functions, and branding. It also keeps the experience idiomatic to the host platform with light and dark mode support, lifecycle hooks, and native APIs to embed and customize checkout.
This respository houses the implementation of Checkout Kit, use it to check implementation or open issues if you find a bug. The Shopify mobile storefront docs are where we maintain installation and step by step guides for common integration patterns.
Feature guides:
- Preload checkout - fetch checkout in the background so it's ready when buyers are.
- Monitor the checkout lifecycle - handle completion, failure, and cancellation events.
- Authenticate checkouts - sign buyers in to prefill saved addresses and payment methods.
- Privacy compliance - pass GDPR, CCPA, and ATT consent through to Shopify.
- Accelerated checkouts - Shop Pay and Apple Pay buttons for one-tap purchase on product and cart pages.
Checkout Kit is a monorepo containing all the platforms Checkout Kit supports together.
| Package | Latest version | Install channel | Description | Readme |
|---|---|---|---|---|
ShopifyCheckoutKit ShopifyAcceleratedCheckouts |
Swift Package Manager, CocoaPods | iOS checkout presentation and accelerated checkout libraries. | Readme | |
com.shopify:checkout-kit |
Maven Central | Android checkout presentation and accelerated checkout support. | Readme | |
@shopify/checkout-kit-react-native |
npm | React Native wrapper for Checkout Kit. | Readme |
Checkout Kit is the new name for the Checkout Sheet Kit SDKs. It resets the version line to Checkout Kit v1, and all future development will be under Checkout Kit.
The legacy Checkout Sheet Kit lines are deprecated and remain available for apps maintaining older integrations.
| Platform | Status | Package | Final release | Readme |
|---|---|---|---|---|
| iOS | Checkout Sheet Kit for Swift | 3.8.x |
Readme | |
| Android | Checkout Sheet Kit for Android | 3.5.x |
Readme | |
| React Native | Checkout Sheet Kit for React Native | 4.0.x |
Readme |
Issues and pull requests are welcome. See CONTRIBUTING and our Code of Conduct.
