Avito Autoload API

openapi: 3.0.0
info:
  contact:
    email: supportautoload@avito.ru
  description: 'API для взаимодействия с иерархией аккаунтов в Авито

    **Авито API для бизнеса предоставляется согласно [Условиям использования](https://www.avito.ru/legal/pro_tools/public-api).**

    '
  title: Иерархия Аккаунтов Access Autoload API
  version: '1'
servers:
- url: https://api.avito.ru/
tags:
- description: Методы API для получения информации об автозагрузке объявлений
  name: Autoload
  x-displayName: Сервис Автозагрузка
paths:
  /autoload/v1/profile:
    parameters:
    - $ref: '#/components/parameters/authHeader'
    get:
      deprecated: true
      description: 'Возвращает настройки профиля пользователя автозагрузки.

        С 23.12.2024 вместо поля upload_url используйте поле feeds_data. В нём содержится название файла и ссылка на него. [Новая версия](https://developers.avito.ru/api-catalog/autoload/documentation#operation/getProfileV2)'
      operationId: getProfile
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  autoload_enabled:
                    description: Статус автозагрузки (вкл/выкл)
                    type: boolean
                  report_email:
                    description: Почта, на которую будут приходить отчеты о выгрузках
                    nullable: true
                    type: string
                  schedule:
                    $ref: '#/components/schemas/ExportSchedule'
                  upload_url:
                    description: URL-адрес фида, для которого настроены регулярные выгрузки. Должен начинаться с http или https.
                    nullable: true
                    type: string
                required:
                - upload_url
                - autoload_enabled
                - report_email
                - schedule
                type: object
          description: 'Успешное получение данных пользователя

            '
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldErrorV2'
          description: Неверный запрос
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldErrorV2'
          description: Доступ запрещён
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldErrorV2'
          description: Профиль не найден
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldErrorV2'
          description: Внутренняя ошибка метода API
      summary: Получение профиля пользователя автозагрузки (deprecated)
      tags:
      - Autoload
    post:
      deprecated: true
      description: "Предназначен для создания и управления профилем автозагрузки. Если профиля еще не существует - через этот метод можно его создать. \n\nС 23.12.2024 вместо поля upload_url используйте поле feeds_data. В нём содержится название файла и ссылка на него. [Новая версия](https://developers.avito.ru/api-catalog/autoload/documentation#operation/createOrUpdateProfileV2)\n"
      operationId: createOrUpdateProfile
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertProfileIn'
      responses:
        '200':
          description: Успешное обновление настроек профиля
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldErrorV2'
          description: Неверный запрос
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldErrorV2'
          description: Доступ запрещён
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldErrorV2'
          description: Внутренняя ошибка метода API
      summary: Создание/редактирование настроек профиля пользователя автозагрузки (deprecated)
      tags:
      - Autoload
  /autoload/v1/upload:
    post:
      description: 'Метод запускает процесс выгрузки объявлений из файла по ссылке, которая указана

        [в настройках автозагрузки](https://www.avito.ru/autoload/settings) в профиле Авито.

        В течение часа таким способом можно запустить только одну выгрузку.


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

        Все объявления из файла, которые могут быть опубликованы или активированы, будут опубликованы или активированы.


        📝 [Напишите нам](https://docs.google.com/forms/d/e/1FAIpQLSdfTHlP6PKtOb08fxD7BaJ0VjtkaLXoRAswhF9gnKvrEyY16g/viewform?usp=sf_link),

        если в методе вам не хватает каких-либо данных.

        '
      operationId: upload
      responses:
        '200':
          description: Выгрузка файла по ссылке запущена успешно
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldErrorV2'
          description: Информация об ошибке
      summary: Загрузка файла по ссылке
      tags:
      - Autoload
  /autoload/v1/user-docs/node/{node_slug}/fields:
    parameters:
    - $ref: '#/components/parameters/NodeSlug'
    - $ref: '#/components/parameters/IfModifiedSinceHeader'
    get:
      description: 'Метод позволяет получить поля конкретной категории и их параметры, зависимости полей, возможные значения и их типы, предупреждения (например, когда поле станет обязательным) и ссылки на каталоги значений.


        📝 [Напишите нам](https://docs.google.com/forms/d/e/1FAIpQLSdfTHlP6PKtOb08fxD7BaJ0VjtkaLXoRAswhF9gnKvrEyY16g/viewform?usp=sf_link), если в методе вам не хватает каких-либо данных.

        '
      operationId: userDocsNodeFields
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIFieldsOut'
          description: Успешное получение полей для переданной категории
          headers:
            Last-Modified:
              $ref: '#/components/headers/LastModifiedSinceHeader'
        '304':
          description: Вернётся пустой ответ, если дата в заголовке If-Modified-Since раньше даты последней сборки документации.
          headers:
            Last-Modified:
              $ref: '#/components/headers/LastModifiedSinceHeader'
        '400':
          content:
            application/json:
              schema:
                properties:
                  code:
                    description: Код ошибки
                    type: integer
                  message:
                    description: Текст ошибки
                    type: string
                required:
                - code
                - message
                type: object
          description: Неправильный запрос
        '403':
          content:
            application/json:
              schema:
                properties:
                  code:
                    description: Код ошибки
                    type: integer
                  message:
                    description: Текст ошибки
                    type: string
                required:
                - code
                - message
                type: object
          description: Ошибка авторизации пользователя
        '404':
          content:
            application/json:
              schema:
                properties:
                  code:
                    description: Код ошибки
                    type: integer
                  message:
                    description: Текст ошибки
                    type: string
                required:
                - code
                - message
                type: object
          description: Запрашиваемый ресурс не найден
      summary: Получения полей категории
      tags:
      - Autoload
  /autoload/v1/user-docs/tree:
    parameters:
    - $ref: '#/components/parameters/IfModifiedSinceHeader'
    get:
      description: "Метод позволяет получить дерево категорий Авито в виде массива.  \n\U0001F4DD [Напишите нам](https://docs.google.com/forms/d/e/1FAIpQLSdfTHlP6PKtOb08fxD7BaJ0VjtkaLXoRAswhF9gnKvrEyY16g/viewform?usp=sf_link), если в методе вам не хватает каких-либо данных.\n"
      operationId: userDocsTree
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APICategoryTreeOut'
          description: Успешное получение дерева категорий
          headers:
            Last-Modified:
              $ref: '#/components/headers/LastModifiedSinceHeader'
        '304':
          description: Вернётся пустой ответ, если дата в заголовке If-Modified-Since раньше даты последней сборки документации.
          headers:
            Last-Modified:
              $ref: '#/components/headers/LastModifiedSinceHeader'
        '403':
          content:
            application/json:
              schema:
                properties:
                  code:
                    description: Код ошибки
                    type: integer
                  message:
                    description: Текст ошибки
                    type: string
                required:
                - code
                - message
                type: object
          description: Ошибка авторизации пользователя
      summary: Получение дерева категорий
      tags:
      - Autoload
  /autoload/v2/items/ad_ids:
    get:
      description: 'Метод позволяет получить идентификаторы (ID) объявлений из файла автозагрузки по ID объявлений на Авито.


        📝 [Напишите нам](https://docs.google.com/forms/d/e/1FAIpQLSdfTHlP6PKtOb08fxD7BaJ0VjtkaLXoRAswhF9gnKvrEyY16g/viewform?usp=sf_link),

        если в методе вам не хватает каких-либо данных.

        '
      operationId: getAdIdsByAvitoIds
      parameters:
      - description: 'Список ID объявлений.

          Формат значения: строка с идентификаторами объявлений на Авито, перечисленными через «,» или «|».

          '
        in: query
        name: query
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authHeader'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  items:
                    description: Список связанных идентификаторов (ID) объявлений из файла с идентификаторами (ID) на Авито
                    items:
                      properties:
                        ad_id:
                          description: Идентификатор объявления из файла
                          nullable: true
                          type: string
                        avito_id:
                          description: Идентификатор объявления на Авито
                          type: integer
                      required:
                      - avito_id
                      type: object
                    type: array
                required:
                - items
                type: object
          description: Успешный ответ
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldErrorV2'
          description: Все ошибки
      summary: ID объявлений из файла
      tags:
      - Autoload
  /autoload/v2/items/avito_ids:
    get:
      description: 'Метод позволяет получить идентификаторы (ID) объявлений на Авито по идентификаторам объявлений из файла автозагрузки.


        📝 [Напишите нам](https://docs.google.com/forms/d/e/1FAIpQLSdfTHlP6PKtOb08fxD7BaJ0VjtkaLXoRAswhF9gnKvrEyY16g/viewform?usp=sf_link),

        если в методе вам не хватает каких-либо данных.

        '
      operationId: getAvitoIdsByAdIds
      parameters:
      - description: 'Список ID объявлений.

          Формат значения: строка с [идентификаторами объявлений из файла](https://autoload.avito.ru/format/realty/#Id),

          перечисленными через «,» или «|»

          '
        in: query
        name: query
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authHeader'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  items:
                    description: Список связанных идентификаторов (ID) объявлений из файла с идентификаторами (ID) на Авито
                    items:
                      properties:
                        ad_id:
                          description: Идентификатор объявления из файла
                          type: string
                        avito_id:
                          description: Идентификатор объявления на Авито
                          nullable: true
                          type: integer
                      required:
                      - ad_id
                      type: object
                    type: array
                required:
                - items
                type: object
          description: Успешный ответ
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldErrorV2'
          description: Информация об ошибке
      summary: ID объявлений на Авито
      tags:
      - Autoload
  /autoload/v2/profile:
    parameters:
    - $ref: '#/components/parameters/authHeader'
    get:
      description: Возвращает настройки профиля пользователя автозагрузки. С 23.12.2024 вместо поля upload_url используйте поле feeds_data. В нём содержится название файла и ссылка на него.
      operationId: getProfileV2
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  autoload_enabled:
                    description: Статус автозагрузки (вкл/выкл)
                    type: boolean
                  feeds_data:
                    $ref: '#/components/schemas/FeedsData'
                  report_email:
                    description: Почта, на которую будут приходить отчеты о выгрузках
                    nullable: true
                    type: string
                  schedule:
                    $ref: '#/components/schemas/ExportSchedule'
                required:
                - feeds_data
                - autoload_enabled
                - report_email
                - schedule
                type: object
          description: 'Успешное получение данных пользователя

            '
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldErrorV2'
          description: Неверный запрос
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldErrorV2'
          description: Доступ запрещён
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldErrorV2'
          description: Профиль не найден
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldErrorV2'
          description: Внутренняя ошибка метода API
      summary: Получение профиля пользователя автозагрузки
      tags:
      - Autoload
    post:
      description: 'Предназначен для создания и управления профилем автозагрузки. Если профиля еще не существует - через этот метод можно его создать. С 23.12.2024 вместо поля feed_url используйте поле feeds_data. В нём содержится название файла и ссылка на него.

        '
      operationId: createOrUpdateProfileV2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertProfileInV2'
      responses:
        '200':
          description: Успешное обновление настроек профиля
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldErrorV2'
          description: Неверный запрос
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldErrorV2'
          description: Доступ запрещён
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldErrorV2'
          description: Внутренняя ошибка метода API
      summary: Создание/редактирование настроек профиля пользователя автозагрузки
      tags:
      - Autoload
  /autoload/v2/reports:
    get:
      deprecated: true
      description: 'По запросу вы получите список отчётов автозагрузки.

        Они будут отсортированы в порядке убывания: самый свежий отчёт — в начале списка.


        📝 [Напишите нам](https://docs.google.com/forms/d/e/1FAIpQLSdfTHlP6PKtOb08fxD7BaJ0VjtkaLXoRAswhF9gnKvrEyY16g/viewform?usp=sf_link),

        если в методе вам не хватает каких-либо данных.


        Метод будет отключен 08.03.2027. С 08.09.2026 метод начнёт возвращать меньше данных. Подробнее читайте в [плане миграции](https://developers.avito.ru/api-catalog/autoload/documentation#migration-v4).

        '
      operationId: getReportsV2
      parameters:
      - description: 'Количество отчётов на странице: целое число больше 0 и меньше или равно 200.

          '
        in: query
        name: per_page
        schema:
          default: 50
          type: integer
      - description: 'Номер страницы: целое число больше или равно 0.

          '
        in: query
        name: page
        schema:
          default: 0
          type: integer
      - description: 'Фильтр по дате создания отчёта «от» (от такой-то даты).

          Формат значения: RFC3339

          '
        example: '2022-05-27T14:48:50.52Z'
        in: query
        name: date_from
        schema:
          format: date-time
          type: string
      - description: 'Фильтр по дате создания отчёта «до» (до такой-то даты).

          Формат значения: RFC3339

          '
        example: '2022-05-27T14:48:50.52Z'
        in: query
        name: date_to
        schema:
          format: date-time
          type: string
      - $ref: '#/components/parameters/authHeader'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  meta:
                    $ref: '#/components/schemas/MetaReportsAutoloadV2'
                  reports:
                    $ref: '#/components/schemas/ReportShortAutoloadV2'
                type: object
          description: Успешный ответ
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldErrorV2'
          description: Информация об ошибке
      summary: Список отчётов автозагрузки (deprecated)
      tags:
      - Autoload
  /autoload/v2/reports/items:
    get:
      deprecated: true
      description: 'По запросу API отдаст данные по конкретным объявлениям.


        📝 [Напишите нам](https://docs.google.com/forms/d/e/1FAIpQLSdfTHlP6PKtOb08fxD7BaJ0VjtkaLXoRAswhF9gnKvrEyY16g/viewform?usp=sf_link),

        если в методе вам не хватает каких-либо данных.


        Метод будет отключен 08.03.2027. С 08.09.2026 метод начнёт возвращать меньше данных. Подробнее читайте в [плане миграции](https://developers.avito.ru/api-catalog/autoload/documentation#migration-v4).

        '
      operationId: getAutoloadItemsInfoV2
      parameters:
      - description: 'Идентификаторы объявлений из файла ([параметр Id](https://autoload.avito.ru/format/realty/#Id)).

          Формат значения: строка, содержащая от 1 до 100 идентификаторов, перечисленных через «,» или «|».

          '
        in: query
        name: query
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authHeader'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  items:
                    description: Список объявлений
                    items:
                      $ref: '#/components/schemas/ItemInfoAutoloadV2'
                    type: array
                required:
                - items
                type: object
          description: Успешный ответ
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldErrorV2'
          description: Информация об ошибке
      summary: Объявления по ID в автозагрузке (deprecated)
      tags:
      - Autoload
  /autoload/v2/reports/last_completed_report:
    get:
      deprecated: true
      description: 'Метод возвращает сводную статистику с результатами последней завершённой выгрузки.

        Например, сколько объявлений было в файле и сколько из них было опубликовано с ошибками или без.


        📝 [Напишите нам](https://docs.google.com/forms/d/e/1FAIpQLSdfTHlP6PKtOb08fxD7BaJ0VjtkaLXoRAswhF9gnKvrEyY16g/viewform?usp=sf_link),

        если в методе вам не хватает каких-либо данных.


        С 23.12.2024 вместо поля feed_url используйте поле feeds_urls. В нём содержится название файла и ссылка на него.


        Метод будет отключен 08.03.2027. С 08.09.2026 метод начнёт возвращать меньше данных. Подробнее читайте в [плане миграции](https://developers.avito.ru/api-catalog/autoload/documentation#migration-v4).

        '
      operationId: getLastCompletedReport
      parameters:
      - $ref: '#/components/parameters/authHeader'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportAutoloadV2'
          description: Успешный ответ
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldErrorV2'
          description: Информация об ошибке
      summary: Статистика по последней выгрузке (deprecated)
      tags:
      - Autoload
  /autoload/v2/reports/{report_id}:
    get:
      deprecated: true
      description: 'Метод возвращает сводную статистику с результатами конкретной выгрузки — по ID отчёта.

        Например, сколько объявлений было в файле и сколько из них было опубликовано с ошибками или без.


        📝 [Напишите нам](https://docs.google.com/forms/d/e/1FAIpQLSdfTHlP6PKtOb08fxD7BaJ0VjtkaLXoRAswhF9gnKvrEyY16g/viewform?usp=sf_link),

        если в методе вам не хватает каких-либо данных.


        С 23.12.2024 вместо поля feed_url используйте поле feeds_urls. В нём содержится название файла и ссылка на него.


        Метод будет отключен 08.03.2027. С 08.09.2026 метод начнёт возвращать меньше данных. Подробнее читайте в [плане миграции](https://developers.avito.ru/api-catalog/autoload/documentation#migration-v4).

        '
      operationId: getReportByIdV2
      parameters:
      - description: Идентификатор отчёта (ID)
        in: path
        name: report_id
        required: true
        schema:
          type: integer
      - $ref: '#/components/parameters/authHeader'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportAutoloadV2'
          description: Успешный ответ
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldErrorV2'
          description: Информация об ошибке
      summary: Статистика по конкретной выгрузке (deprecated)
      tags:
      - Autoload
  /autoload/v2/reports/{report_id}/items:
    get:
      deprecated: true
      description: 'С помощью этого метода можно получить результаты обработки каждого объявления в конкретной выгрузке.


        📝 [Напишите нам](https://docs.google.com/forms/d/e/1FAIpQLSdfTHlP6PKtOb08fxD7BaJ0VjtkaLXoRAswhF9gnKvrEyY16g/viewform?usp=sf_link),

        если в методе вам не хватает каких-либо данных.


        С 23.12.2024 добавляется поле feed_name. В нём содержится название файла.


        Метод будет отключен 08.03.2027. С 08.09.2026 метод начнёт возвращать меньше данных. Подробнее читайте в [плане миграции](https://developers.avito.ru/api-catalog/autoload/documentation#migration-v4).

        '
      operationId: getReportItemsById
      parameters:
      - description: Идентификатор отчёта (ID)
        in: path
        name: report_id
        required: true
        schema:
          type: integer
      - description: 'Количество объявлений на странице: целое число больше 0 и меньше или равно 200

          '
        in: query
        name: per_page
        schema:
          default: 50
          type: integer
      - description: 'Номер страницы: целое число больше или равно 0

          '
        in: query
        name: page
        schema:
          default: 0
          type: integer
      - description: 'Фильтр по ID объявления.

          Формат значения: строка с [идентификаторами объявлений из файла](https://autoload.avito.ru/format/realty/#Id)

          или идентификаторами объявлений на Авито, перечисленными через «,» или «|».

          '
        in: query
        name: query
        schema:
          type: string
      - description: 'Фильтр объявлений по разделам. Формат значения: строка с идентификаторами разделов, перечисленными через «,» или «|».

          Получить список разделов для конкретного отчёта можно с помощью метода

          [Статистика по конкретной выгрузке](https://developers.avito.ru/api-catalog/autoload/documentation#operation/getReportByIdV3).

          '
        in: query
        name: sections
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  items:
                    description: Список объявлений
                    items:
                      $ref: '#/components/schemas/ItemInfoReportAutoloadV2'
                    type: array
                  meta:
                    $ref: '#/components/schemas/MetaReportItemsAutoloadV2'
                  report_id:
                    description: Идентификатор отчёт

# --- truncated at 32 KB (117 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/avito/refs/heads/main/openapi/avito-autoload-api-openapi.yml