Rewrite Android Checkout Kit READMEs by tiagocandido · Pull Request #185 · Shopify/checkout-kit

tiagocandido · 2026-05-21T12:59:52Z

What changes are you making?

Refresh the Android Checkout Kit documentation:

Rewrite the Android README around install, checkout URL creation, presentation, configuration, lifecycle callbacks, browser/system callbacks, authentication, links, and samples.
Update the Android sample READMEs.

How to test

Documentation-only change.

git diff --check checkout-kit-readmes/swift...checkout-kit-readmes/android
Checked local Markdown links for the changed README files.

Before you merge

Important

I've added tests to support my implementation
I have read and agree with the Contribution Guidelines
I have read and agree with the Code of Conduct
I've updated the relevant platform README (platforms/swift/README.md and/or platforms/android/README.md)

Releasing a new Swift version?

I have bumped the version in ShopifyCheckoutKit.podspec
I have bumped the version in platforms/swift/Sources/ShopifyCheckoutKit/ShopifyCheckoutKit.swift
I have updated platforms/swift/CHANGELOG.md
I have updated the SwiftPM/CocoaPods version snippets in platforms/swift/README.md (major version only)

Releasing a new Android version?

I have bumped the versionName in platforms/android/lib/build.gradle
I have updated platforms/android/CHANGELOG.md
I have updated the Gradle/Maven version snippets in platforms/android/README.md

Tip

See the Contributing documentation for the full release process per platform.

tiagocandido · 2026-05-21T13:00:06Z

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

Update sample Storefront API version #187
Rewrite Android Checkout Kit READMEs #185 👈 (View in Graphite)
Rewrite Swift Checkout Kit READMEs #184
main

This stack of pull requests is managed by Graphite. Learn more about stacking.

github-actions · 2026-05-21T13:00:31Z

React Native — Coverage Report

Lines	Statements	Branches	Functions
	95.26% (181/190)	92.03% (104/113)	100% (56/56)

tiagocandido · 2026-05-21T13:23:52Z

Rendered README previews:

kiftio · 2026-05-22T08:30:53Z

- Chrome >= 80
+- Android `minSdk` 23+
+- Android `compileSdk` 35+ for consuming apps. This repository currently builds the library with `compileSdk` 36.
+- Chrome or Android System WebView 80+


I think this will be an end-user requirement more than anything. And only required for Google Pay right?

kiftio · 2026-05-22T08:31:52Z

+- Android `minSdk` 23+
+- Android `compileSdk` 35+ for consuming apps. This repository currently builds the library with `compileSdk` 36.
+- Chrome or Android System WebView 80+
+- A Storefront API access token and a checkout URL from `cart.checkoutUrl` or a cart permalink


With permalink, you don't really need a Storefront API access token.

Would probably drop this line

kiftio · 2026-05-22T08:33:54Z

