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 to configure it.
- In the left sidebar, click Bindings and then click Add to create Bindings.
- Select Platform Panel in Interface Area dropdown list.
- Select Page Slot in 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 to configure it.
- In the left sidebar, click Bindings and then click Add to create Bindings.
- Select Platform Panel in Interface Area dropdown list.
- Select Page Specific in 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: An interactive pop-up appears on the window, which is powered by the extension.
- Fullpage: A full-page iframe opens on the window, which is powered by the extension.
- Click Add. You will see a success notification when the Bindings is successfully created.
Parameters
The Fynd Commerce includes the following details as query parameters in the launch URL to launch the extension in the slot, which is then redirected to the Binding target URL given at the time of creating the binding in the Fynd Partner panel.
Launch URL sends these parameters:
| Query Parameter | Details |
|---|---|
company_id | Company ID |
cluster_url | Fynd API base URL |
client_id | Extension ID |
redirect_path | Binding target URL |
Fynd Commerce appends the following query parameters to the Redirect URL when launching the extension:
| Query Parameter | Details |
|---|---|
company_id | Company ID |
application_id | Application ID |
binding_slug | Executed binding slug |
pageUrl | URL of the page where the binding is shown |
See the tables below for the list of page-specific parameters that can be sent in the Redirect URL.
Page-specific Parameters
For page-specific bindings, the query parameters are sent in the URL which depend on the resource page.
For example, on Create Discount page, no additional query parameters (such as discount_id) will be sent. On the other hand, on Edit Product page, a query parameter product_id is included.
Company-level Parameters
| Page | Query Parameters | Path |
|---|---|---|
| Discount Create | - | Fynd Commerce > Products > Discount > Create Discount page |
| Discount Edit | discount_id | Fynd Commerce > Products > Discount > Edit Discount page |
| Discount Listing | - | Fynd Commerce > Products > Discount |
| Order Listing | - | Fynd Commerce > My Orders |
| Product Create | - | Fynd Commerce > Products > Create Product page |
| Product Edit | product_id | Fynd Commerce > Products > Edit Product page |
| Product Listing | - | Fynd Commerce > Products |
| Shipment Details | shipment_id | Fynd Commerce > My Orders > Go to an order |
| Size Guide | size_guide_id | Fynd Commerce > Products > Size Guide page |
Application-level Parameters
| Page | Query Parameters | Path |
|---|---|---|
| Attribute Group | - | Fynd Commerce > Sales channel > Search > Attribute page |
| Authentication | - | Fynd Commerce > Sales channel > Customers > Authentication page |
| Collection Create | - | Fynd Commerce > Sales channel > Marketing > Collections > Create Collection page |
| Collection Edit | collection_slug | Fynd Commerce > Sales channel > Marketing > Collections > Edit Collection page |
| Coupon | coupon_id | Fynd Commerce > Sales channel > Marketing > Coupons page |
| Customer Details | customer_id | Fynd Commerce > Sales channel > Customers > Customer Details page |
| Detail - General | - | Fynd Commerce > Sales channel > Configuration > General page |
| FAQ | - | Fynd Commerce > Sales channel > Content > FAQ page |
| FAQ Category | group_slug group_id | Fynd Commerce > Sales channel > Content > FAQ > FAQ Group Edit page |
| Legal | config_type type | Fynd Commerce > Sales channel > Configuration > Legal Document page |
| Navigation | navigation_slug | Fynd Commerce > Sales channel > Theme > Navigation page |
| Product Configuration Filter | config_type type | Fynd Commerce > Sales channel > Search > Filter page |
| Product Configuration Sort | config_type type | Fynd Commerce > Sales channel > Search > Sort page |
| Product Configuration Category | config_type type | Fynd Commerce > Sales channel > Products > Category page |
| Product Configuration Variant | config_type type | Fynd Commerce > Sales channel > Products > Variant page |
| Promotion | promotion_id | Fynd Commerce > Sales channel > Marketing > Promotions page |
| SEO | - | Fynd Commerce > Sales channel > Content > SEO page |
| Theme | - | Fynd Commerce > Sales channel > Theme > Store Design page |