Your unique dashboard id provided to you by WristCoin
No query parameters are required, however pagination, sorting, and filtering is supported in this endpoint using the parameters below
| Key | Description of Value | Examples |
|---|---|---|
sort |
The priority and order of the sorting | `server_timestamp:desc |
| amount:desc` | ||
limit |
The maximum number of records you want returned. |
Note: A sort parameter is required if specifying a limit | 30 |
| server_timestamp | Filtering by time/date | **server_timestamp:** gte:1704117600 |
| inventory_item_id | Applies filtering by inventory item identifier to get inventory transactions only for that inventory item. | 19f3dc1a-d414-11ee-a835-fb187b02f640 |
| type | The type of inventory transaction filter to apply.
See below for allowed values. | depletion |
<aside> 💡 To include both a greater than or equal to, and a less than or equal to filter, use the same key twice in the query parameters. For example to query a time/date range of sales transactions:
/inventory-transaction-summaries?server_timestamp=gte:1704117600&server_timestamp=lte:1710622800
</aside>
The following values are supported for specifying type of inventory transaction:
Value for type |
Comment |
|---|---|
depletion |
Depletions are when inventory stock is reduced when a menu item that contains this inventory item in its recipe is purchased. |
restock |
Increases of inventory levels from restocking |
adjust-inc |
Increase of inventory level from an adjustment |
adjust-dec |
Decrease of inventory level from an adjustment |
transfer |
Transfer of inventory from one store/warehouse to another |
None
| Response Body | |
|---|---|
| 200 | An inventory transaction report |
| 401/403 | `"error_code": 0, |
"error_message": "A valid authorization was not present",
"http_status": 403` |