Получение списка транзакций по заказам

Получение списка транзакций по заказам

Request

POST

https://fleet-api.taxi.yandex.net/v2/parks/orders/transactions/list

Headers

Name

Description

Accept-Language*

Type: string

Предпочитаемый язык ответа

Example: ru

Min length: 2

X-API-Key*

Type: string

API-ключ

Example: <API-ключ>

Min length: 1

X-Client-ID*

Type: string

Идентификатор клиента

Example: <Идентификатор клиента>

Min length: 1

Body

application/json
{
    "query": {
        "park": {
            "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
            "order": {
                "ids": [
                    "c8d40acf182b4b32af72f6ad2029031b"
                ]
            },
            "transaction": {
                "event_at": {
                    "from": "2019-08-08T11:58:01+03:00",
                    "to": "2019-08-08T11:58:01+03:00"
                }
            }
        }
    }
}

Name

Description

query*

Type: ParksOrdersTransactionsListQuery

ParksOrdersTransactionsListQuery

Name

Description

park*

Type: ParksOrdersTransactionsListQueryPark

ParksOrdersTransactionsListQueryPark

Name

Description

id*

Type: string

Идентификатор партнёра

Example: ee6f33c4562b4e1f8646d157bd70b2c4

Min length: 1

Max length: 100

order*

Type: ParksOrdersTransactionsListQueryParkOrder

transaction

Type: ParksOrdersTransactionsListQueryParkTransaction

ParksOrdersTransactionsListQueryParkOrder

Name

Description

ids*

Type: string[]

Идентификатор заказа

Example: c8d40acf182b4b32af72f6ad2029031b

Min length: 1

Max length: 100

Min items: 1

Max items: 100

ParksOrdersTransactionsListQueryParkTransaction

Name

Description

event_at

Type: DateTimeOptionalInterval

DateTimeOptionalInterval

Name

Description

from

Type: string<date-time>

ISO 8601 с временной зоной

Example: 2019-08-08T11:58:01+03:00

to

Type: string<date-time>

ISO 8601 с временной зоной

Example: 2019-08-08T11:58:01+03:00

Responses

200 OK

Список транзакций по заказу

Body

application/json
{
    "transactions": [
        {
            "id": "100200400",
            "event_at": "2019-08-08T11:58:01+03:00",
            "category_id": "partner_service_manual",
            "category_name": "Платежи по расписанию",
            "amount": "12345.1434",
            "currency_code": "RUB",
            "description": "Списание №13",
            "created_by": {
                "identity": "dispatcher",
                "passport_uid": "123456789",
                "dispatcher_id": "3621b3429ea04d989adf5ff4d5515d6a",
                "dispatcher_name": "Вася Пупкин"
            },
            "driver_profile_id": "33de650c6a1a40bfa78dd981817da866",
            "order_id": "c8d40acf182b4b32af72f6ad2029031b"
        }
    ]
}

Name

Description

transactions*

Type: Transaction[]

Transaction

Name

Description

amount*

Type: string

Сумма с фиксированной точностью

Example: 12345.1434

Max length: 20

category_id*

Type: string

Категория транзакции. Допустимые значения можно получить через API /v2/parks/transactions/categories/list.

Example: partner_service_manual

Min length: 1

Max length: 100

category_name*

Type: string

Локализованное название категории транзакции

Example: Платежи по расписанию

Min length: 1

Max length: 100

created_by*

Type: TransactionCreatedByDispatcher or TransactionCreatedByTechSupport or TransactionCreatedByFleetAPI or TransactionCreatedByPlatform

currency_code*

Type: string

Example: RUB

description*

Type: string

Example: Списание №13

event_at*

Type: string<date-time>

ISO 8601 с временной зоной

Example: 2019-08-08T11:58:01+03:00

id*

Type: string

Example: 100200400

Min length: 1

Max length: 100

driver_profile_id

Type: string

Идентификатор водителя

Example: 33de650c6a1a40bfa78dd981817da866

Min length: 1

Max length: 100

order_id

Type: string

Идентификатор заказа

Example: c8d40acf182b4b32af72f6ad2029031b

Min length: 1

Max length: 100

TransactionCreatedByDispatcher

Name

Description

dispatcher_id*

Type: string

Идентификатор диспетчера

Example: 3621b3429ea04d989adf5ff4d5515d6a

dispatcher_name*

Type: string

Имя диспетчера

Example: Вася Пупкин

identity*

Type: string

Example: dispatcher

Enum: dispatcher

passport_uid*

Type: string

Паспортный идентификатор пользователя

Example: 123456789

TransactionCreatedByTechSupport

Name

Description

identity*

Type: string

Example: tech-support

Enum: tech-support

TransactionCreatedByFleetAPI

Name

Description

client_id*

Type: string

fleet-api client id

Example: taxi/park/abc123

identity*

Type: string

Example: fleet-api

Enum: fleet-api

key_id*

Type: string

fleet-api api key id

Example: 521

TransactionCreatedByPlatform

Name

Description

identity*

Type: string

Example: platform

Enum: platform

400 Bad Request

Некорректные параметры запроса

Body

application/json
{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

401 Unauthorized

Отсутствуют параметры авторизации запроса

Body

application/json
{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

403 Forbidden

Недостаточно прав для выполнения запроса

Body

application/json
{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

429 Too Many Requests

Превышено допустимое число запросов

Body

application/json
{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

500 Internal Server Error

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

Body

application/json
{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки
Предыдущая
Получение списка транзакций по водителю (курьеру)
Следующая
Получение списка категорий транзакций