Get Item Sales Data

Returns product sales data at a specific outlet.

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

This is a detailed endpoint that provides sales data complete with cost and profit information, as well as selected attributes of the recipe linked to the sold POS item.

Some data can be freely modified even after the sales have been processed. It's the case of the linked recipe, which can change at any moment if the user decouples the POS item and links it to a different recipe.

This action can in less common circumstances also change the food cost and profit values of historical data. Use the updated_at filters to track these changes.

📘

Curious about how Apicbase calculates food cost?

This is one of the most powerful features offered by Apicbase. We do our best to calculate the impact of product sales on the inventory's total value with the information available to us at the time of processing.

If it's not possible to calculate it this way (because maybe, for example, the raw items that make up the product that was sold were not found in inventory) we will still populate the food_cost returned on this endpoint based on the historical cost price of the linked recipe. Read more about how we calculate this on our knowledge base.

Each "line" retrieved from this endpoint represents a consolidation of ticket lines. While they don't correspond to individual ticket lines, they also don't aggregate sales over specific time periods. This aggregation depends on the frequency of the automated sales processing routine. In other words, it's important not to assume that a single ticket line will entirely cover all sales of a particular product on a given day.

Path Params
string
required

An outlet's ID.

Query Params
date

Filter on the data entry's modification date (greater than).

date

Filter on the data entry's modification date (lower than).

date

Filter on a sale date (exact).

date

Filter on a sale date (greater than).

date

Filter on a sale date (lower than).

float

Filter on a revenue value (greater than).

float

Filter on a revenue value (lower than).

string

Filter on the name of the category of the sold item.

string

Filter on the PLU code of the sold item.

string

Filter on the POS ID of the sold item.

string

Filter on the accounting category of the recipe linked to the sold item.

string

Filter on the category of the recipe linked to the sold item.

string

Filter on the ID of the recipe linked to the sold item.

Response

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