Please note that virtual brands functionality is currently in pilot, and as such this document and endpoints may be updated at any time. If you're looking to support virtual brands, please get in contact with your technical account manager to scope the required changes. 

Introduction
New API Endpoints
   Locations
      GET /locations/{hashedLocationId}/brands
      GET /locations/{hashedLocationId}/brands/{hashedBrandId}
   Brands
Updated API Endpoints
   Onboarding / Subscribing Brands
      POST /locations/{hashedLocationId}/subscription
      DELETE /locations/{hashedLocationId}/subscription
   Ordering
      GET /orders
      POST /orders
   Menus
      GET /locations/{hashedLocationId}/menu
      GET /locations/{hashedLocationId}/menu/products/{posId}
      GET /locations/{hashedLocationId}/menu/options/{posId}
      GET /locations/{hashedLocationId}/menu/surcounts/{posId}

Introduction

Doshii virtual brands allows for multiple menus per Doshii location. This can be utilised for several use cases such as dark kitchens/virtual brands, stores within a venue that have different menus (ie bistro and sports bar) and even for venues that have different menus for dine-in vs takeaway. 

The introduction of Doshii virtual brands involves the creation of new endpoints as well as uplifting existing endpoints. These changes are documented here.

New API Endpoints

Locations

GET /locations/{hashedLocationId}/brands

Purpose: Retrieve all Location Brand subscriptions associated with the App/Partner

URL: Doshii API

GET /locations/{hashedLocationId}/brands/{hashedBrandId}

Purpose: Retrieve a single location brand subscription by its hashed ID

URL: Doshii API

Brands

Similar Endpoints as found in Locations.

Updated API Endpoints

Onboarding / Subscribing Brands

POST /locations/{hashedLocationId}/subscription

Purpose: Subscribe to a Location or a brand to obtain access to the location's events and data

URL: Doshii API

DELETE /locations/{hashedLocationId}/subscription

Purpose: Subscribe to a Location or brand to stop receiving events from that location or brand

URL: Doshii API

Ordering

GET /orders

Purpose: Retrieve a list of all Orders at a Location. If the Order is related to a brand, it will have a brand object with a name and id property.

URL: Doshii API

POST /orders

Purpose: Create a new Order at a Location or Brand. If the Order is related to a brand, you pass the brand id through to doshii-brand-id header.

URL: Doshii API

Menus

GET /locations/{hashedLocationId}/menu

Purpose: Retrieve a Menu for a Location by its hashed ID. If you submit a menuId as part of a query string, you can fetch the app submenu in place of the default menu. Usually used for retrieving Menus for Virtual Brand.

URL: Doshii API

GET /locations/{hashedLocationId}/menu/products/{posId}

Purpose: Retrieve a menu product for the given location and posId. Supplying a menuId as part of the query string, you can fetch the product for the app submenu when not fetching from the default app menu.

URL: Doshii API

GET /locations/{hashedLocationId}/menu/options/{posId}

Purpose: Retrieve a menu option for the given location and posId. Supplying a menuId as part of the query string, you can fetch the options for the app submenu when not fetching from the default app menu.

URL: Doshii API

GET /locations/{hashedLocationId}/menu/surcounts/{posId}

Purpose: Retrieve a menu surcount for the given location and posId. Supplying a menuId as part of the query string, you can fetch the options for the app submenu when not fetching from the default app menu.

URL: Doshii API