Skip to main content

Checkout Extensions

Checkout extensions allow apps to insert custom content at various points in the checkout flow and read checkout context data, extending the checkout experience without taking over the entire checkout page.

Checkout extensions provide three capabilities:

  • Insert content: Render custom UI at specified checkout extension points (ExtensionPoint).
  • Read data: Access checkout context such as cart, amounts, shipping, and customer via the CheckoutAPI.
  • Hide modules: Hide native checkout modules with deleteTarget.

This section includes:

Building checkout extensions

The complete workflow from creation and debugging to deployment using the Shoplazza CLI.

Checkout extension reference

The extend function, the HTML template mechanism, and how to hide native modules.

Extension points

Every slot you can render content into, grouped by area of the checkout and thank-you pages.

CheckoutAPI reference

Every namespace of window.CheckoutAPI: data, events and type definitions.

Scenario examples

Implementation examples of common checkout extensions.

Legacy extensions

Archived documentation based on the old checkout CLI.