Food Service APIs

You can find below the APIs, the exposed functionality by the food service.

getBrands

The getBrands method makes a search for the available food brands. The method returns the list of available Brand.

If no brands are available, then it returns an empty list.

Kotlin

suspend fun getBrands(): CommerceResponse<List<Brand>>

getFoodStores

The getFoodStores method makes a search based on the given location and brand and returns a list of FoodStore. Maximum 9 results are retrieved.

The location parameter represents the location for which the search is done.

The brandId parameter represents the id of the Brand for which the search should be done.

It returns the list of the available FoodStore. If there are no available food stores, then it returns an empty list.

Kotlin

suspend fun getFoodStores(
        location: GeoLocation,
        brandId: String
    ): CommerceResponse<List<FoodStore>>

getFoodStoresAlongRoute

The getFoodStoresAlongRoute method returns a list of available food stores around the given location, along the provided route, and for the given brand. The results have the first one set as the default store.

The location parameter represents the coordinates around which the search should be done.

The brandId parameter represents the id of the Brand for which the search should be done.

The routePoints parameter represents the list of route GeoLocation objects representing the route points.

It returns the list of the available FoodStore. If there are no available food stores, then it returns an empty list.

Kotlin

suspend fun getFoodStoresAlongRoute(
        location: GeoLocation,
        brandId: String,
        merchantKey: String,
        routePoints: List<GeoLocation>
    ): CommerceResponse<List<FoodStore>>

getHistory

The getHistory method retrieves user's food orders.

The onlyActive parameter sets if request should return only active orders.

It returns a list of FoodOrderInformation representing the orders placed by a user.

Kotlin

suspend fun getHistory(onlyActive: Boolean): CommerceResponse<List<FoodOrderInformation>>