Get Top Counts

Returns a list of all top counts in an outlet.

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

Returns both open and closed top counts. Counts still open are listed first, then the most recently submitted ones.

To read the stock items counted in a top count, use Get Stock Items In A Top Count.

📘

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).

🚧

This endpoint moved

Top counts were previously listed at /inventory/outlets/{outlet_id}/count_events/aggregated/. That path still works but is no longer documented and will be retired — move existing integrations to /inventory/outlets/{outlet_id}/count_events/.

The response no longer embeds a counted_items array. Fetch the counted stock items per count from Get Stock Items In A Top Count instead.

Path Params
string
required

An outlet's ID

Query Params
int32

A page number within the paginated result set.

int32
≤ 100

The number of results per page. Defaults to 10, capped at 100.

string
enum

Filter on the count's status: 0 opened, 1 reopened, 2 closed.

Allowed:
date

Filter on a creation date (exact).

date

Filter on a creation date (greater than).

date

Filter on a creation date (lower than).

date

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

date

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

date

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

string

Query the contents of the remarks field.

string

A user ID.

string

A user's email address.

string

A user ID.

string

A user's email address.

float

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

float

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

float

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

Responses

403

User lacks permission to view counts in this outlet.

404

Outlet not found.

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