Get Sales Performance

Returns a list of sales performance figures per outlet.

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

Requires the Sales module or the Inventory module, and Insights Hub access for the user.

Period boundaries

net_sales is counted in whole days: start_datetime and end_datetime are truncated to dates, rather than used as the boundary timestamps that drive the inventory figures.

  • The start day is left out entirely if the outlet closed a full count on it. The count is treated as end-of-day, so the day belongs to the previous period.
  • The end day is always included in full, whether or not a full count closed that day.

Calendar days are resolved in the library's timezone, not UTC. The offset you send on start_datetime does not change which day a moment falls on.

So for an outlet that counted at 14:00 on the start date, the inventory figures leave out only the movements booked before 14:00, while net_sales leaves out the entire day.

Query Params
date-time
required

Start of the reporting period, in ISO 8601 format.

date-time
required

End of the reporting period, in ISO 8601 format. Must not be earlier than start_datetime.

string

Comma-separated outlet IDs to report on. Omit to report on every outlet in the library. IDs that do not exist, or that belong to another library, match nothing rather than returning an error.

string

An outlet name to query on. Matches outlets whose name contains this value.

string

Filter on outlet custom fields. Check reference guide for details.

int32

A page number within the paginated result set.

int32
≤ 200

Number of outlets to return per page. Maximum 200.

Responses

400

A filter is missing or malformed.

403

The library has neither the Sales nor the Inventory module, or the user lacks Insights Hub access.

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