Get inventory levels
lightspeedxseries_get_inventory_levelsStock on hand per product per outlet: product_id, location_id (= outlet id), current_inventory_level, reorder threshold/amount, quantity_to_procure, average cost, total cost, supplier. Filter by outlet_ids, product_ids (or root_product_ids for variant families), supplier_ids; to_be_procured_only keeps products with a positive quantity_to_procure (the vendor's re-order suggestion, which accounts for open orders); for a plain below-reorder-point list, compare current_inventory_level with reorder_threshold yourself. Offset paging: pass next_offset to continue (null = last page). Read-only even though the vendor takes the filter as a POST body. POST /inventory_levels.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| size | No | Records per page (default 100, max 500 here). | |
| offset | No | Offset for the next page: pass next_offset from the previous call (default 0). | |
| sort_type | No | ||
| outlet_ids | No | Only these outlets (the vendor calls them location_ids). | |
| product_ids | No | Only these products. Not together with root_product_ids. | |
| supplier_ids | No | ||
| group_variants | No | Aggregate variant families when filtering by root_product_ids. | |
| sort_direction | No | ||
| include_inactive | No | true = include inactive products. | |
| root_product_ids | No | Only these variant families (use with group_variants). Not together with product_ids. | |
| include_composites | No | ||
| to_be_procured_only | No | true = only products with a positive quantity_to_procure (not the same as below the reorder point). |