getAssortments

This call is deprecated. We recommend to use PIM API instead.

The corresponding new call is: GET /v1/assortment.

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 name Description Possible value Required
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
searchAttributeName Name of attribute to search from. Both "searchAttributeName" and "searchAttributeValue" have to be specified. Error 1030 will be returned if value is an array. string
searchAttributeValue Attribute value to search for. Error 1030 will be returned if value is an array. string
recordsOnPage Number of records API should return. By default 20, at most 100. integer
pageNo API returns at most recordsOnPage items at a time. To retrieve the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1". integer

Response

Field name Type Description
assortmentID integer ID of the assortment.
code string Assortment code. Erply itself does not use assortment code for any purpose, but it might be useful for integrations.
name string Assortment name.
added integer Unix timestamp. Creation time.
lastModified integer Unix timestamp. Last modification time.
attributes array Additional attributes. Each item looks like this:

Field nameTypeDescription
attributeNameStringAttribute name
attributeTypeStringAttribute type
attributeValueStringAttribute value

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