getWarehouses

Returns a list of warehouses, or locations, or stores.

API call getAllowedWarehouses returns the list of those warehouses that your user has access to.

To populate the drop-down list of "home stores" or "sign-up stores" on customer form, see the API call getHomeStores instead.

Input parameters

Parameter name Description Possible value Required
warehouseID  Retrieve one specific warehouse.  Integer    
userID        
lang  Retrieve item names in a specific language. If omitted, API will return item names in the default language of your ERPLY account.
Possible values:
  • 'eng' - English
  • 'spa' - Spanish
  • 'ger' - German
  • 'swe' - Swedish
  • 'fin' - Finnish
  • 'rus' - Russian
  • 'est' - Estonian
  • 'lat' - Latvian
  • 'lit' - Lithuanian
  • 'gre' - Greek
 
String    
code  Search by exact warehouse code.  String    
storeRegionID 

Retrieve warehouses in one specific store region.

This filter available only if "Store regions" module has been enabled on your account.

To get a list of store regions, see getStoreRegions.

 
Integer    
assortmentID 

Retrieve warehouses associated with one specific assortment.

This filter available only if "Assortments" module has been enabled on your account.

To get a list of assortments, see getAssignments.

 
Integer    
searchAttributeName  Search from attribute name. searchAttributeName and searchAttributeValue have to be specified both  String    
searchAttributeValue  Search from attribute value  String    

Response

Field name Type Description
warehouseID  Integer    
name  String (255)  Store / location / warehouse name.  
code  String (255)  Location / warehouse code. This may be useful for integration purposes.  
addressID  Integer  ID of the location address. This refers to one of the addresses you have defined on company card.  
address  String  Full address, formatted. This is the same address that the above ID refers to.  
*****    The same address as above, split into components:  
street  String (65536)  Street address (or more generally, address line 1).  
address2  String (65536)  Street address, line 2. This field is exposed via Erply user interface only for US, CA, AU, MX, DE, AT and CH accounts!  
city  String (255)  City, region, or county.  
ZIPcode  String (16)  Postal code or ZIP code.(deprecated alternative name: postcode)  
state  String (255)  State. This field is exposed via Erply user interface only for US, CA, AU, MX, DE, AT and CH accounts!  
country  String (255)  Country.  
*****    Contact information for this location

This information is meant to override your company's general contact information, which you can set in ERPLY back office on your company card. See Settings → My company information to edit that data and API call getCompanyInfo to retrieve it via API.

Eg. if there is no phone number set for this particular location, you can assume that the location shares the corporate phone number, and retrieve it from API getCompanyInfo.  
companyName  String (255)  Company name.

Typically you should not customize your company name per-location. This may be needed only if the location is a different corporate entity (your business is a franchise chain that operates in a single ERPLY account, instead of using a separate account for each entity).

The corresponding field in API getCompanyInfo is "name".  
companyCode  String (255)  Company registration number.
Typically the registration number does not vary per-location, see the comments above.

The corresponding field in API getCompanyInfo is "code".  
companyVatNumber  String (255)  Company VAT number.
Typically the VAT number does not vary per-location, see the comments above.

The corresponding field in API getCompanyInfo is "VAT".  
phone  String (255)  Location phone number.  
fax  String (255)  Location fax number.  
email  String (255)  Location e-mail address.  
website  String (255)  Location website address.  
bankName  String (255)  Name of bank (where this location has a bank account).  
bankAccountNumber  String (255)  Bank account number.  
iban  String (255)  IBAN (international bank account number).  
swift  String (255)  Bank's BIC/SWIFT identifier.  
*****    *****  
storeRegionID  Integer 

Store region ID, available only if "Store regions" module has been enabled on your account.

To get a list of store regions, see getStoreRegions.

 
assortmentID  Integer 

Assortment ID.

An assortment defines which product can be sold and/or purchased in this location.

Using assortments requires the "Assortments" extra module which customer support can enable on your account.

To get a list of assortments and their contents, see getAssortments and getAssortmentProducts.

 
pricelistID  Integer  Warehouse first price list.  
pricelistID2  Integer  Warehouse second price list.  
pricelistID3  Integer  Warehouse third price list.  
pricelistID4  Integer  Warehouse fourth price list.  
pricelistID5  Integer  Warehouse fifth price list.  
storeGroups  String  A comma-separated list of store groups.  
defaultCustomerGroupID  Integer    
onlineAppointmentsEnabled  Integer (0 or 1)  Salon-specific attribute. Available only if Salon / Spa module is enabled on your account.  
isOfflineInventory  Integer (0 or 1)  Shows if this warehouse has been assigned to be an "offline location" for another store. ("Offline inventory" or "offline location" is typically where the returned items are placed; they will go through inspection and will be moved either back to the store, or written off.)  
timeZone  String  Time zone of this location. This field is populated only if the time zone is different from the account's main time zone. To get the account's main timezone use the API call getConfParameters.  
attributes  Array  Additional attributes. Each item looks like this:

Field nameTypeDescription
attributeNameStringAttribute name
attributeTypeStringAttribute type
attributeValueStringAttribute value