Getting list of orders

Getting list of orders

Request

POST

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

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

Body

application/json
{
    "query": {
        "park": {
            "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
            "order": {
                "ids": [
                    "c8d40acf182b4b32af72f6ad2029031b"
                ],
                "short_ids": [
                    248
                ],
                "booked_at": {
                    "from": "2019-08-08T11:58:01+03:00",
                    "to": "2019-08-08T11:58:01+03:00"
                },
                "ended_at": {
                    "from": "2019-08-08T11:58:01+03:00",
                    "to": "2019-08-08T11:58:01+03:00"
                },
                "type": {
                    "ids": [
                        "4964b852670045b196e526d59915b777"
                    ]
                },
                "statuses": [
                    "complete"
                ],
                "payment_methods": [
                    "card"
                ],
                "providers": [
                    "platform"
                ],
                "categories": [
                    [
                        "econom"
                    ]
                ],
                "price": {
                    "from": "12345.1434",
                    "to": "12345.1434"
                }
            },
            "driver_profile": {
                "id": "33de650c6a1a40bfa78dd981817da866"
            },
            "car": {
                "id": "5011ade6ba054dfdb7143c8cc9460dbc"
            }
        }
    },
    "limit": 100,
    "cursor": "string"
}

Name

Description

limit*

Type: integer

Upper limit of the number of orders per response

Example: 100

Min value: 1

Max value: 500

query*

Type: OrdersListQuery

cursor

Type: string

Cursor for obtaining the next data chunk, the value must be taken from the response to the previous request

Min length: 1

OrdersListQuery

Name

Description

park*

Type: OrdersListQueryPark

OrdersListQueryPark

Name

Description

id*

Type: string

Partner ID

Example: ee6f33c4562b4e1f8646d157bd70b2c4

Min length: 1

Max length: 100

order*

Type: OrdersListQueryParkOrder

Either booked_at or ended_at is required

car

Type: OrdersListQueryParkCar

driver_profile

Type: OrdersListQueryParkDriverProfile

OrdersListQueryParkOrder

Either booked_at or ended_at is required

Name

Description

booked_at

Type: DateTimeInterval

categories

Type: string[]

List of vehicle categories. Possible values:

  • econom — Economy class;
  • comfort — Comfort;
  • comfort_plus — Comfort+;
  • business — business class vehicle;
  • minivan — minivan;
  • vip — A VIP class vehicle;
  • wagon — multi-purpose;
  • pool — pool class vehicle;
  • start — Start class vehicle;
  • standart — Standart class vehicle;
  • ultimate — Premier;
  • maybach — elite class vehicle;
  • promo — promotion;
  • premium_van — cruise van;
  • premium_suv — premium SUV;
  • suv — SUV;
  • personal_driver — personal driver class vehicle;
  • express — delivery class vehicle;
  • cargo — a cargo vehicle.

Example:

[
  "econom"
]

Enum: econom, comfort, comfort_plus, business, minivan, vip, wagon, pool, start, standart, ultimate, maybach, promo, premium_van, premium_suv, suv, personal_driver, express, cargo

ended_at

Type: DateTimeInterval

ids

Type: string[]

Order ID

Example: c8d40acf182b4b32af72f6ad2029031b

Min length: 1

Max length: 100

Min items: 1

Max items: 100

payment_methods

Type: PaymentMethod[]

Payment method. Possible values:

  • cash — cash;
  • cashless — non-cash;
  • card — card;
  • internal — internal;
  • other — other;
  • corp — corporate account;
  • prepaid — advance payment.

Example: card

Enum: cash, cashless, card, internal, other, corp, prepaid

Min items: 1

price

Type: PriceInterval

providers

Type: Provider[]

Example: platform

Enum: none, partner, platform

Min items: 1

short_ids

Type: integer[]

Index number of the order (with canceled orders taken into account)

Example: 248

Min value: 0

Min items: 1

Max items: 100

statuses

Type: OrderStatus[]

Order status. Possible values:

  • none — no status;
  • driving — en route;
  • waiting — is waiting for the client;
  • transporting — is on the ride now;
  • complete — order completed;
  • cancelled — cancelled;
  • calling — status for a technical error;
  • expired — status for a technical error;
  • failed — status for a technical error;

Example: complete

Enum: none, driving, waiting, transporting, complete, cancelled, calling, expired, failed

Min items: 1

type

Type: QueryParkOrderType

OrdersListQueryParkCar

Name

Description

id*

Type: string

Vehicle ID

Example: 5011ade6ba054dfdb7143c8cc9460dbc

Min length: 1

Max length: 100

OrdersListQueryParkDriverProfile

Name

Description

id*

Type: string

Driver ID

Example: 33de650c6a1a40bfa78dd981817da866

Min length: 1

Max length: 100

DateTimeInterval

Name

Description

from*

Type: string<date-time>

ISO 8601 with time zone

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

to*

Type: string<date-time>

ISO 8601 with time zone

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

PaymentMethod

