Get feed
Description#
Allows the client to peruse all the available businesses that are available in the system and potentially/hopefully purchase from them.
Inputs#
Locale#
Limit#
- Type
- Number
- Validation
- Minimum
- 3
- Minimum
region entity Region #
Location#
- Type
- Coordinates
Additional validation#
- Either a Function inputregion or a Function inputlocation must be provided.
Mechanism#
- If Function inputlocation is provided, use it to determine if the client is within the Entity propertyboundaries of any region entity region . Otherwise, use the provided Function inputregion.
- Apply the default pagination fields inputs and mechanism on each and every feed subset or with the optionally provided Function inputlimit and filter by the Function inputregion.
- Businesses that are not available are moved to bottom of the lists.
- Fetch all business category entity business categories for the purposes of filtration.
Feed subsets#
Clients are allowed to peruse a full list of each of the following feed subsets.
info
- By default, if a specific subset is requested, then the Pagination inputs are applied to the request.
- Businesses that are not available are still moved to bottom of the lists.
- The first step of the feed mechanism applies to all subsets.
Recommended restaurants#
Details#
Returns restaurants that are recommended by the system.
Mechanism#
- Select only business entitybusinesses of type Valuerestaurant.
- Sort the restaurants by taking into considerations the amount of reviews and the average score.
Sort order#
Most recommended to least recommended.
Restaurants nearby#
Details#
Returns restaurants that are near the client.
Mechanism#
- Select only business entitybusinesses of type Valuerestaurant.
- Sort the restaurants by how close to the client they are.
Sort order#
Nearest to farthest.
New restaurants#
Details#
Returns a list of the newest restaurants in the system.
Mechanism#
- Select only business entitybusinesses of type Valuerestaurant that were created up to two weeks ago.
- Sort the restaurants by creation date.
Sort order#
Newest to oldest.
Notes#
warning
- This list could be empty.
Recently ordered from#
Details#
Returns businesses that the client ordered from recently.
Mechanism#
- Select only business entitybusinesses that the client ordered from in the past month.
- Sort the restaurants by the order date.
Sort order#
Most recent to least recent.
Notes#
warning
- This list could be empty.
Favorites businesses#
Details#
Returns businesses that are in the client's favorites list.
Mechanism#
- Select only business entitybusinesses that the client added to their favorites list.
Sort order#
Insignificant.
Notes#
warning
- This list could be empty.
Currently popular#
Details#
Returns business that the clients are currently ordering from the most.
Mechanism#
- Select all business entitybusinesses that the clients have ordered from today.
- Sort by the most amount of orders.
Sort order#
Most amount of orders to least.
Notes#
warning
- This list could be empty.
Pika+ (Retailers)#
Details#
Returns a list of retailers.
Mechanism#
- Select only business entitybusinesses of type Valueretail.
- Sort the retailers by how close to the client they are.
Sort order#
Nearest to farthest.
Output#
An object containing:
- An array containing all the business category entity business categories along with a field which contains a count of all business entity businesses that belong to the category.
- Arrays of each section containing the relevant businesses.
- region entity Region (Only if Function inputLocation was provided as an input)
If the request is for a feed subset:
- An array containing the relevant businesses.
Notes#
warning
- If a location is provided that is not within any of the regions, an error will be returned.
info
- Requesting a feed is faster with a region instead of a location in terms of query performance and should be leveraged.