Wix eCommerce: Checkout Page
The following slots and APIs are available when building a plugin for the Checkout Page.
Slots
The following image shows slots in the checkout page, into which users can add plugins.
The slots are represented by the following placement object:
Provide the following values for each property:
| Key | Value |
|---|---|
appDefinitionId | "1380b703-ce81-ff05-f115-39571d94dfcd" |
widgetId | "14fd5970-8072-c276-1246-058b79e70c1a" |
slotId | ID of the slot you want as displayed in the image above. Supported values:
|
For example, for your widget to appear before the totals breakdown in a checkout page use the following object in your configuration:
Learn more about how to add your plugin to a slot from the dashboard page.
Checkout Plugin API
Use the Checkout plugin API to integrate with the plugin's host.
The API provides data about the current checkout process and lets you define a callback function that is invoked whenever changes are made in the checkout.
Properties
| Name | Type | Description |
|---|---|---|
checkoutId | String | The ID of the current checkout process. |
stepId | String | The ID of the step currently rendered in the checkout page, which can be one of the following:
|
Functions
| Name | Type | Description |
|---|---|---|
onRefreshCheckout() | (refreshCheckoutCallback: () => void) => void | An event handler that accepts a callback function that is invoked by a widget. The widget should call the function whenever the checkout needs to be refreshed. |
Code example
Related Wix Backend APIs
Checkout plugins usually need to integrate with Wix eCommerce's Checkout APIs, as well as other backend APIs.
In your site plugin or in your app's server code, you may want to perform actions or implement logic that is dependent on the state of the current checkout or related data.
The following Wix APIs may be useful:
- eCommerce APIs (Velo, REST, JavaScript SDK)
- Stores APIs (Velo, REST, JavaScript SDK)