Input parameters for starting a Shopify checkout.

interface ShopifyStartCheckoutInput {
    checkoutUrl: string;
    colorScheme?: "automatic" | "light" | "dark";
}

Properties

checkoutUrl: string

Required: The Shopify checkout URL to present. This URL is typically obtained from the Shopify Storefront API after creating a checkout.

Example: "https://your-store.myshopify.com/checkouts/cn/Z2NwLXVzLWVh..."

colorScheme?: "automatic" | "light" | "dark"

Optional: The color scheme for the checkout sheet.

  • "automatic" — Follows the device's system appearance (light/dark). This is the default.
  • "light" — Forces light mode.
  • "dark" — Forces dark mode.
"automatic"