Payment method. Possible values:

  • cash — cash;
  • cashless — non-cash;
  • card — card;
  • internal — internal;
  • other — other;
  • corp — corporate account;
  • prepaid — advance payment.

Type

Description

PaymentMethod

Example: card

Enum: cash, cashless, card, internal, other, corp, prepaid

PriceInterval

Name

Description

from

Type: string

Fixed-point sum

Example: 12345.1434

Max length: 20

to

Type: string

Fixed-point sum

Example: 12345.1434

Max length: 20

Provider

Type

Description

Provider

Example: platform

Enum: none, partner, platform

OrderStatus

Order status. Possible values:

  • none — no status;
  • driving — en route;
  • waiting — is waiting for the client;
  • transporting — is on the ride now;
  • complete — order completed;
  • cancelled — cancelled;
  • calling — status for a technical error;
  • expired — status for a technical error;
  • failed — status for a technical error;

Type

Description

OrderStatus

Example: complete

Enum: none, driving, waiting, transporting, complete, cancelled, calling, expired, failed

QueryParkOrderType

Name

Description

ids*

Type: string[]

Order type ID

Example: 4964b852670045b196e526d59915b777

Min length: 1

Min items: 1

Max items: 100

Responses

200 OK

List of orders

Body

application/json
{
    "orders": [
        {
            "id": "c8d40acf182b4b32af72f6ad2029031b",
            "short_id": 248,
            "status": "complete",
            "created_at": "2019-08-08T11:58:01+03:00",
            "booked_at": "2019-08-08T11:58:01+03:00",
            "provider": "platform",
            "category": "econom",
            "amenities": [
                [
                    "wifi"
                ]
            ],
            "address_from": {
                "address": "8 Liberty Street",
                "lat": 55.762235,
                "lon": 37.609651
            },
            "route_points": [
                {
                    "address": "8 Liberty Street",
                    "lat": 55.762235,
                    "lon": 37.609651
                }
            ],
            "events": [
                {
                    "event_at": "2019-08-08T11:58:01+03:00",
                    "order_status": "complete"
                }
            ],
            "ended_at": "2019-08-08T11:58:01+03:00",
            "payment_method": "card",
            "driver_profile": {
                "id": "33de650c6a1a40bfa78dd981817da866",
                "name": "Smith, John Richard"
            },
            "car": {
                "id": "5011ade6ba054dfdb7143c8cc9460dbc",
                "brand_model": "BMW 5er",
                "license": {
                    "number": "AA01234567"
                },
                "callsign": "123456789"
            },
            "type": {
                "id": "4964b852670045b196e526d59915b777",
                "name": "Yandex.Cashless"
            },
            "price": "12345.1434",
            "driver_work_rule": {
                "id": "e26a3cf21acfe01198d50030487e046b",
                "name": "Rental"
            },
            "mileage": "string",
            "cancellation_description": "string",
            "park_details": {
                "tariff": {
                    "id": "string",
                    "name": "string"
                },
                "passenger": {
                    "name": "string",
                    "phones": [
                        "string"
                    ]
                },
                "company": {
                    "id": "string",
                    "name": "string",
                    "slip": "string",
                    "comment": "string"
                }
            }
        }
    ],
    "limit": 100,
    "cursor": "string"
}

Name

Description

limit*

Type: integer

Upper limit of the number of orders per response

Example: 100

Min value: 1

Max value: 500

orders*

Type: Order[]

cursor

Type: string

Cursor for obtaining the next data chunk

Example: ``

Order

Name

Description

address_from*

Type: AddressInfo

amenities*

Type: string[]

Vehilce amenity. Possible values:

  • conditioner
  • no_smoking
  • child_chair
  • animal_transport
  • universal
  • wifi
  • check
  • card
  • yamoney
  • newspaper
  • coupon
  • creditcard
  • dont_call
  • smoking
  • delivery
  • vip_event
  • woman_driver
  • post_terminal
  • bicycle
  • skiing
  • passenger_plus
  • cargo_clean
  • door_to_door
  • sticker
  • lightbox

Example:

[
  "wifi"
]

Enum: conditioner, no_smoking, child_chair, animal_transport, universal, wifi, check, card, yamoney, newspaper, coupon, creditcard, dont_call, smoking, delivery, vip_event, woman_driver, post_terminal, bicycle, skiing, passenger_plus, cargo_clean, door_to_door, sticker, lightbox

booked_at*

Type: string<date-time>

ISO 8601 with time zone

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

created_at*

Type: string<date-time>

ISO 8601 with time zone

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

events*

Type: Event[]

id*

Type: string

Order ID

Example: c8d40acf182b4b32af72f6ad2029031b

Min length: 1

Max length: 100

provider*

Type: Provider

Example: platform

Enum: none, partner, platform

route_points*

Type: AddressInfo[]

short_id*

Type: integer

Index number of the order (with canceled orders taken into account)

Example: 248

Min value: 0

status*

Type: OrderStatus

Order status. Possible values:

  • none — no status;
  • driving — en route;
  • waiting — is waiting for the client;
  • transporting — is on the ride now;
  • complete — order completed;
  • cancelled — cancelled;
  • calling — status for a technical error;
  • expired — status for a technical error;
  • failed — status for a technical error;

