getInventoryParameters
Returns predefined inventory parameters with all stored translations, existing choice options, and parameter-group mappings.
Input parameters
Output data
The method returns the data in JSON format.
| status | varchar(30) | SUCCESS - request executed correctly ERROR - an error occurred during an API request. Error details will be described in 2 additional returned fields: error_message and error_code |
| parameters | array | Predefined inventory parameter definitions. |
| | - parameter_key | text | Predefined parameter key. |
| | - type | text | Public parameter type. |
| | - name_translations | array | Stored parameter names keyed by lower-case language code. |
| | - options | array | Translated options for select and multiselect parameters. option_id (text) - Existing option identifier from the predefined parameter data. value_translations (array) - Stored option values keyed by lower-case language code. |
| parameter_groups | array | Account-owned parameter groups and their many-to-many parameter mappings. |
| | - group_id | int | Stable parameter-group identifier. |
| | - name | text | Parameter-group name. |
| | - parameter_keys | array | Returned parameter keys assigned to this group. |
Sample
Input data:Output data:
A sample request in PHP: