POST /user/offers/{category}/auction/leave

Выводит набор объявлений из аукциона.

Формат запроса

POST https://apiauto.ru/1.0/user/offers/{category}/auction/leave
? [page=<integer>]
& [page_size=<integer>]
& [truck_category=<string>]
& [moto_category=<string>]
& [status=<array[string]>]
& service=<array[string]>
& [vin=<array[string]>]
& [mark_model=<array[string]>]
& [price_from=<integer>]
& [price_to=<integer>]
& [section=<string>]
& [create_date_from=<string>]
& [no_active_services=<boolean>]
& [ban_reason=<array[string]>]
& [sort=<string>]
& [auction=<boolean>]

category

Название категории ТС.

Допустимые значения:
  • cars — легковые автомобили;
  • moto — мототранспорт;
  • trucks — коммерческий транспорт;
  • all — все категории ТС.

page

Вывести результаты, начиная с указанной страницы. Страницы нумеруются с единицы (1). Допустимые значения: от 1 до 1000.

page_size

Количество объявлений на странице.

Ограничение

Максимальное допустимое значение — 100 объявлений на страницу. При превышении этого значения доступ к API будет ограничен. Подробнее можно узнать в разделе Ограничения по использованию ресурсов API.

truck_category

Категория коммерческого транспорта.

Допустимые значения:

  • TRUCK — грузовик;

  • LCV — легкий коммерческий транспорт;

  • TRAILER — прицеп;

  • SWAP_BODY — съемный кузов;

  • BUS — автобус;

  • ARTIC — седельный тягач;

  • AGRICULTURAL — сельскохозяйственная;

  • CONSTRUCTION — строительная;

  • AUTOLOADER — автопогрузчик;

  • CRANE — автокран;

  • DREDGE — экскаватор;

  • BULLDOZERS — бульдозер;

  • CRANE_HYDRAULICS — самопогрузчик;

  • MUNICIPAL — коммунальная.

moto_category

Категория мототранспорта.

Допустимые значения:

  • ATV — мотовездеход;

  • MOTORCYCLE — мотоцикл;

  • SCOOTERS — скутер;

  • SNOWMOBILE — снегоход.

status

Статус объявления.

Допустимые значения:

  • active — объявление активно;

  • inactive — объявление неактивно;

  • banned — объявление заблокировано.

Примечание

Если вы хотите добавить больше одного значения, укажите параметр несколько раз:

status=active&status=banned

service

Подключенные услуги.

Допустимые значения:

  • all_sale_fresh — поднятие объявления в поиске;

  • all_sale_premium — премиум;

  • all_sale_special — спецпредложение;

  • package_turbo — турбо-продажа;

  • reset — обнуление.

Примечание

Если вы хотите добавить больше одного значения, укажите параметр несколько раз:

service=all_sale_special&service=all_sale_premium

vin

VIN-номера.

Примечание

Если вы хотите добавить больше одного значения, укажите параметр несколько раз:

vin=skedeP0iddddA0111&vin=sewqfP0irtyuA0222

mark_model

Идентификаторы марки и модели, разделенные закодированным символом «#» (%23), например «MERCEDES%23C_KLASSE». Идентификатор модели может отсутствовать.

Примечание

Если вы хотите добавить больше одного значения, укажите параметр несколько раз:

mark_model=MERCEDES%23C_KLASSE&mark_model=HONDA

price_from

Стоимость транспорта в выбранной валюте (например, российский рубль), от.

price_to

Стоимость транспорта в выбранной валюте (например, российский рубль), до.

section

Состояние транспортного средства.

Допустимые значения:
  • NEW — новое транспортное средство;
  • USED — транспортное средство с пробегом (б/у).

create_date_from

Дата создания объявления в формате ISO 8601 со смещением относительно UTC. Например, 2017-07-08T11:29:16+03:00, от. Необходимо закодировать символы: «:» — «%3A», «+» — «%2B».

create_date_to

Дата создания объявления в формате ISO 8601 со смещением относительно UTC. Например, 2017-07-08T11:29:16+03:00, до. Необходимо закодировать символы: «:» — «%3A», «+» — «%2B».

no_active_services

Фильтр. Показывает объявления без примененных услуг.

ban_reason

Причина блокировки объявления. Подробнее с описанием причин блокировки можно ознакомиться в Справочнике причин блокировки.

sort

Тип сортировки объявлений.

Допустимые значения:

  • alphabet-asc — по названию (с начала алфавита);

  • alphabet-desc — по названию (с конца алфавита);

  • cr_date-asc — по дате создания, в порядке возрастания. Является значением по умолчанию;

  • cr_date-desc — по дате создания, в порядке убывания;

  • fresh_relevance_1-desc — по актуальности;

  • km_age-asc — по пробегу, в порядке возрастания;

  • km_age-desc — по пробегу, в порядке убывания;

  • price-asc — по цене, в порядке возрастания;

  • price-desc — по цене, в порядке убывания;

  • year-asc — по году, в порядке возрастания;

  • year-desc — по году, в порядке убывания.

auction

Фильтр. Показывает объявления, участвующие в аукционе.

Заголовки запроса

