-
Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData.asmx
-
MPS Version: From 5.3.0
Description
This method returns the list of Customer Stocks and Distribution Centers registered with the provider.
Syntax
public string GetDealerStocks(string dealerName, string dealerUserEmail, string dealerUserPassword, string fieldsList)
Parameters
-
dealerName: Name of the provider;
-
dealerUserEmail: Email address of the provider user;
-
dealerUserPassword: Encrypted user password;
-
fieldsList: List of fields that will be returned by the method. They must be specified separated by the character ‘;’. Example: PrinterDeviceID;SiteID;SiteName.
-
When no fields are specified, the response will contain the fields that are in bold in the table below.
-
Recognized return fields in fieldsList
|
Field name |
Description |
|
StockID |
Stock identifier in the system |
|
StockName |
Stock name |
|
StockTypeID |
Stock type identifier (1 - Distribution center, 2 - Customer stock) |
|
Description |
Stock description |
|
ContactName |
Name of the contact registered in the stock |
|
ContactEmail |
Email of the contact registered in the stock |
|
ContactPhone |
Phone number of the contact registered in the stock |
|
EnterpriseName |
Name of the company served by the stock. It will be empty when a Customer Stock does not serve anyone or when it is a Distribution Center |
|
AddressCountry |
Country where the stock is located |
|
AddressState |
State where the stock is located |
|
AddressCity |
City where the stock is located |
|
AddressStreet |
Street where the stock is located |
|
AddressNeighborhood |
Neighborhood where the stock is located |
|
AddressPostalCode |
ZIP code where the stock is located |
|
AddressNumber |
Stock location number |
|
AddressAdditionalInfo |
Stock address supplement |
|
ProgDays |
Period in days when the next forecast should be performed |
|
SecurityOnly |
Indicates whether the stock forecast is for safety items only |
|
CustomField1InUse |
Indicates whether the first additional field is in use (False - Not used, True - In use) |
|
CustomField1Name |
Name of the first additional field |
|
CustomField1Value |
Value of the first additional field |
|
CustomField2InUse |
Indicates whether the second additional field is in use (False - Not used, True - In use) |
|
CustomField2Name |
Name of the second additional field |
|
CustomField2Value |
Value of the second additional field |
|
CustomField3InUse |
Indicates whether the third additional field is in use (False - Not used, True - In use) |
|
CustomField3Name |
Name of the third additional field |
|
CustomField3Value |
Value of the third additional field |
Click here to learn more about the format of the returns.
Possible errors returned
Click here to check the possible errors that may be returned and learn about their reasons.
Restrictions
-
To execute this method, the user must have full permission in Stock Administration.