Получает нанятого курьера

  1. HTTP-запрос
  2. Path-параметры
  3. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 401
    3. Код 403
    4. Код 404
    5. Код 422
    6. Код 504

Возвращает информацию о нанятом курьере по его ID.

HTTP-запрос

GET https://courier.yandex.ru/api/v1/companies/{company_id}/rented-couriers/{rented_courier_id}

Path-параметры

company_id *

integer

ID компании, используемый в запросах к API Мониторинга.

rented_courier_id *

string

ID нанятого курьера. Используется в объектах типа Route для трекинга в сторонних системах.

company_id *

integer

ID компании, используемый в запросах к API Мониторинга.

rented_courier_id *

string

ID нанятого курьера. Используется в объектах типа Route для трекинга в сторонних системах.

Ответы

Код 200

Информация о нанятом курьере получена.

{
  "company_id": integer,
  "created_at": string,
  "id": string,
  "order_id": string,
  "provider": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

company_id

integer

ID компании, используемый в запросах к API Мониторинга.

created_at

string

Дата и время создания объекта нанятого курьера.

id

string

ID нанятого курьера. Используется в объектах типа Route для отслеживания в сторонних системах.

order_id *

string

Идентификатор заказа у поставщика услуг.

provider *

string

Идентификатор поставщика услуг. Допустимые значения: yandex_taxi_cargo.

company_id

integer

ID компании, используемый в запросах к API Мониторинга.

created_at

string

Дата и время создания объекта нанятого курьера.

id

string

ID нанятого курьера. Используется в объектах типа Route для отслеживания в сторонних системах.

order_id *

string

Идентификатор заказа у поставщика услуг.

provider *

string

Идентификатор поставщика услуг. Допустимые значения: yandex_taxi_cargo.

Код 401

Ошибка авторизации. Убедитесь, что заголовок запроса содержит правильный OAuth-токен.

Код 403

Ошибка доступа к объекту. У пользователя недостаточно прав для доступа к объекту.

Код 404

Ошибка поиска объекта. Объект не найден.

Код 422

Неверный ввод. Операция не может быть выполнена.

Код 504

Ошибка при работе с API. Повторите запрос.