Заголовок

Описание

x-dealer-id

Идентификатор клиента. Используется для работы под учетной записью агентства.

x-session-id

Идентификатор сессии пользователя. Значение можно получить с помощью операции POST /auth/login.

Общая структура ответа приведена ниже. Порядок следования элементов не гарантируется. В структуре могут присутствовать служебные параметры, которые не описаны в таблице.

Формат ответа

{
  "status": {string}
}

status

Статус ответа.

Коды ответа

Код

Причина

Описание

200

OK

Успешный запрос.

401

NO_AUTH

Не удалось авторизовать пользователя по переданным данным.

403

AGENT_ACCESS_FORBIDDEN

Доступ для данного пользователя запрещен.

500

INTERNAL SERVER ERROR
UNKNOWN_ERROR

Внутренняя ошибка сервера.

Пример

Запрос:

curl -X POST
--header 'x-session-id: 14090654|1622...' 
--header 'x-dealer-id: 16269' 
'https://apiauto.ru/1.0/user/offers/{category}/auction/leave '

Ответ:

{
  "status": "SUCCESS"
}

Вывести результаты, начиная с указанной страницы. Страницы нумеруются с единицы (1). Допустимые значения: от 1 до 1000.

Категория коммерческого транспорта.

Допустимые значения:

  • TRUCK — грузовик;

  • LCV — легкий коммерческий транспорт;

  • TRAILER — прицеп;

  • SWAP_BODY — съемный кузов;

  • BUS — автобус;

  • ARTIC — седельный тягач;

  • AGRICULTURAL — сельскохозяйственная;

  • CONSTRUCTION — строительная;

  • AUTOLOADER — автопогрузчик;

  • CRANE — автокран;

  • DREDGE — экскаватор;

  • BULLDOZERS — бульдозер;

  • CRANE_HYDRAULICS — самопогрузчик;

  • MUNICIPAL — коммунальная.

Количество объявлений на странице.

Ограничение

Максимальное допустимое значение — 100 объявлений на страницу. При превышении этого значения доступ к API будет ограничен. Подробнее можно узнать в разделе Ограничения по использованию ресурсов API.

Название категории ТС. Допустимые значения:

Категория мототранспорта.

Допустимые значения:

  • ATV — мотовездеход;

  • MOTORCYCLE — мотоцикл;

  • SCOOTERS — скутер;

  • SNOWMOBILE — снегоход.

Статус объявления.

Допустимые значения:

  • active — объявление активно;

  • inactive — объявление неактивно;

  • banned — объявление заблокировано.

Примечание

Если вы хотите добавить больше одного значения, укажите параметр несколько раз:

status=active&status=banned

Подключенные услуги.

Допустимые значения:

  • all_sale_fresh — поднятие объявления в поиске;

  • all_sale_premium — премиум;

  • all_sale_special — спецпредложение;

  • package_turbo — турбо-продажа;

  • reset — обнуление.

Примечание

Если вы хотите добавить больше одного значения, укажите параметр несколько раз:

service=all_sale_special&service=all_sale_premium

VIN-номера.

Примечание

Если вы хотите добавить больше одного значения, укажите параметр несколько раз:

vin=skedeP0iddddA0111&vin=sewqfP0irtyuA0222

Идентификаторы марки и модели, разделенные закодированным символом «#» (%23), например «MERCEDES%23C_KLASSE». Идентификатор модели может отсутствовать.

Примечание

Если вы хотите добавить больше одного значения, укажите параметр несколько раз:

mark_model=MERCEDES%23C_KLASSE&mark_model=HONDA

Стоимость транспорта в выбранной валюте (например, российский рубль), от.

Стоимость транспорта в выбранной валюте (например, российский рубль), до.

Состояние транспортного средства.

Допустимые значения:
  • NEW — новое транспортное средство;
  • USED — транспортное средство с пробегом (б/у).

Дата создания объявления в формате ISO 8601 со смещением относительно UTC. Например, 2017-07-08T11:29:16+03:00, от. Необходимо закодировать символы: «:» — «%3A», «+» — «%2B».

Фильтр. Показывает объявления без примененных услуг.

Причина блокировки объявления. Подробнее с описанием причин блокировки можно ознакомиться в Справочнике причин блокировки.

Тип сортировки объявлений.

Допустимые значения:
  • alphabet-asc — по названию (с начала алфавита);
  • alphabet-desc — по названию (с конца алфавита);
  • cr_date-asc — по дате создания, в порядке возрастания. Является значением по умолчанию;
  • cr_date-desc — по дате создания, в порядке убывания;
  • fresh_relevance_1-desc — по актуальности;
  • km_age-asc — по пробегу, в порядке возрастания;
  • km_age-desc — по пробегу, в порядке убывания;
  • price-asc — по цене, в порядке возрастания;
  • price-desc — по цене, в порядке убывания;
  • year-asc — по году, в порядке возрастания;
  • year-desc — по году, в порядке убывания.

Фильтр. Показывает объявления, участвующие в аукционе.

Предыдущая
POST /dealer/auction/offer/{offer id}/leave
Следующая
GET /dealer/auction/offer/{offer id}/current state