Example: complete

Enum: none, driving, waiting, transporting, complete, cancelled, calling, expired, failed

cancellation_description

Type: string

car

Type: OrdersListCar

category

Type: Category

Vehicle category. Possible values:

  • econom — Economy class;
  • comfort — Comfort;
  • comfort_plus — Comfort+;
  • business — business class vehicle;
  • minivan — minivan;
  • vip — A VIP class vehicle;
  • wagon — multi-purpose;
  • pool — pool class vehicle;
  • start — Start class vehicle;
  • standart — Standart class vehicle;
  • child_tariff — Kids service class;
  • ultimate — Premier;
  • maybach — elite class vehicle;
  • promo — promotion;
  • premium_van — cruise van;
  • premium_suv — premium SUV;
  • suv — SUV;
  • personal_driver — personal driver class vehicle;
  • express — delivery class vehicle;
  • cargo — a cargo vehicle.

Example: econom

Enum: econom, comfort, comfort_plus, business, minivan, vip, wagon, pool, start, standart, child_tariff, ultimate, maybach, promo, premium_van, premium_suv, suv, personal_driver, express, cargo

driver_profile
Type: object

id

Type: string

Driver ID

Example: 33de650c6a1a40bfa78dd981817da866

Min length: 1

Max length: 100

name

Type: string

Driver's full name

Example: Smith, John Richard

driver_work_rule
Type: object

id

Type: string

Working condition ID of the driver

Example: e26a3cf21acfe01198d50030487e046b

name

Type: string

Working condition name of the driver

Example: Rental

Driver's working condition

ended_at

Type: string<date-time>

ISO 8601 with time zone

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

mileage

Type: string

park_details

Type: ParkDetails

payment_method

Type: PaymentMethod

Payment method. Possible values:

  • cash — cash;
  • cashless — non-cash;
  • card — card;
  • internal — internal;
  • other — other;
  • corp — corporate account;
  • prepaid — advance payment.

Example: card

Enum: cash, cashless, card, internal, other, corp, prepaid

price

Type: string

Fixed-point sum

Example: 12345.1434

Max length: 20

type

Type: OrderType

AddressInfo

Name

Description

address*

Type: string

Order address

Example: 8 Liberty Street

lat*

Type: number

Geographic latitude

Example: 55.762235

lon*

Type: number

Geographic longitude

Example: 37.609651

Event

Name

Description

event_at*

Type: string<date-time>

ISO 8601 with time zone

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

order_status*

Type: OrderStatus

Order status. Possible values:

  • none — no status;
  • driving — en route;
  • waiting — is waiting for the client;
  • transporting — is on the ride now;
  • complete — order completed;
  • cancelled — cancelled;
  • calling — status for a technical error;
  • expired — status for a technical error;
  • failed — status for a technical error;

Example: complete

Enum: none, driving, waiting, transporting, complete, cancelled, calling, expired, failed

OrdersListCar

Name

Description

brand_model

Type: string

Vehicle make and model

Example: BMW 5er

callsign

Type: string

Vehicle code name (short name)

Example: 123456789

id

Type: string

Vehicle ID

Example: 5011ade6ba054dfdb7143c8cc9460dbc

Min length: 1

Max length: 100

license

Type: License

Category

Vehicle category. Possible values:

  • econom — Economy class;
  • comfort — Comfort;
  • comfort_plus — Comfort+;
  • business — business class vehicle;
  • minivan — minivan;
  • vip — A VIP class vehicle;
  • wagon — multi-purpose;
  • pool — pool class vehicle;
  • start — Start class vehicle;
  • standart — Standart class vehicle;
  • child_tariff — Kids service class;
  • ultimate — Premier;
  • maybach — elite class vehicle;
  • promo — promotion;
  • premium_van — cruise van;
  • premium_suv — premium SUV;
  • suv — SUV;
  • personal_driver — personal driver class vehicle;
  • express — delivery class vehicle;
  • cargo — a cargo vehicle.

Type

Description

Category

Example: econom

Enum: econom, comfort, comfort_plus, business, minivan, vip, wagon, pool, start, standart, child_tariff, ultimate, maybach, promo, premium_van, premium_suv, suv, personal_driver, express, cargo

ParkDetails

Name

Description

company

Type: Company

passenger

Type: Passenger

tariff

Type: OrderTariff

Taxi company's service classes

OrderType

Name

Description

id*

Type: string

Order type ID

Example: 4964b852670045b196e526d59915b777

Min length: 1

name*

Type: string

Order type name

Example: Yandex.Cashless

License

Name

Description

number*

Type: string

Vehicle registration number

Example: AA01234567

Company

Name

Description

comment

Type: string

id

Type: string

name

Type: string

slip

Type: string

Passenger

Name

Description

name

Type: string

phones

Type: string[]

Min length: 1

Min items: 1

Max items: 3

OrderTariff

Taxi company's service classes

Name

Description

id*

Type: string

name*

Type: string

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 work rules
Next
Getting order track