getAmountsOnOrder

Get product quantities on Purchase Orders that have not been fulfilled yet.

Input parameters

Parameter name Description Possible value Required
warehouseID Integer yes
productID Retrieve one specific product. Integer
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
getProductsWithReorderPointDefined If set to 1, API returns only products with Reorder Point defined. Integer
getProductsWithRestockLevelDefined If set to 1, API returns only products with Restock Level defined. Integer
getOnlyConfirmedPurchaseOrders Integer

Response

Field name Type Description
productID Integer Product ID.
amount Decimal

This API call may return a lot of data (tens of thousands of records) and the output is non-pageable. If you have a large database, API may be unable to serve the request — you will get an error code or empty output. However, there is an alternative way: you may request output in CSV format.

To retrive output as CSV, specify responseType = "CSV". API will respond you in JSON, providing a link to a CSV file::

{
"status":
{
"request":"getAmountsOnOrder",
"requestUnixTime":1371221184,
"responseStatus":"ok",
"errorCode":0,
"generationTime":0.10201191902161,
"recordsTotal":1,
"recordsInResponse":1
},
"records":
[
{"reportLink":"http:\/\/sample.erply.com\/link\/to\/file.csv"}
]
}


The CSV file is in "latin1" encoding. Field separator is comma. All fields, including decimal fields, are quoted.