Understand available checkout launch flows

Launch hosted checkout from application code without depending on unpublished widget packages.

Orderboost currently provides hosted checkout URLs, not a public button or widget distribution. The @orderboost/widget, @orderboost/react, and @orderboost/sdk workspaces in this repository are unpublished and unsupported as npm integrations.

Launch Buy Now from application code

Your storefront owns the button. On activation, it sends the canonical product URL to Orderboost and opens the returned hosted checkout URL.

Open the blank popup inside the buyer’s click before awaiting the network response. The browser can otherwise block the popup.

Continue a merchant-owned cart

The storefront owns cart state until checkout creation. Send the current canonical product URLs, quantities, and selected option labels as items to POST https://capi.orderboost.org/api/v1/buyer-checkouts.

Orderboost requotes every item. Treat pre-checkout cart totals as informative and the returned checkout totals as authoritative.

Publish a stable Buy Now link

Use the capability-free /buy route for an email, message, anchor, or QR code:

https://capi.orderboost.org/buy?product={encodedCanonicalProductUrl}

The GET request creates no checkout. The buyer’s browser submits the page and receives a fresh hosted checkout.

Treat other browser surfaces as internal

The repository contains internal implementations for sign-in launchers, tips, cart presentation, Page Guard, popup messaging, and local checkout callbacks. They are not distributed developer contracts today.

Do not document initialScreen, displayMode, OrderboostWidget, Page Guard callbacks, or widget lifecycle events as public integration APIs until the packages are published and versioned.

Follow Create hosted checkout from an application for the supported browser path.