API documentation
Method list
Test your request
Changelog


getOrderReturnExtraFields
The method returns extra fields defined for order returns. Values of those fields can be set with method setOrderReturnFields. To retrieve values of those fields set parameter include_custom_extra_fields in method getOrderReturns


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
extra_fieldsarrayA list containing returns extra fields, where the key of the field serves as the key in the array and the value is an array containing the fields name and type
| - extra_field_idintID of the extra field
| - nameintField name.
| - editor_typevarcharEditor type. The following values are available: text, number, select, checkbox, radio, date, file.
| - optionsarray(optional) An array of values available for a given additional field. Applicable to select, checkbox and radio editors.



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