getParameters

Retrieve product parameters.

"Product parameters" is a Erply add-on module, primarily for web shops. (It is not enabled by default. If you are looking for a simple way to attach extra key-value data to products, you may want to consider using attributes instead.)

To work with parameters, you first need to define "parameter groups" in Erply backend, and associate these with product groups. Each group must define a set of parameters for a specific type of product. Eg.: inner and outer diameter for bearings; volume, energy rating and physical dimensions for refrigerators etc.

Then, on product card, you can set specific parameter values for each item (eg. Refrigerator XYZ has a volume of 250 L, energy rating "A+" and measures 500 x 650 x 1700 mm).

This API call will return list of parameters and which parameter group they belong to. Unfortunately, API does not have calls for listing all the groups yet, or querying which product groups are associated with which parameter groups.

To get products and their parameter values, use API call getProducts, set getParameters = 1 and see output field "parameters".

Input parameters

Parameter name Description Possible value Required
parameterID Retrieve one specific parameter. Integer
parameterGroupID Retrieve all parameters in a specific group. Integer
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
parameterID Integer Parameter ID
parameterName String Parameter Name (eg. "Volume")
parameterUnitName String Unit of measure for numeric values (eg. "L")
parameterType String Possible values: TEXT, NUMERIC, BOOLEAN, MULTIVALUE.
parameterGroupID Integer Group (or set) where this parameter belongs.
parameterGroupName String Set name (eg. "Parameters for refrigerators").
added Unix timestamp Creation time.
lastModified Unix timestamp Last modification time.
options Array List of options for a MULTIVALUE element. Each item looks like this:

Field nameTypeDescription
parameterOptionIDIntegerOption ID
parameterOptionNameStringOption name