-
Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData2.asmx
-
MPS Version: From 5.5.0
Description
This method returns a list of Customer Warehouses and Distribution Centers registered with the provider.
Syntax
public string GetDealerStocks(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 |
Property |
|
DealerName |
Text |
Yes |
- |
- |
- |
Provider name |
|
DealerUserEmail |
Text |
Yes |
- |
- |
- |
Provider user email |
|
DealerUserPassword |
Text |
Yes |
- |
- |
- |
Encrypted user password |
|
StockTypeID |
Number |
No |
- |
- |
- |
Type of stock you want to search for (1 - Distribution Center, 2 - Customer Stock). This only needs to be specified if you want to filter by stock type |
|
StockName |
Text |
No |
- |
- |
- |
Stock name. This only needs to be specified if you want to filter by stock name |
|
FieldsList |
Text |
No |
Yes |
Yes |
- |
List of fields that will be returned by the method. They must be specified by separating them with a semicolon (;). Example: PrinterDeviceID;SiteID;SiteName. When 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 |
|
StockID |
Stock ID in the system |
|
StockName |
Stock name |
|
StockTypeID |
Stock type ID (1 - Distribution center, 2 - Customer stock) |
|
Description |
Stock description |
|
ContactName |
Name of the contact associated with the stock |
|
ContactEmail |
Email address of the contact associated with the stock |
|
ContactPhone |
Phone number of the contact associated with the stock |
|
EnterpriseName |
Name of the company associated with the stock. This field will be blank if a customer's stock is not associated with any company or if 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 details |
|
ProgDays |
Period in days until the next forecast is due |
|
SecurityOnly |
Indicates whether the inventory forecast applies only to safety stock items |
|
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 |
Returns
Click here to learn more about the return format.
Possible error messages
Click here to view the possible errors that may be returned and learn the reasons behind them.
Restrictions
-
To execute this method, the specified user must have full permissions in Inventory Administration.