Get Top Counts

get

https://api.apicbase.com/api/v2/inventory/outlets/{outlet_id}/count_events/aggregated/

Returns a list of all top counts in an outlet.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Returns both open and closed top counts.

📘
The stock_value attribute
stock_value represents the inventory's total variation in value after this event was submitted. This field is only populated in closed counts. It can also be a negative number (the amount counted was lower than what was assumed to be in inventory).

Path Params

outlet_id

string

required

An outlet's ID

Query Params

page

int32

A page number within the paginated result set.

ordering

string

A field to order results by.

status

string

enum

Allowed:

created_date

date

Filter on a creation date (exact).

created_date__gt

date

Filter on a creation date (greater than).

created_date__lt

date

Filter on a creation date (lower than).

actual_date

date

Filter on the event's actual date, as specified by the user.

actual_date__gt

date

Filter on the event's actual date, as specified by the user (greater than).

actual_date__lt

date

Filter on the event's actual date, as specified by the user (lower than).

remarks

string

Query the contents of the remarks field.

created_by

string

A user ID.

created_by__email

string

A user's email address.

owned_by

string

A user ID.

owned_by__email

string

A user's email address.

stock_value

float

The event's total stock value in variation (exact).

stock_value__gt

float

The event's total stock value in variation (greater than).

stock_value__lt

float

The event's total stock value in variation (lower than).

Response

Language

Credentials

OAuth2

Loading…

Response

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

application/json

The stock_value attribute

200200