API documentation
Method list
Test your request
Changelog


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.
statusvarchar(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
parametersarrayPredefined inventory parameter definitions.
| - parameter_keytextPredefined parameter key.
| - typetextPublic parameter type.
| - name_translationsarrayStored parameter names keyed by lower-case language code.
| - optionsarrayTranslated 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_groupsarrayAccount-owned parameter groups and their many-to-many parameter mappings.
| - group_idintStable parameter-group identifier.
| - nametextParameter-group name.
| - parameter_keysarrayReturned parameter keys assigned to this group.



Sample
Input data:
Output data:
A sample request in PHP: