Search

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 nameDescriptionPossible valueRequired
warehouseIDRetrieve one specific warehouse.Integer
userID
langRetrieve 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
codeSearch 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
searchAttributeNameSearch from attribute name. searchAttributeName and searchAttributeValue have to be specified bothString
searchAttributeValueSearch from attribute valueString

Response

Field nameTypeDescription
warehouseIDInteger
nameString (255)Store / location / warehouse name.
codeString (255)Location / warehouse code. This may be useful for integration purposes.
addressIDIntegerID of the location address. This refers to one of the addresses you have defined on company card.
addressStringFull address, formatted. This is the same address that the above ID refers to.
*****The same address as above, split into components:
streetString (65536)Street address (or more generally, address line 1).
address2String (65536)Street address, line 2. This field is exposed via Erply user interface only for US, CA, AU, MX, DE, AT and CH accounts!
cityString (255)City, region, or county.
ZIPcodeString (16)Postal code or ZIP code.(deprecated alternative name: postcode)
stateString (255)State. This field is exposed via Erply user interface only for US, CA, AU, MX, DE, AT and CH accounts!
countryString (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.
companyNameString (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".
companyCodeString (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".
companyVatNumberString (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".
phoneString (255)Location phone number.
faxString (255)Location fax number.
emailString (255)Location e-mail address.
websiteString (255)Location website address.
bankNameString (255)Name of bank (where this location has a bank account).
bankAccountNumberString (255)Bank account number.
ibanString (255)IBAN (international bank account number).
swiftString (255)Bank's BIC/SWIFT identifier.
**********************************
storeRegionIDInteger

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

To get a list of store regions, see getStoreRegions.

assortmentIDInteger

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.

pricelistIDIntegerWarehouse first price list.
pricelistID2IntegerWarehouse second price list.
pricelistID3IntegerWarehouse third price list.
pricelistID4IntegerWarehouse fourth price list.
pricelistID5IntegerWarehouse fifth price list.
storeGroupsStringA comma-separated list of store groups.
defaultCustomerGroupIDInteger
onlineAppointmentsEnabledInteger (0 or 1)Salon-specific attribute. Available only if Salon / Spa module is enabled on your account.
isOfflineInventoryInteger (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.)
attributesArrayAdditional attributes. Each item looks like this:

Field nameTypeDescription
attributeNameStringAttribute name
attributeTypeStringAttribute type
attributeValueStringAttribute value