List of regions available for hiring Eats couriers
List of regions available for hiring Eats couriers. Region filtering takes into account the employment type and the park's country
Request
POST
https://fleet-api.taxi.yandex.net/v1/eats/regions/list
Headers
|
Name |
Description |
|
Accept-Language |
Type: string Preferred language of the response Min length: Example: |
|
X-API-Key |
Type: string API-key Min length: Example: |
|
X-Client-ID |
Type: string Client ID Min length: Example: |
|
X-Park-ID |
Type: string Partner ID Example: |
Body
application/json
{
"limit": 100,
"cursor": "example",
"region_name_prefix": " Mos ",
"employment_type": "park_direct"
}
|
Name |
Description |
|
employment_type |
Type: string Employment type. Can be park_direct (park direct staff) or courier_service (courier service employee in Fleet terms) Enum: |
|
limit |
Type: integer Number of regions to return Min value: Max value: |
|
cursor |
Type: string Cursor from which the next regions should be returned. To get the next batch of regions, specify the cursor received in the response to the previous request Example: |
|
region_name_prefix |
Type: string Region name prefix for filtering. Regions whose name starts with the specified prefix will be returned in the response Example: |
Responses
200 OK
List of regions where Eats hiring is open
Body
application/json
{
"regions": [
{
"geobase_id": 1,
"name": "Moscow"
}
],
"next_cursor": "example"
}
|
Name |
Description |
|
regions |
Type: Region[] List of regions where Eats hiring is open. Regions are sorted by the 'name' field Example |
|
next_cursor |
Type: string Cursor for getting the next batch of regions. A null value means the list has been fully read Example: |
Region
|
Name |
Description |
|
geobase_id |
Type: integer Region identifier in the geobase |
|
name |
Type: string Localized region name Example: |
Example
{
"geobase_id": 1,
"name": "Moscow"
}
400 Bad Request
Invalid request parameters
Body
application/json
{
"code": "example",
"message": "Textual description of the error"
}
|
Name |
Description |
|
message |
Type: string Human-readable error message Example: |
|
code |
Type: string Machine-readable error code Example: |
422 Unprocessable Entity
Invalid request parameters
Body
application/json
{
"code": "example",
"message": "Textual description of the error"
}
|
Name |
Description |
|
message |
Type: string Human-readable error message Example: |
|
code |
Type: string Machine-readable error code Example: |