Merchant Onboarding
As part of integrating with Stream, you will need to have a fully automated onboarding process. This will allow merchants to connect directly to your platfrom from Stream without any manual process blockades.
Here are the steps Stream will take to onboard new locations:
Merchant Authorization with POS
The merchant will sign in to your platform via the OAuth connection.
Example Auth Screen (to be shown once logged in to your platform)
Location Selection
We will fetch all locations from your platform via the Get Locations endpoint. We will display the locations for the merchant to select the ones that should be connected.
Location Connection
Upon menu ingest, we will follow the below procedure to connect the location:
- We check the location's connection status via the Get Location Connection endpoint.
- If
connectedstate isfalse, we will attempt to connect the location via the Connect Locations endpoint.
Location Disconnection
If a merchant decides to disconnect a location from Stream, we will notify you via the Disconnect Location endpoint.