Skip to main content

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 merchant locations:

Merchant Authorization with POS

The merchant will sign into Stream via login via email or POS OAuth.

POS oAuth Sign-In

For successful POS OAuth sign-in, ensure the sso_details property is included in the POST Token Response.

With this property in place, you can seamlessly start the connection process by directing users straight to the Redirect URL along with their authorization code.

If you omit the phone_number or full_name properties, the user will see an onboarding page on first sign-in to capture this information.

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.

Catalog Retrieval

Upon user submission of the selected locations, we begin to ingest the catalog using the Get Catalog endpoint. Once ingested they are landed on the home page with all POS items visible and ready for arrangement using our Smart Menu technology.