Skip to main content

StoreOS Bindings

The StoreOS binding feature allows developers to integrate their extension functions directly into StoreOS through an embedded web view. With these customizations, merchants can tailor the UI to meet their specific needs for functions beyond the core capabilities of the StoreOS application. Bindings is essential for making extensions accessible within the StoreOS UI. It configures how and where an extension will appear.

This document provides step-by-step instructions for creating, bindings, and testing an extension on the StoreOS Application. It is intended to guide developers through setup, customization, event handling, testing, ensuring compatibility and seamless integration within the StoreOS ecosystem.

Prerequisites

  • Ensure that you have created an extension before you start StoreOS bindings. Refer to Get Started for step-by-step guide.

Types of Bindings

  1. Connected App
  2. Page Specific

Connected App Bindings

Accessed via a dedicated navigation tab and occupies the entire screen.

Creation of Connected App Bindings

  1. Go to the Fynd Partner panel.
  2. In the left pane, click Extensions and open the extension.
  3. Go to the Extension Setup and ensure the extension URL and permissions are correct.
  4. In the Bindings section, click Manage.
  5. In the upper-right side of the window, click Add to create new bindings.
  6. Select Store OS in Interface Area dropdown list.
  7. Select Connected App from the Binding Type dropdown list.
  8. Enter a name for the bindings and specify the target URL where the bindings is hosted.
  9. Click Add.

Page Specific Bindings

Page Specific bindings can be accessed from the contextual menus, such as "More Actions" or dropdowns in StoreOS.

Creation of Page Specific Bindings

  1. Go to the Fynd Partner panel.
  2. In the left pane, click Extensions and open the extension.
  3. Go to the Extension Setup and ensure the extension URL and permissions are correct.
  4. In the Bindings section, click Manage.
  5. In the upper-right side of the window, click Add to create new bindings.
  6. Select Store OS in Interface Area dropdown list.
  7. Select Page Specific from the Binding Type dropdown list.
  8. Enter a name for the bindings.
  9. Specify the target URL where bindings is hosted.
  10. In Allowed Pages dropdown list, select pages where the extension will be displayed as an entry point.
  11. 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.
  12. Click Add.

Was this section helpful?