-The SDK is an [open source Android library](https://central.sonatype.com/artifact/com.shopify/checkout-kit). As a quick start, see
-[sample projects](samples/README.md) or use one of the following ways to integrate the SDK into
-your project:
+The first Checkout Kit for Android alpha is `4.0.0-alpha.1`. Pin the alpha version explicitly until a stable `4.x` release is available.


Do we want folks to pin an unstable version?

Should we keep the pointer to the repository?

kiftio · 2026-05-22T08:35:07Z

-simplify the development workflow:
+1. Create or update a cart with the [Storefront GraphQL API](https://shopify.dev/docs/api/storefront), for example with [`cartCreate`](https://shopify.dev/docs/api/storefront/2026-04/mutations/cartCreate) and related cart mutations.
+2. Read the cart's [`checkoutUrl`](https://shopify.dev/docs/api/storefront/2026-04/objects/Cart#field-cart-checkouturl).
+3. Pass that URL, or a [cart permalink](https://help.shopify.com/en/manual/products/details/cart-permalink), to Checkout Kit without adding Checkout Kit query parameters yourself.


The without adding Checkout Kit query parameters yourself feels quite redundant

kiftio · 2026-05-22T08:36:32Z

-To present a native checkout dialog in your Android application, provide
-the `checkoutUrl` alongside optional runtime configuration settings to the `present(checkoutUrl)`
-function provided by the SDK:
+You can use any GraphQL client. The sample app uses Apollo Kotlin and is a better reference for a modern Storefront API integration.


a better reference than what?

Drop that part?

kiftio · 2026-05-22T08:44:03Z

+Checkout Kit does not create carts or authenticate buyers. Add buyer context to the cart before presenting checkout:

-### Cart: buyer bag, identity, and preferences
+- Use Storefront API cart buyer identity fields to prefill email, phone, address, country, language, and delivery preferences.


I think now some of this is deprecated, and there are separate mutations for setting delivery addresses for example

kiftio · 2026-05-22T08:45:22Z


-### Cart: buyer bag, identity, and preferences
+- Use Storefront API cart buyer identity fields to prefill email, phone, address, country, language, and delivery preferences.
+- Use Multipass for Shopify Plus stores that use Classic Customer Accounts. Generate Multipass tokens server-side and set `return_to` to the checkout URL.


This is probably still useful, but at some point I wonder if we should drop it now that multipass is officially legacy and new customer accounts are the way to go

kiftio · 2026-05-22T08:47:29Z

-see [guide](https://shopify.dev/docs/custom-storefronts/building-with-the-storefront-api/cart/manage).
-Included information will be used to present pre-filled and pre-selected choices to the buyer within
-checkout.
+Keep Storefront API tokens and Multipass secrets out of client-side code where they are not intended to be public.


I think the Storefront API tokens folks would generally use are the Public access token?

Multipass secrets for sure though

kiftio · 2026-05-22T08:48:29Z

+## Accelerated checkouts

-### Shop Pay
+Android Checkout Kit does not currently render accelerated checkout buttons. Use the checkout URL presentation flow above. Swift and React Native iOS integrations can use `ShopifyAcceleratedCheckouts` for Shop Pay and Apple Pay buttons.


Not 100% convinced we need to talk about functionality that doesn't exist

kiftio · 2026-05-22T08:48:58Z


-The Customer Account API allows you to authenticate buyers and provide a personalized checkout experience.
-For detailed implementation instructions, see our [Customer Account API Authentication Guide](https://shopify.dev/docs/storefronts/headless/mobile-apps/checkout-kit/authenticate-checkouts).
+## Samples


Should we refer to this in the singular now?

tiagocandido mentioned this pull request May 21, 2026

Rewrite Swift Checkout Kit READMEs #184

Open

11 tasks

tiagocandido marked this pull request as ready for review May 21, 2026 13:11

tiagocandido requested a review from a team as a code owner May 21, 2026 13:11

tiagocandido force-pushed the checkout-kit-readmes/swift branch from ef3cc56 to 3fa7a4a Compare May 21, 2026 13:31

tiagocandido force-pushed the checkout-kit-readmes/android branch from 46375cf to 28b134c Compare May 21, 2026 13:31

tiagocandido force-pushed the checkout-kit-readmes/swift branch from 3fa7a4a to ad19673 Compare May 21, 2026 13:33

tiagocandido force-pushed the checkout-kit-readmes/android branch from 28b134c to aea5652 Compare May 21, 2026 13:33

tiagocandido force-pushed the checkout-kit-readmes/swift branch from ad19673 to d7c2648 Compare May 21, 2026 14:12

tiagocandido force-pushed the checkout-kit-readmes/android branch from aea5652 to d11d3a1 Compare May 21, 2026 14:12

tiagocandido force-pushed the checkout-kit-readmes/swift branch from d7c2648 to 24ef2d5 Compare May 21, 2026 14:24

tiagocandido force-pushed the checkout-kit-readmes/android branch from d11d3a1 to 5cf07e4 Compare May 21, 2026 14:24

Rewrite Android Checkout Kit READMEs

eaf2a61

tiagocandido force-pushed the checkout-kit-readmes/android branch from 5cf07e4 to eaf2a61 Compare May 21, 2026 14:28

tiagocandido force-pushed the checkout-kit-readmes/swift branch from 24ef2d5 to 2f23f9f Compare May 21, 2026 14:28

tiagocandido mentioned this pull request May 21, 2026

Update sample Storefront API version #187

Draft

kiftio reviewed May 22, 2026

View reviewed changes

Conversation

tiagocandido commented May 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changes are you making?

How to test

Before you merge

Uh oh!

tiagocandido commented May 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented May 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

React Native — Coverage Report

Uh oh!

tiagocandido commented May 21, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

tiagocandido commented May 21, 2026 •

edited

Loading

tiagocandido commented May 21, 2026 •

edited

Loading

github-actions Bot commented May 21, 2026 •

edited

Loading