Getting list of vehicle applications from garage

Getting list of vehicle rental applications from garage with pagination

Request

GET

https://fleet-api.taxi.yandex.net/v1/parks/vehicles/applications/list

Query parameters

Name

Description

cursor

Type: string

Cursor for obtaining the next data chunk

Example: eyJsZWFkX2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDAwIn0=

limit

Type: integer

Limit of elements in response

Default: 100

Example: 100

Min value: 1

Max value: 100

Headers

Name

Description

X-API-Key*

Type: string

API-key

Example: <API key>

Min length: 1

X-Client-ID*

Type: string

Client ID

Example: <Client ID>

Min length: 1

X-Park-ID*

Type: string

Partner ID

Example: ee6f33c4562b4e1f8646d157bd70b2c4

Responses

200 OK

List of vehicle applications

Body

application/json
{
    "items": [
        {
            "lead_id": "550e8400-e29b-41d4-a716-446655440000",
            "driver_id": "33de650c6a1a40bfa78dd981817da866",
            "phone_pd_id": "1a2b3c4d5e6f7g8h9i0j",
            "park_id": "ee6f33c4562b4e1f8646d157bd70b2c4",
            "vehicle_id": "5011ade6ba054dfdb7143c8cc9460dbc",
            "rule_revision_id": "rev_20231215_001",
            "region_id": "213",
            "posting_id": "posting_12345678",
            "schema": {
                "price": "1500.0000",
                "working_days": 6,
                "non_working_days": 1
            },
            "application_id": "app_2023_12345",
            "client_id": "client_garage",
            "is_multibooking_enabled": true,
            "is_created_by_phonecall": false,
            "source": "yandex_garage",
            "external_lead_id": "ext_lead_987654321",
            "car_tariff": "econom",
            "booking_type": "rent",
            "selfreg_campaign_id": "550e8400-e29b-41d4-a716-446655440000",
            "created_at": "2023-12-15T09:00:00+03:00",
            "updated_at": "2023-12-15T14:30:00+03:00",
            "request_to_change_car_completed_at": "2023-12-16T10:15:30+03:00"
        }
    ],
    "cursor": "eyJsZWFkX2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDAwIn0="
}

Name

Description

items*

Type: VehicleApplicationItem[]

List of applications

cursor

Type: string

Cursor for next page

Example: eyJsZWFkX2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDAwIn0=

VehicleApplicationItem

Name

Description

lead_id*

Type: string<uuid>

Application ID

Example: 550e8400-e29b-41d4-a716-446655440000

park_id*

Type: string

Park ID

Example: ee6f33c4562b4e1f8646d157bd70b2c4

phone_pd_id*

Type: string

Phone ID (personal data)

Example: 1a2b3c4d5e6f7g8h9i0j

rule_revision_id*

Type: string

Rent rule revision ID

Example: rev_20231215_001

vehicle_id*

Type: string

Vehicle ID

Example: 5011ade6ba054dfdb7143c8cc9460dbc

application_id

Type: string

External application ID

Example: app_2023_12345

booking_type

Type: string

Booking type

Example: rent

car_tariff

Type: string

Car tariff

Example: econom

client_id

Type: string

Client ID

Example: client_garage

created_at

Type: string<date-time>

Application creation date and time

Example: 2023-12-15T09:00:00+03:00

driver_id

Type: string

Driver ID

Example: 33de650c6a1a40bfa78dd981817da866

external_lead_id

Type: string

External lead ID

Example: ext_lead_987654321

is_created_by_phonecall

Type: boolean

Is created by phone call

Example: false

is_multibooking_enabled

Type: boolean

Is multibooking enabled

Example: true

posting_id

Type: string

Posting ID

Example: posting_12345678

region_id

Type: string

Region ID

Example: 213

request_to_change_car_completed_at

Type: string<date-time>

Date and time when request to change car was completed

Example: 2023-12-16T10:15:30+03:00

schema
Type: object

non_working_days

Type: integer

Number of days when the car is NOT rented

Example: 1

price

Type: string

Daily rental price

Example: 1500.0000

Pattern: ^[0-9]+(\.[0-9]{1,4})?$

working_days

Type: integer

Number of days when the car is rented

Example: 6

Rental scheme

selfreg_campaign_id

Type: string<uuid>

Self-registration campaign ID

Example: 550e8400-e29b-41d4-a716-446655440000

source

Type: string

Application source

Example: yandex_garage

updated_at

Type: string<date-time>

Application update date and time

Example: 2023-12-15T14:30:00+03:00

400 Bad Request

Invalid request parameters

Body

application/json
{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

401 Unauthorized

Request authorization parameters are missing

Body

application/json
{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

403 Forbidden

Insufficient rights to execute the request

Body

application/json
{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

429 Too Many Requests

Limit of requests was exceeded

Body

application/json
{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

500 Internal Server Error

Internal server error

Body

application/json
{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

No longer supported, please use an alternative and newer version.

Previous
Getting list of cars
Next
Change the rental term associated with the car