Get Recipes Revenue

get

https://api.apicbase.com/api/v2/sales/{outlet_id}/revenue/recipes/

Returns the total revenue from an outlet on a date or range of dates, discriminated by recipe.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The revenue reported in this endpoint comes from the sales of POS items.

Either the dates query parameter must be provided, or both the date_from and date_to parameters. The dates should be in the YYYY-MM-DD format.

The date range specified by the date_from and date_to parameters also includes both the start and end dates.

Path Params

outlet_id

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_from

date

A start date for the period being queried.

date_to

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

dimensions

array of strings

Optional field to add more granularity to the result. Options: date (if set, the result will have the date field, not only the recipe_id and the revenue).

dimensions

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

404404