Platform Bindings
Description
Platform Bindings is a feature that enhances developers to extend and customize the Fynd Commerce functions by integrating additional features through Extensions. The Platform Bindings is of two types:
Platform Slot Bindings
It provides predefined slots in the Fynd Commerce UI where custom content or functions can be injected, enabling extension integration without altering the core platform code. Fynd Commerce dynamically loads extension-provided content or functions into the appropriate slots as sellers interact with the platform, facilitating a highly customized UX.
When an extension is installed in the Fynd Commerce, its functions are registered to specific slots. Platform Slot Bindings ensure that the extension's content or function is displayed in the required location within the Fynd Commerce UI. For example, a developer can create a custom widget for blocked order updates, such as a sales summary or analytics chart, and bind it to a dashboard slot, offering additional insights to users.
Add Platform Slot Bindings
Prerequisite
- Ensure that you have created an extension before you start with Platform Bindings. Refer to Get Started for step-by-step guide.
Steps
Do the following steps to create a Platform Slot Bindings:
- Login to your Fynd Partner account.
- In the left pane, click Extensions and select the extension you want to configure.
- Go to Extension Setup and ensure the extension URL and permissions are correctly configured.
- In the Bindings section, click Manage.
- In the upper-right side of the window, click Add to create new Bindings.
- Select Platform Panel in Interface Area dropdown list.
- Select Page Slot from the Binding Type dropdown list.
- Enter a name for the Bindings.
- Specify the target URL where you have hosted this Bindings.
- Select the page in Allow Pages dropdown list where you need to show the Bindings.
- Click Add. You will see a success notification when the Bindings is successfully created.
Platform Specific Bindings
This feature enhance developers to integrate extension features directly into the resource pages (such as product, order, and customer pages) of the Fynd Commerce panel. It helps sellers access extension functions directly into the resource pages without navigating between the extension launch page and resource pages. The developers can configure these Bindings through Fynd Partners by selecting specific pages where the extension should be accessible. The configured Bindings will appear under the More Actions menu (⠸) on the selected Fynd Commerce page. The menu item will display the name specified during the Bindings setup.
Add Platform Specific Bindings
Prerequisite
- Ensure that you have created an extension before you start with Platform Bindings. Refer to Get Started for step-by-step guide.
Steps
Do the following steps to create a Platform Slot Bindings:
- Login to your Fynd Partners account.
- In the left pane, click Extensions and select the extension you want to configure.
- Go to Extension Setup and ensure the extension URL and permissions are correctly configured.
- In the Bindings section, click Manage.
- In the upper-right side of the window, click Add to create new Bindings.
- Select Platform Panel in Interface Area dropdown list.
- Select Page Specific from the Binding Type dropdown list.
- Enter a name for the Bindings.
- Specify the target URL where you have hosted the Bindings.
- Select the page in Allow Pages dropdown list where you need to show the Bindings.
- In User Interaction dropdown list, specify the format in which the user can interact with the screen.
The user can interact in two formats.
- Model: Opens as a side drawer on tablets or a bottom sheet on mobile.
- Fullpage: Opens as a dedicated full-screen page on both tablets and mobile.
- Click Add. You will see a success notification when the Bindings is successfully created.
Parameters
Fynd platform sends the following information as query parameters in the Install URL, which redirects to the Bindings target URL.
Default Parameters
| Query Parameter | Details |
|---|---|
pageUrl | URL of the page the binding is shown |
binding_slug | Slug of the binding |
Page-specific Parameters
| Page | Query Parameters | Location |
|---|---|---|
| Order Listing | - | Fynd Commerce > My Orders tab |
| Shipment Details | shipment_id | Fynd Commerce > My Orders tab > Go to an order |
| Product Listing | - | Fynd Commerce > Products tab |
| Product Create | - | Fynd Commerce > Products > Create Product page |
| Product Edit | product_id | Fynd Commerce > Products tab > Edit Product page |
| Customer Details | customer_id | Fynd Commerce > Sales channel > Customers > Customer Details page |
| Collection Create | collection_slug | Fynd Commerce > Sales channel > Marketing > Collections > Create Collection page |
| Collection Edit | - | Fynd Commerce > Sales channel > Marketing > Collections > Edit Collection page |
| Discount Listing | - | Fynd Commerce > Products > Discount |
| Discount Create | - | Fynd Commerce > Products > Discount > Create Discount page |
| Discount Edit | discount_id | Fynd Commerce > Products > Discount > Edit Discount page |