Search

getAssortments

Get a list of assortments.

An assortment defines which products a particular store is allowed to sell and/or to purchase.

To edit an assortment or add a new one, see saveAssortment. To delete an assortment, see deleteAssortment. To manipulate with the products associated with an assortment, see API calls getAssortmentProducts, addAssortmentProducts, editAssortmentProducts and removeAssortmentProducts. To retrieve all products that can be sold in location according to product status in assortment and it’s card see getSellableProducts.

This API call is available only if “Assortments” module has been enabled on your account.

Input parameters

Parameter nameDescriptionPossible valueRequired
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
recordsOnPageNumber of records API should return. By default 20, at most 100.Integer
pageNoAPI returns at most recordsOnPage items at a time. To retrive the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1".Integer

Response

Field nameTypeDescription
assortmentIDIntegerID of the assortment.
codeStringAssortment code. ERPLY itself does not use assortment code for any purpose, but it might be useful for integrations.
nameStringAssortment name.
addedUnix timestampCreation time.
lastModifiedUnix timestampLast modification time.

This API call returns error code 1006 if "Assortments" module has not been enabled on your account.