-
Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData2.asmx
-
MPS Version: From 5.5.0
Description
This method returns the quantity of items available in stock. For Distribution Centers, these are items that have already been received and are not committed (Available); and for Customer Inventories, these are items that have already been received, even if they are committed (Safety and Replenishment).
Syntax
public string GetTotalStockItemsAvailable(string properties)
Setting Properties
The content of string properties must be text in JSON format containing the properties listed below. For example:
{"DealerName":"dealer","DealerUserEmail":"user@example.com","DealerUserPassword":"k1BAv1w=="}
You don't need to worry about whether property names are uppercase or lowercase; the Web Service is Case-Insensitive.
Properties accepted by the method
|
Property |
Type |
Required |
Allows null |
Allows empty |
Maximum size |
Description |
|
DealerName |
Text |
Yes |
- |
- |
- |
Provider name |
|
DealerUserEmail |
Text |
Yes |
- |
- |
- |
Provider user email |
|
DealerUserPassword |
Text |
Yes |
- |
- |
- |
Encrypted user password |
|
StockID |
Number |
Yes |
- |
- |
- |
Stock identification number in the system. Retrieved using the GetDealerStocks method |
|
FieldsList |
Text |
No |
- |
- |
- |
List of fields to be returned by the method. They must be specified separated by a semicolon (;). Example: PrinterDeviceID;SiteID;SiteName. If no fields are specified, the response will contain the fields shown in bold in the table below |
Return fields recognized in FieldsList
|
Field name |
Description |
|
SupplyModelID |
Supply model (material) identifier in the system |
|
SupplyModelFullName |
Full name of the supply model (material) based on the nomenclature defined by the provider |
|
BrandName |
Material manufacturer name |
|
SupplySubFunctionType |
Material type name |
|
SupplyColor |
Material color |
|
PartNumber |
Material PartNumber |
|
Capacity |
Material capacity |
|
Description |
Material description provided by the provider |
|
InternalCode |
Internal material code provided by the provider |
|
SupplyModelQuality |
Material quality |
|
Available |
Quantity of items available in stock |
Click here to learn more about the error formats.
Possible errors returned
Click here to see the possible errors that may be returned and learn the reasons behind them.
Restrictions
-
To execute this method, the specified user must have Basic, Limited, or Full access to the stock in question.