Swagger\Client\ItemApi

All URIs are relative to https://api.avito.ru/

Method	HTTP request	Description
getItemInfo	GET /core/v1/accounts/{user_id}/items/{item_id}/	Получение информации по объявлению
getItemsInfo	GET /core/v1/items	Получение информации по объявлениям
getVasPackagePrice	POST /core/v1/accounts/{user_id}/price/vas_packages	Получение информации о стоимости пакетов дополнительных услуг
getVasPrices	POST /core/v1/accounts/{user_id}/price/vas	Получение информации о стоимости дополнительных услуг
itemStatsShallow	POST /stats/v1/accounts/{user_id}/items	Получение статистики по списку объявлений
postCallsStats	POST /core/v1/accounts/{user_id}/calls/stats/	Получение статистики по звонкам
putItemVas	PUT /core/v1/accounts/{user_id}/items/{item_id}/vas	Применение дополнительных услуг
putItemVasPackageV2	PUT /core/v2/accounts/{user_id}/items/{item_id}/vas_packages	Применение пакета дополнительных услуг

getItemInfo

\Swagger\Client\Model\ItemInfoAvito getItemInfo($user_id, $item_id, $authorization)

Получение информации по объявлению

Возвращает данные об объявлении - его статус, список примененных услуг Внимание: для получения статистики объявления должен использоваться метод: получение статистики по списку объявлений

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: AuthorizationCode
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: ClientCredentials
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\ItemApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$user_id = 789; // int | Номер пользователя в Личном кабинете Авито
$item_id = 789; // int | Идентификатор объявления на сайте
$authorization = "authorization_example"; // string | Токен для авторизации

