Get Item Sales Data

get

https://api.apicbase.com/api/v2/analytics/outlets/{outlet_id}/sales/

Returns product sales data at a specific outlet.

Path Params

outlet_id

string

required

An outlet's ID.

Query Params

updated_at__gt

date

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

updated_at__lt

date

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

sale_date

date

Filter on a sale date (exact).

sale_date__gt

date

Filter on a sale date (greater than).

sale_date__lt

date

Filter on a sale date (lower than).

revenue__gt

float

Filter on a revenue value (greater than).

revenue__lt

float

Filter on a revenue value (lower than).

pos_item__category_name

string

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

pos_item__plu

string

Filter on the PLU code of the sold item.

pos_item__pos_id

string

Filter on the POS ID of the sold item.

recipe__accounting_category

string

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

recipe__category

string

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

recipe__id

string

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

Response

Language

Credentials

OAuth2

Response

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

application/json

200200