Retrieve a list of reserved product quantities (ie. all products that have been reserved with a Sales Order, Prepayment Invoice, or a Sales Quote).
If you subtract the "reserved" quantity from your total inventory, you'll get the "available" quantity — the amount that can be sold while still leaving enough inventory for fulfilling Sales Orders.
API call getProductStock can also list the total inventory, and many other things, besides reserved amounts; getReservedStock is an optimized API call for retrieving just one piece of information.
If you need to get reserved stock across all locations then use API call syncTotalProductStock
| Parameter name | Description | Possible value | Required |
|---|---|---|---|
| warehouseID | integer | yes | |
| productID | Retrieve one specific product. | integer | |
| productIDs | Retrieve specific products. Multiple product IDs, separated by commas, such as: 1,2,3,4,5 | string | |
| groupID | Retrieve products in this specific product group. (See getProductGroups.) | integer | |
| groupIDWithSubgroups | Retrieve products in this product group, or in any of its sub-groups, sub-subgroups etc. | integer | |
| supplierID | Retrieve products of this supplier. (See getSuppliers.) | integer | |
| brandID | Retrieve products of this brand. (See getBrands.) | integer | |
| priorityGroupID | Retrieve products in this priority group. (See getProductPriorityGroups.) | integer | |
| categoryID | Retrieve products in this specific category. (See getProductCategories.) | integer | |
| categoryIDWithSubcategories | Retrieve products in this category, or in any of its sub-categories, sub-sub-categories etc. | integer | |
| parentProductID | Retrieve variations of this matrix product. | integer | |
| status | Filter products by status: ACTIVE, NO_LONGER_ORDERED, NOT_FOR_SALE, ACTIVE_AND_NOT_FOR_SALE, ARCHIVED, or ALL_EXCEPT_ARCHIVED. The last one returns all non-archived items (ie. items that are active, not for sale or no longer ordered). IF you are building a Stock Replenishment Report, ACTIVE_AND_NOT_FOR_SALE is the recommended option. It returns all orderable items, skipping archived products and those marked as "not ordered any more". |
string |
| Field name | Type | Description |
|---|---|---|
| productID | integer | Product ID. |
| amountReserved | number | Reserved amount. |