Получение списка транзакций по парку
Получение списка транзакций по парку
HTTP-запрос
POST https://fleet-api.taxi.yandex.net/v2/parks/transactions/list
Заголовки запроса
Accept-Language * | string Предпочитаемый язык ответа |
X-Client-ID * | string Идентификатор клиента |
X-API-Key * | string API-ключ |
* Обязательный параметр
Тело запроса
{ "cursor": "string", "limit": 40, "query": { "park": { "id": "ee6f33c4562b4e1f8646d157bd70b2c4", "transaction": { "category_ids": [ "partner_service_recurring_payment" ], "event_at": { "from": "2019-08-08T11:58:01+03:00", "to": "2019-08-08T11:58:01+03:00" } } } } }
Скопировано
Представление
Поля
cursor | string Курсор для получения следующий порции данных, |
limit | integer Ограничение сверху на число транзакций в ответе Минимальное значение: |
query * | object |
query. | object |
query. | string Идентификатор партнёра |
query. | object |
query. | array Массив неповторяющихся идентификаторов категорий транзакций |
query. | object |
query. | string ISO 8601 с временной зоной |
query. | string ISO 8601 с временной зоной |
cursor | string Курсор для получения следующий порции данных, |
limit | integer Ограничение сверху на число транзакций в ответе Минимальное значение: |
query * | object |
query. | object |
query. | string Идентификатор партнёра |
query. | object |
query. | array Массив неповторяющихся идентификаторов категорий транзакций |
query. | object |
query. | string ISO 8601 с временной зоной |
query. | string ISO 8601 с временной зоной |
* Обязательный параметр
Ответы
Код 200
Список транзакций
{ "cursor": "", "limit": 40, "transactions": [ { "amount": "12345.1434", "category_id": "partner_service_recurring_payment", "category_name": "Платежи по расписанию", "created_by": { "dispatcher_id": "3621b3429ea04d989adf5ff4d5515d6a", "dispatcher_name": "Вася Пупкин", "identity": "dispatcher", "passport_uid": "123456789" }, "currency_code": "RUB", "description": "Списание №13", "driver_profile_id": "33de650c6a1a40bfa78dd981817da866", "event_at": "2019-08-08T11:58:01+03:00", "id": "100200400", "order_id": "c8d40acf182b4b32af72f6ad2029031b" } ] }
Скопировано
Представление
Поля
cursor * | string Курсор для получения следующий порции данных |
limit * | integer Ограничение сверху на число транзакций в ответе Минимальное значение: |
transactions[] * | array |
transactions[]. | string Сумма с фиксированной точностью |
transactions[]. | string Категория транзакции. Примеры значений:
Cписок является динамическим. Полный список категорий доступен через API /v2/parks/transactions/categories/list. |
transactions[]. | string Локализованное название категории транзакции |
transactions[]. | object |
transactions[]. | string Идентификатор диспетчера |
transactions[]. | string Имя диспетчера |
transactions[]. | string Возможные значения
|
transactions[]. | string Паспортный идентификатор пользователя |
transactions[]. | string Возможные значения
|
transactions[]. | string fleet-api client id |
transactions[]. | string Возможные значения
|
transactions[]. | string fleet-api api key id |
transactions[]. | string Возможные значения
|
transactions[]. | string |
transactions[]. | string |
transactions[]. | string Идентификатор водителя |
transactions[]. | string ISO 8601 с временной зоной |
transactions[]. | string |
transactions[]. | string Идентификатор заказа |
cursor * | string Курсор для получения следующий порции данных |
limit * | integer Ограничение сверху на число транзакций в ответе Минимальное значение: |
transactions[] * | array |
transactions[]. | string Сумма с фиксированной точностью |
transactions[]. | string Категория транзакции. Примеры значений:
Cписок является динамическим. Полный список категорий доступен через API /v2/parks/transactions/categories/list. |
transactions[]. | string Локализованное название категории транзакции |
transactions[]. | object |
transactions[]. | string Идентификатор диспетчера |
transactions[]. | string Имя диспетчера |
transactions[]. | string Возможные значения
|
transactions[]. | string Паспортный идентификатор пользователя |
transactions[]. | string Возможные значения
|
transactions[]. | string fleet-api client id |
transactions[]. | string Возможные значения
|
transactions[]. | string fleet-api api key id |
transactions[]. | string Возможные значения
|
transactions[]. | string |
transactions[]. | string |
transactions[]. | string Идентификатор водителя |
transactions[]. | string ISO 8601 с временной зоной |
transactions[]. | string |
transactions[]. | string Идентификатор заказа |
* Обязательный параметр
Код 400
Некорректные параметры запроса
{ "code": "string", "message": "Текстовое описание ошибки" }
Скопировано
Представление
Поля
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
* Обязательный параметр
Код 401
Отсутствуют параметры авторизации запроса
{ "code": "string", "message": "Текстовое описание ошибки" }
Скопировано
Представление
Поля
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
* Обязательный параметр
Код 403
Недостаточно прав для выполнения запроса
{ "code": "string", "message": "Текстовое описание ошибки" }
Скопировано
Представление
Поля
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
* Обязательный параметр
Код 429
Превышено допустимое число запросов
{ "code": "string", "message": "Текстовое описание ошибки" }
Скопировано
Представление
Поля
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
* Обязательный параметр
Код 500
Внутренняя ошибка сервера
{ "code": "string", "message": "Текстовое описание ошибки" }
Скопировано
Представление
Поля
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
* Обязательный параметр
Пример
Request:
curl -X POST "https://fleet-api.taxi.yandex.net/v2/parks/transactions/list" \ -H "Accept-Language: ru" \ -H "X-Client-ID: <Идентификатор клиента>" \ -H "X-API-Key: <API-ключ>" \ -d '{ "limit": 40, "query": { "park": { "id": "ee6f33c4562b4e1f8646d157bd70b2c4", "transaction": { "category_ids": [ "partner_service_recurring_payment" ], "event_at": { "from": "2019-08-08T11:58:01+03:00", "to": "2019-08-08T11:58:01+03:00" } } } } }'
Скопировано
Responses:
{ "cursor": "", "limit": 40, "transactions": [ { "amount": "12345.1434", "category_id": "partner_service_recurring_payment", "category_name": "Платежи по расписанию", "created_by": { "dispatcher_id": "3621b3429ea04d989adf5ff4d5515d6a", "dispatcher_name": "Вася Пупкин", "identity": "dispatcher", "passport_uid": "123456789" }, "currency_code": "RUB", "description": "Списание №13", "driver_profile_id": "33de650c6a1a40bfa78dd981817da866", "event_at": "2019-08-08T11:58:01+03:00", "id": "100200400", "order_id": "c8d40acf182b4b32af72f6ad2029031b" } ] }
Скопировано
{ "message": "Текстовое описание ошибки" }
Скопировано
{ "message": "Текстовое описание ошибки" }
Скопировано
{ "message": "Текстовое описание ошибки" }
Скопировано
{ "message": "Текстовое описание ошибки" }
Скопировано
{ "message": "Текстовое описание ошибки" }
Скопировано