try {
    $result = $apiInstance->getItemInfo($user_id, $item_id, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemApi->getItemInfo: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
user_id	int	Номер пользователя в Личном кабинете Авито
item_id	int	Идентификатор объявления на сайте
authorization	string	Токен для авторизации

Return type

\Swagger\Client\Model\ItemInfoAvito

Authorization

AuthorizationCode, ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getItemsInfo

\Swagger\Client\Model\ItemsInfoWithCategoryAvito getItemsInfo($authorization, $per_page, $page, $status, $category)

Получение информации по объявлениям

Возвращает список объявлений авторизованного пользователя - статус, категорию и ссылку на сайте

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: AuthorizationCode
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: ClientCredentials
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\ItemApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$authorization = "authorization_example"; // string | Токен для авторизации
$per_page = 25; // int | Количество записей на странице (целое число больше 0 и меньше 100)
$page = 1; // int | Номер страницы (целое число больше 0)
$status = "active"; // string | Статус объявления на сайте (можно указать несколько значений через запятую)
$category = 56; // int | Идентификатор категории объявления

try {
    $result = $apiInstance->getItemsInfo($authorization, $per_page, $page, $status, $category);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemApi->getItemsInfo: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
authorization	string	Токен для авторизации
per_page	int	Количество записей на странице (целое число больше 0 и меньше 100)	[optional] [default to 25]
page	int	Номер страницы (целое число больше 0)	[optional] [default to 1]
status	string	Статус объявления на сайте (можно указать несколько значений через запятую)	[optional] [default to active]
category	int	Идентификатор категории объявления	[optional]

Return type

\Swagger\Client\Model\ItemsInfoWithCategoryAvito

Authorization

AuthorizationCode, ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getVasPackagePrice

\Swagger\Client\Model\InlineResponse2001 getVasPackagePrice($authorization, $user_id, $body)

Получение информации о стоимости пакетов дополнительных услуг

Возвращает в ответ объект со следующей структурой: - packages – объект, который содержит информацию о стоимости пакетов дополнительных услуг для каждого объявления. Ключами являются идентификаторы объявлений, значениями – объекты с информацией о стоимости пакетов услуг для данного объявления: - x2_1 - пакет "до 2 раз больше просмотров на 1 день" - x2_7 - пакет "до 2 раз больше просмотров на 7 дней" - x5_1 - пакет "до 5 раз больше просмотров на 1 день" - x5_7 - пакет "до 5 раз больше просмотров на 7 дней" - x10_1 - пакет "до 10 раз больше просмотров на 1 день" - x10_7 - пакет "до 10 раз больше просмотров на 7 дней" - errors – идентификаторы объявлений, для которых информация не получена.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: AuthorizationCode
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: ClientCredentials
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\ItemApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$authorization = "authorization_example"; // string | Токен для авторизации
$user_id = 789; // int | Номер пользователя в Личном кабинете Авито
$body = new \Swagger\Client\Model\ItemIdsRequestBody(); // \Swagger\Client\Model\ItemIdsRequestBody | Набор идентификаторов объявлений на сайте

try {
    $result = $apiInstance->getVasPackagePrice($authorization, $user_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemApi->getVasPackagePrice: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
authorization	string	Токен для авторизации
user_id	int	Номер пользователя в Личном кабинете Авито
body	\Swagger\Client\Model\ItemIdsRequestBody	Набор идентификаторов объявлений на сайте	[optional]

Return type

\Swagger\Client\Model\InlineResponse2001

Authorization

AuthorizationCode, ClientCredentials

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getVasPrices

\Swagger\Client\Model\InlineResponse200 getVasPrices($authorization, $user_id, $body)

Получение информации о стоимости дополнительных услуг

Возвращает в ответ объект со следующей структурой: - vas – объект, который содержит информацию о стоимости дополнительных услуг для каждого объявления. Ключами являются идентификаторы объявлений, значениями – объекты с информацией о стоимости услуг для данного объявления: - highlight — услуга продвижения "Выделить" - xl – услуга продвижения "XL-объявление" - errors – идентификаторы объявлений, для которых информация не получена.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: AuthorizationCode
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: ClientCredentials
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\ItemApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$authorization = "authorization_example"; // string | Токен для авторизации
$user_id = 789; // int | Номер пользователя в Личном кабинете Авито
$body = new \Swagger\Client\Model\ItemIdsRequestBody(); // \Swagger\Client\Model\ItemIdsRequestBody | Набор идентификаторов объявлений на сайте

try {
    $result = $apiInstance->getVasPrices($authorization, $user_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemApi->getVasPrices: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
authorization	string	Токен для авторизации
user_id	int	Номер пользователя в Личном кабинете Авито
body	\Swagger\Client\Model\ItemIdsRequestBody	Набор идентификаторов объявлений на сайте	[optional]

Return type

\Swagger\Client\Model\InlineResponse200

Authorization

AuthorizationCode, ClientCredentials

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

itemStatsShallow

\Swagger\Client\Model\StatisticsResponse itemStatsShallow($authorization, $content_type, $user_id, $body)

Получение статистики по списку объявлений

Получение счетчиков по переданному списку объявлений пользователя. Внимание: в запросе может быть передано не более 200 идентификаторов объявлений. Внимание: глубина такого запроса ограничена 270 днями. ### Счетчики * ~~views - общее число просмотров объявления;~~ DEPRECATED (будет удалено в апреле 2021 г.). Используйте поле uniqViews. * uniqViews - число уникальных пользователей, просмотревших объявление; * ~~contacts - число контактов [1];~~ DEPRECATED (будет удалено в апреле 2021 г.). Используйте поле uniqContacts. * uniqContacts - число уникальных пользователей, совершивших контакты [1]; * ~~favorites - число добавлений объявления в "избранное";~~ DEPRECATED (будет удалено в апреле 2021 г.). Используйте поле uniqFavorites. * uniqFavorites - число уникальных пользователей, добавивших объявление в "избранное". ### Группировка счетчиков Счетчики могут быть сгруппированы [2] по: * дням; * неделям - в поле date соответствующей структуры будет первый день недели; * месяцам - в поле date соответствующей структуры будет первый день месяца. #### Период группировки Период группировки передается в теле запроса в поле periodGrouping. Доступные значения этого поля: * "day" (по умолчанию) - без группировки; * "week" - суммирование счетчиков за неделю; * "month" - суммирование счетчиков за месяц. ### Примечания * [1]: Под контактом понимаются: запросы телефона продавца, начатый чат с продавцом по конкретному объявлению, отклик на резюме и пр. * [2]: Группировка уникальных пользователей происходит только в рамках одного дня.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: AuthorizationCode
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: ClientCredentials
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\ItemApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$authorization = "authorization_example"; // string | Токен для авторизации
$content_type = "content_type_example"; // string | Тип данных запроса
$user_id = 789; // int | Идентификатор пользователя (клиента)
$body = new \Swagger\Client\Model\StatisticsShallowRequestBody(); // \Swagger\Client\Model\StatisticsShallowRequestBody | Набор параметров в теле запроса.

try {
    $result = $apiInstance->itemStatsShallow($authorization, $content_type, $user_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemApi->itemStatsShallow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
authorization	string	Токен для авторизации
content_type	string	Тип данных запроса
user_id	int	Идентификатор пользователя (клиента)
body	\Swagger\Client\Model\StatisticsShallowRequestBody	Набор параметров в теле запроса.	[optional]

Return type

\Swagger\Client\Model\StatisticsResponse

Authorization

AuthorizationCode, ClientCredentials

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postCallsStats

\Swagger\Client\Model\CallsStatsResponse postCallsStats($body, $authorization, $content_type, $user_id)

Получение статистики по звонкам

Получение агрегированной статистики звонков, полученных пользователем

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: AuthorizationCode
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: ClientCredentials
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\ItemApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Swagger\Client\Model\CallsStatsRequest(); // \Swagger\Client\Model\CallsStatsRequest | 
$authorization = "authorization_example"; // string | Токен для авторизации
$content_type = "content_type_example"; // string | Тип данных запроса
$user_id = 789; // int | Номер пользователя в Личном кабинете Авито

try {
    $result = $apiInstance->postCallsStats($body, $authorization, $content_type, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemApi->postCallsStats: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
body	\Swagger\Client\Model\CallsStatsRequest
authorization	string	Токен для авторизации
content_type	string	Тип данных запроса
user_id	int	Номер пользователя в Личном кабинете Авито

Return type

\Swagger\Client\Model\CallsStatsResponse

Authorization

AuthorizationCode, ClientCredentials

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

putItemVas

\Swagger\Client\Model\VasApplyAvito putItemVas($authorization, $user_id, $item_id, $body)

Применение дополнительных услуг

Применение дополнительной услуги к объявлению, в ответе возвращает данные о примененной услуге и сумму списания. Более подробная информация по дополнительным услугам Внимание: получение ошибки при выполнении этой операции не означает, что услуга точно не была куплена. В этом случае рекомендуется подождать несколько минут и проверить, что услуга отсутствует в списке применённых, а только затем повторить попытку.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: AuthorizationCode
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: ClientCredentials
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\ItemApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$authorization = "authorization_example"; // string | Токен для авторизации
$user_id = 789; // int | Номер пользователя в Личном кабинете Авито
$item_id = 789; // int | Идентификатор объявления на сайте
$body = new \Swagger\Client\Model\VasIdRequestBody(); // \Swagger\Client\Model\VasIdRequestBody | 

try {
    $result = $apiInstance->putItemVas($authorization, $user_id, $item_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemApi->putItemVas: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
authorization	string	Токен для авторизации
user_id	int	Номер пользователя в Личном кабинете Авито
item_id	int	Идентификатор объявления на сайте
body	\Swagger\Client\Model\VasIdRequestBody		[optional]

Return type

\Swagger\Client\Model\VasApplyAvito

Authorization

AuthorizationCode, ClientCredentials

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

putItemVasPackageV2

\Swagger\Client\Model\VasAmountAvito putItemVasPackageV2($authorization, $user_id, $item_id, $body)

Применение пакета дополнительных услуг

Применение пакета дополнительных услуг к объявлению, в ответе возвращает сумму списания. Внимание: получение ошибки при выполнении этой операции не означает, что пакет точно не была куплен. В этом случае рекомендуется подождать несколько минут и проверить, что пакет отсутствует в списке применённых, а только затем повторить попытку.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: AuthorizationCode
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: ClientCredentials
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\ItemApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$authorization = "authorization_example"; // string | Токен для авторизации
$user_id = 789; // int | Номер пользователя в Личном кабинете Авито
$item_id = 789; // int | Идентификатор объявления на сайте
$body = new \Swagger\Client\Model\PackageIdRequestBodyV2(); // \Swagger\Client\Model\PackageIdRequestBodyV2 | 

try {
    $result = $apiInstance->putItemVasPackageV2($authorization, $user_id, $item_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemApi->putItemVasPackageV2: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
authorization	string	Токен для авторизации
user_id	int	Номер пользователя в Личном кабинете Авито
item_id	int	Идентификатор объявления на сайте
body	\Swagger\Client\Model\PackageIdRequestBodyV2		[optional]

Return type

\Swagger\Client\Model\VasAmountAvito

Authorization

AuthorizationCode, ClientCredentials

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ItemApi.md

Latest commit

History

ItemApi.md

File metadata and controls

Swagger\Client\ItemApi

getItemInfo

Example

Parameters

Return type

Authorization

HTTP request headers

getItemsInfo

Example

Parameters

Return type

Authorization

HTTP request headers

getVasPackagePrice

Example

Parameters

Return type

Authorization

HTTP request headers

getVasPrices

Example

Parameters

Return type

Authorization

HTTP request headers

itemStatsShallow

Example

Parameters

Return type

Authorization

HTTP request headers

postCallsStats

Example

Parameters

Return type

Authorization

HTTP request headers

putItemVas

Example

Parameters

Return type

Authorization

HTTP request headers

putItemVasPackageV2

Example

Parameters

Return type

Authorization

HTTP request headers