The following headers can be specified when executing a request
|Authorization header where all authorization data should be sent. Details can be found in the Authorization chapter.|
|This header allows you to specify the client/platform name and/or other information related to it.|
|This header allows you to specify the client/platform number of the request. Its content does not affect the functioning of the API.|
|This header allows you to specify the name of the request. It is useful for debugging bugs and problems that may occur during API integration. Its application does not affect the functioning of the API.|
This header allows you to change the editing of errors. Available values:
In response, the server returns the following header:
|Request ID. It is useful for debugging bugs and problems that may occur during API integration.|
If it is specified during the request, the API will not generate its own IID, and the one provided during the request will be returned in the response.
All requests which are sent to the server requires to pass a valid access token, which belongs to the owner of the organization.
The access token should be provided in the header
|String||Absolute URL address to the collection.|
|Integer||A total number of items in the collection.|
|Integer||The current collection results page.|
|Integer||A number of results (per page) returned in the response.|
Elements of the collection.
Collection example in JSON:
Collections support paging (unless stated otherwise in the resource-specific documentation).
Scrolling through the pages of the collection is done by passing query parameters (page) and/or (page_page) in the request. Request example:
List of error keys that may occur:
The resource you are looking for was not found.
Access to the specified resource is denied.
|An invalid value was passed for a parameter in the URI. Details are available under the description key of the error response.|
|Validation error. The data sent in the payload of the POST request is incorrect. Details of the error are in the response under the details key.|
|The offer cannot be purchased, because its validity has expired.|
The details object contains a collection in which the keys correspond to the names of parameters sent in the payload of the request, while the values are an array with keys specifying which validation errors occurred for a given parameter.
Possible validation errors:
The value for the specified parameter is required.
|The number of characters is too small. Check the resource documentation for details.|
|The number of characters is too large. Check the resource documentation for details.|
|The entered value should be a number.|
|The entered value should be an integer number.|
|The entered value is invalid. Check the resource documentation for details.|