getProductGroups

Returns a HIERARCHICAL array of product groups.

Groups are a way of categorizing your product database, and several API calls support filtering by group.

Products can additionally be organized into categories (getProductCategories, hierarchical), brands (getBrands, a flat list), and priority groups (getProductPriorityGroups, a flat list)

Note: PIM API offers a better REST interface for retrieving and managing product groups.

Input parameters

Parameter name Description Possible value Required
productGroupID Fetch one specific product group. Integer
showInWebshop Set to 1 to retrieve only the products groups that are displayed in webshop. 0 or 1
changedSince For synchronization; retrieve all product groups that have been updated after a certain time. To learn more about synchronization best practices, see Synchronizing Data with “changedSince” 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
getAllLanguages Retrive product group names in all languages. If you turn on this flag, API will return additional fields nameENG, nameGER, etc. — depending on which languages have been enabled on your account. 0 or 1

Response

Field name Type Description
productGroupID Integer Product group ID.
name String Product group name.

Product groups can have different names in each language. Use input parameter lang to specify which language you want to retrieve. By default, API returns names in account's default language.

If you want to retrieve names in all languages with one API call, set input parameter getAllLanguages = 1. In addition to field name, API will then return fields nameENG, nameGER, etc. — one for each language enabled on your account.
showInWebshop Integer 1 if product group should be displayed in webshop.
nonDiscountable 0 or 1 1 if this group is marked as non-discountable. Non-discountable products and groups are related to calculateShoppingCart call. This field show only groups's own flag, product can be non-discountable for card calculation if it's group, or any of group's parent group is marked as non-discountable, or if product is any type of gift card. Flag presently only applies to promotion discounts, product still can be discounted manually or using price list.
positionNo Integer Position number. When laying out the list of product groups, you can use this parameter to display them in intended order.
parentGroupID Integer Parent product group ID.
images Array Array, each item in which has the following attributes:

pictureID - Integer - ID of the image
thumbURL - String - URL of image thumbnail (100 x 100 px as configured by default)
smallURL - String - URL of a small version of the image (by default 200 x 200 px)
largeURL - String - URL of a large version of the image (by default 800 x 600 px)
subGroups Array Array of subgroups. Each subgroup has exactly the same structure as described here.
attributes Array Array of attributes. Each item looks like this:

Field nameTypeDescription
attributeNameStringAttribute name
attributeTypeStringAttribute type
attributeValueStringAttribute value
vatrates Array Array of product group-specific tax rates (used in US, for example). Each item looks like this:

Field nameTypeDescription
warehouseIDIntegerWarehouse ID
vatrateIDIntegerTax rate that applies to this product group in this location (warehouse).