Checkout UI Extension: Customizing the Checkout Page
Merchants can use the Checkout UI Extension to customize the appearance and behavior of the checkout page. There are three available customization methods:
- Hide specific modules: Use
ExtensionTarget
to hide predefined elements on the page. - Add custom content: Insert personalized content at designated
ExtensionPoint
locations. - Access and modify order information: Use the
CheckoutAPI
to retrieve order details and adjust checkout behaviors as needed.
Using Extension Points
Extension points allow you to insert custom content at specified locations on the checkout page.
Example: Adding Content Above the Navigation Bar
import { extend } from 'shoplazza-extension-ui';
extend({
extensionPoint: 'Checkout::Navigate::RenderBefore',
component: "<h1>Hello, Shoplazza!</h1>"
});
Available extension points include:
Extension Point | Description |
---|---|
Checkout::RenderBefore | Before page header |
Checkout::RenderAfter | After page footer |
Checkout::Head::RenderAfter | After page header |
Checkout::FilledInformation::RenderAfter | After filled information card |
Checkout::SpecialInstruction::RenderAfter | After special instructions |
Checkout::Summary::RenderBefore | Before summary information |
Checkout::Navigate::RenderBefore | Before navigation bar |
Checkout::Navigate::RenderAfter | After navigation bar |
Checkout::ContactInformation::RenderBefore | Before contact information |
Checkout::ContactInformation::RenderAfter | After contact information |
Checkout::ShippingLinesTitle::RenderBefore | Before shipping list title |
Checkout::ShippingLinesTitle::RenderAfter | After shipping list title |
Checkout::ShippingList::RenderAfter | After shipping list |
Checkout::ProductList::RenderBefore | Before product list module |
Checkout::ProductList::RenderAfter | After product list module |
Checkout::Reductions::RenderBefore | Before coupons/gift cards |
Checkout::Reductions::RenderAfter | After coupons/gift cards |
Checkout::SectionPayment::RenderBefore | Before payment section |
Checkout::SectionPayment::RenderAfter | After payment section |
Checkout::ThankyouHeader::RenderBefore | Before thank-you page header |
Checkout::ThankyouContent::RenderBefore | Before thank-you page content area |