Get Revenue

Returns the total revenue from an outlet on a date or range of dates.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

An outlet's ID.

Query Params
dates
array of dates

A list of dates to get revenue for. If given, date_from and date_to should be omitted.

dates
date

A start date for the period being queried.

date

An end date for the period being queried.

recipes_to_include
array of strings

A list of recipe IDs to include in revenue calculation. If given, only revenue from sales of these recipes will be considered.

recipes_to_include
recipes_to_exclude
array of strings

A list of recipe IDs to exclude from revenue calculation. If given, revenue from sales of these recipes will NOT be considered.

recipes_to_exclude
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json