Skip to main content

Location Management

After a merchant connects one of your locations to Stream, they will have the ability to manage the location from the Stream Website. This includes:

Pausing Locations​

Pauses by Merchant​

The merchant will be able to pause locations via the Stream Website. We will notify you of these changes via the New Webhook Event endpoint with an event type of location.pause.

The DSP platform should respect this as a full closure of the store's ordering. When supported, the platform should show customers when the pause will end so they can revisit for ordering.

When receiving a location.pause event with the property until_ms, the DSP platform should automatically reopen the store at the specified time. In this case, you will not receive a location.resume event.

Pauses by DSP​

As a DSP, you may pause or deactivate a merchant's integration from your side. This can be useful when the store is experiencing a high cancellation rate, may be closed, etc.

To pause a location, you can send to the DSP –> Stream via Webhook endpoint, with a paused status. Once the issue is resolved, you can resume the location via the Resumption by DSP method below.

Resuming Locations​

Resuming a location can occur in two ways:

1 - Automatically​

If a location.pause event included an until_ms property, the location should automatically resume at the specified time without any additional event.

2 - Manually​

Resumption by Merchant​

For indefinitely paused locations, the merchant can manually resume the location via the Stream Website. In this case, we will notify you via the New Webhook Event endpoint with an event type of location.resume.

When a location is indefinitely paused, you should wait for the location.resume event before reopening the store for orders.

Resumption by DSP​

If you paused the store by the Pauses by DSP method above, you can resume the store manually once any issue is resolved. This is done similarly by the DSP –> Stream via Webhook endpoint, with a online status.

Publishing Menus​

Location connection will occur once the menu is published for the first time, this is to prevent us from connecting to the location while it's using non-integrated menu data.

Handling menus published from Stream to your platform is covered in this document.