Список регионов, доступных для найма курьеров Еды
Список регионов, доступных для найма курьеров Еды. При фильтрации регионов учитывается тип занятости и страна парка
Request
POST
https://fleet-api.taxi.yandex.net/v1/eats/regions/list
Headers
|
Name |
Description |
|
Accept-Language |
Type: string Предпочитаемый язык ответа Min length: Example: |
|
X-API-Key |
Type: string API-ключ Min length: Example: |
|
X-Client-ID |
Type: string Идентификатор клиента Min length: Example: |
|
X-Park-ID |
Type: string Идентификатор партнера Example: |
Body
application/json
{
"limit": 100,
"cursor": "example",
"region_name_prefix": " Мос ",
"employment_type": "park_direct"
}
|
Name |
Description |
|
employment_type |
Type: string Тип занятости. Может быть park_direct (ПСМЗ) или courier_service (Парковый исполнитель в терминах Fleet) Enum: |
|
limit |
Type: integer Количество регионов, которые нужно вернуть Min value: Max value: |
|
cursor |
Type: string Курсор, начиная с которого нужно вернуть следующие регионы. Для получения следующей пачки регионов необходимо указать курсор, полученный в ответе на предыдущий запрос Example: |
|
region_name_prefix |
Type: string Префикс названия региона для фильтрации. Регионы, название которых начинается с указанного префикса, будут возвращены в ответе Example: |
Responses
200 OK
Список регионов, в которых открыт найм Еды
Body
application/json
{
"regions": [
{
"geobase_id": 1,
"name": "Moscow"
}
],
"next_cursor": "example"
}
|
Name |
Description |
|
regions |
Type: Region[] Список регионов, в которых открыт найм Еды. Регионы отсортированы по полю 'name' Example |
|
next_cursor |
Type: string Курсор для получения следующей выборки регионов. Значение null означает, что список полностью прочитан Example: |
Region
|
Name |
Description |
|
geobase_id |
Type: integer Идентификатор региона в геобазе |
|
name |
Type: string Локализованное название региона Example: |
Example
{
"geobase_id": 1,
"name": "Moscow"
}
400 Bad Request
Некорректные параметры запроса
Body
application/json
{
"code": "example",
"message": "Текстовое описание ошибки"
}
|
Name |
Description |
|
message |
Type: string Человекочитаемое сообщение об ошибке Example: |
|
code |
Type: string Машиночитаемый код ошибки Example: |
422 Unprocessable Entity
Некорректные параметры запроса
Body
application/json
{
"code": "example",
"message": "Текстовое описание ошибки"
}
|
Name |
Description |
|
message |
Type: string Человекочитаемое сообщение об ошибке Example: |
|
code |
Type: string Машиночитаемый код ошибки Example: |