API Version 1.45.0

July 14, 2021

On this page

New Features

  1. All API calls now allow to optionally specify which fields must be returned. By default, API returns the whole dataset as always; but if a list of fields is specified, the records will be returned with these fields only.

    Use input parameter "getFields". Example:

     request=getProducts getFields=productID,code,productComponents,images 

    Unknown field names will be ignored.

    This feature helps to reduce the amount of data sent over the network.

    Please note that the filter is applied at output stage. API will still fetch each field from database, and/or calculate it, as it would usually do. Only then will API discard the fields that API client does not want to receive.

    Therefore, omitting a field does not make an API call execute faster, or make it possible to retrieve a million records at once. But the response sent over the network will be more compact. If an unexpectedly large response is slowing down the frontend, this optimization will help.