Создание профиля курьера Еды и Платформы

Request

POST

https://fleet-api.taxi.yandex.net/v1/performer/create

Headers

Name	Description
Accept-Language	Type: string Предпочитаемый язык ответа Min length: `2` Example: `ru`
X-API-Key	Type: string API-ключ Min length: `1` Example: `<API-ключ>`
X-Client-ID	Type: string Идентификатор клиента Min length: `1` Example: `<Идентификатор клиента>`
X-Idempotency-Token	Type: string Токен идемпотентности запроса. Должен состоять только из печатных ASCII символов Min length: `16` Max length: `64` Example: `c56fa6537e5a4adbbce6ef3593210fb9`
X-Park-ID	Type: string Идентификатор партнера Example: `ee6f33c4562b4e1f8646d157bd70b2c4`

Body

application/json

{
  "last_name": " Иванов ",
  "first_name": " Иван ",
  "middle_name": " Иванович ",
  "phone": "+79999999999",
  "region_geobase_id": 1,
  "birth_date": "1990-01-01",
  "registration_address": " ул. Мира, д. 1 ",
  "instant_payments_id": "550e8400-e29b-41d4-a716-446655440000",
  "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e",
  "citizenship_code2": "RU",
  "employment_type": "park_direct",
  "tax_identification_number": "1234567890"
}

Name	Description
birth_date	Type: string<date> Дата рождения Example: `1990-01-01`
first_name	Type: string Имя Min length: `1` Example: `Иван`
last_name	Type: string Фамилия Min length: `1` Example: `Иванов`
phone	Type: string Номер телефона; для РФ - должен быть зарегистрирован в Моём налоге Min length: `1` Example: `+79999999999`
region_geobase_id	Type: integer Идентификатор города в иерархии geobase
citizenship_code2	Type: string Код страны в формате ISO 3166-1 alpha-2 Pattern: `^[A-Z]{2}$` Example: `RU`
employment_type	Type: string Тип занятости. Может быть park_direct (ПСМЗ) или courier_service (Парковый исполнитель в терминах Fleet) Enum: `park_direct`, `courier_service`
instant_payments_id	Type: string<uuid> Идентификатор правила моментальных выплат, назначаемого курьеру. Если не указан, применяется правило по умолчанию, настроенное для партнёра, при его наличии Example: `550e8400-e29b-41d4-a716-446655440000`
middle_name	Type: string Отчество Min length: `1` Example: `Иванович`
registration_address	Type: string Адрес регистрации. Обязателен для РФ или при employment_type = park_direct в Казахстане Min length: `1` Example: `ул. Мира, д. 1`
tax_identification_number	Type: string Налоговый идентификатор курьера в стране регистрации: ИНН, ИИН, ПИНФЛ или ПИН. Обязательность зависит от страны и типа занятости Min length: `1` Example: `1234567890`
work_rule_id	Type: string Идентификатор условия работы, назначаемого курьеру. Значение можно получить методом получения списка условий работы партнёра Min length: `1` Example: `bc43tre6ba054dfdb7143ckfgvcby63e`

Responses

200 OK

Данные созданного профиля

Body

application/json

{
  "park_id": "ee6f33c4562b4e1f8646d157bd70b2c4",
  "contractor_id": "9b17db0cb1f24a38a5c3c8b4f6e4f63b",
  "polling_settings": {
    "polling_interval_ms": 0,
    "polling_timeout_sec": 0
  }
}

Name

Description

contractor_id

Type: string

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

Example: 9b17db0cb1f24a38a5c3c8b4f6e4f63b

park_id

Type: string

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

Example: ee6f33c4562b4e1f8646d157bd70b2c4

polling_settings

Type: object

polling_interval_ms

Type: integer

Частота вызова ручки проверки создания профиля

Min value: 0

polling_timeout_sec

Type: integer

Общий таймаут на поллинг ручки проверки создания профиля

Min value: 0

Настройки для поллинга

Example

{
  "polling_interval_ms": 0,
  "polling_timeout_sec": 0
}

400 Bad Request

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

Body

application/json

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

422 Unprocessable Entity

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

Body

application/json

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

Была ли статья полезна?

Получение списка заявок исполнителей из гаража

Статус готовности профиля курьера Еды