getCustomerGroups

Get customer groups. In Erply, customer groups are hierarchical; a group can contain sub-groups.

Input parameters

Parameter name Description Possible value Required
changedSince Retrieve only items that have been added or modified since the specified timestamp. Use it to keep a local database in sync with Erply. Integer (Unix timestamp)
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
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

Response

Field name Type Description
customerGroupID Integer Customer group ID.
parentID Integer Parent element ID.
name String
pricelistID Integer Customer group price list 1.
pricelistID2 Integer Customer group price list 2.
pricelistID3 Integer Customer group price list 3.
pricelistID4 Integer Customer group price list 4.
pricelistID5 Integer Customer group price list 5.
added Unix timestamp Creation time.
lastModified Unix timestamp Last modification time.
attributes Array Additional attributes. Each item looks like this:

Field nameTypeDescription
attributeNameStringAttribute name
attributeTypeStringAttribute type
attributeValueStringAttribute value

If your account uses customer registry microservice (the list of customers is stored outside of Erply), you can still use this API call, but fields "pricelistID", "pricelistID2", "pricelistID3", "pricelistID4", "pricelistID5", "added" and "lastModified" will always return 0.

Also, you cannot use input parameter "changedSince" — it will return error code 1126. To synchronize customer groups, integrate with the customer registry directly.