Returns a list of sales performance figures per outlet.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Requires the Sales module or the Inventory module, and Insights Hub access for the user.
Period boundaries
net_sales and theoretical_cost are 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. A day on which the outlet closed a full count goes wholly to one period, and count_moment decides which:
after_closing(default): the count is taken after the day's last sale. The start day is left out entirely if the outlet closed a full count on it, as it belongs to the previous period. The end day is always included.before_opening: the count is taken before the day's first sale. The start day is always included. The end day is left out entirely if the outlet closed a full count on it, as it belongs to the next period.
actual_cost adds waste and negative variance, which follow the inventory boundaries.
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 with after_closing, 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. With before_opening, for an outlet that counted at 08:00 on the end date, the inventory figures stop at 08:00, while net_sales leaves out the entire end day.
A filter is missing or malformed.
The library has neither the Sales nor the Inventory module, or the user lacks Insights Hub access.