Documentation
Feedback
Guides
API Reference

Guides
Guides

Buyer Portal Checkout Extensibility

Learn about Checkout extensions, how to set them up and build them, and where you can place them across the Checkout journey.

This feature is only available for stores using B2B Buyer Portal, which is currently available to selected accounts.

Buyer Portal Checkout Extensibility lets you extend the default checkout journey with capabilities aligned to your business model, such as external integrations and custom UI. Using extension points across all Checkout stages (Cart, Delivery, Review, Payment, and Order Placed), you can render your own components without changing checkout's core behavior.

The technical aspects of Checkout extensions are covered in the following articles:

Checkout hooks

Consult the hooks available to access the data layer and perform actions from your extensions:

  • useCart hook: Access cart data and perform mutations that are reflected across the checkout data layer.
  • useCartItem hook: Access detailed information about the current cart item.
  • useCartPunchout hook: Access cart data and perform mutations on the Punchout cart screen.
  • useRedirect hook: Redirect the user to another page.
  • useSettings hook: Access checkout settings, such as branding data like logos and colors.
  • useExtension hook: Access information about the current account and the extension point where your extension is running.
Contributors
1
Photo of the contributor
Was this helpful?
Yes
No
Suggest Edits (GitHub)
Contributors
1
Photo of the contributor
Was this helpful?
Suggest edits (GitHub)
On this page