POST /carfax/orders/create

Создает заказ и возвращает уникальный идентификатор заказа.

Важно

Каждый вызов создания заказа независим от всех других и оплачивается отдельно. Если нужно обновить данные для какого-то VIN, создайте новый заказ.

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

POST https://apiauto.ru/1.0/carfax/orders/create

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

{
  "report_type": {string},
  "identifier_type": {string},
  "identifier": {string}
}

`report_type`	Для отчета всегда равен `FULL_REPORT`.
`identifier_type`	Для отчета всегда равен `VIN`, `LICENSE_PLATE` или `AUTORU_OFFER_ID`.
`identifier`	VIN, ГРЗ (госномер) или идентификатор объявления Авто.ру, для которого нужно сгенерировать отчет.

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

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

{
  "id": {string},
  "status": {string},
  "identifier_type": {string},
  "identifier": {string},
  "report_type": {string},
  "vin": {string}
}

`id`	Уникальный идентификатор заказа.
`status`	Статус заказа. Возможные значения: `PREPARING` — заказ находится в процессе обработки, данные отчета пока не доступны. `UNTRUSTED` — в ГИБДД не найдена информация по автомобилю. `FAILED` — подробности ошибки в поле `error`: `UNKNOWN_ERROR` — неизвестная ошибка; `PAYMENT_FAILED` — оплата заказа завершилась ошибкой; `INVALID_IDENTIFIER` — неверный идентификатор (недопустимый VIN, ГРЗ или `offer_id`); `IDENTIFIER_NOT_FOUND` — не смогли найти VIN по ГРЗ или `id` объявления; `NOT_SUPPORTED_IDENTIFIER_TYPE` — для выбранного типа отчета нельзя получить отчет по указанном идентификатору; `NOT_SUPPORTED_REPORT_TYPE` — неизвестный тип отчета; `REPORT_NOT_AVAILABLE` — отчет недоступен для продажи. `UPDATING` — оплата заказа прошла успешно, источники данных начали опрашиваться, данные могут быть уже частично доступны. `SUCCESS` — заказ успешно завершен и больше не будет обновляться.
`identifier_type`	Тип идентификатора из запроса.
`identifier`	Идентификатор из запроса.
`report_type`	FULL_REPORT.
`vin`	VIN к которому привязан отчет. Может отсутствовать для статусов FAILED, PREPARING.

Коды ответа

Код	Причина	Описание
200	OK	Успешный запрос.
400	BAD_REQUEST	Синтаксическая ошибка в запросе.
401	NO_AUTH	Не удалось авторизовать пользователя по переданным данным.
403	CODE_AUTH_REQUIRED PASSWORD_EXPIRED	Не удается аутентифицироваться.

Примеры

Ответ для кода 400 (неверный формат запроса)

Запрос:

curl -i -X GET 'https://apiauto.ru/1.0/carfax/orders/result?order_id=8486a639-0a21-49d3-a906-3f877b8a1e99'

Ответ:

HTTP/1.1 200 OK
Server: envoy
Date: Wed,27 Aug 2025 17:08:12 GMT
Content-Type: application/json
Connection: keep-alive

{
  "error": "INVALID_REQUEST",
  "detailed_error": "Invalid VIN: abc"
}

Успешный ответ создания заказа

Запрос:

curl -i -X GET 'https://apiauto.ru/1.0/carfax/orders/result?order_id=213'

Ответ:

HTTP/1.1 200 OK
Server: envoy
Date: Wed,27 Aug 2025 17:08:12 GMT
Content-Type: application/json
Connection: keep-alive

{
  "order": {
    "id": "a5f9cbd3-48a7-4403-908b-153c90781c16",
    "status": "PREPARING",
    "identifier_type": "VIN",
    "identifier": "Z94CU41CBBR048898",
    "report_type": "FULL_REPORT"
  }
}

Была ли статья полезна?

Отчеты

GET /carfax/orders/result