Adds a rented courier

HTTP Request

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

company_id *

integer

Company ID used in requests to the Track & Trace API.

* Required parameter

{
  "order_id": string,
  "provider": string
}
Copied to clipboard

Collapse all

Expand all

order_id *	string Order identifier from provider.
provider *	string Identifier of provider. Allowed values: yandex_taxi_cargo.

* Required parameter

The rented courier information was registered in the database.

{
  "company_id": integer,
  "created_at": string,
  "id": string,
  "order_id": string,
  "provider": string
}
Copied to clipboard

Collapse all

Expand all

company_id	integer Company ID used in requests to the Track & Trace API.
created_at	string Date and time of rented courier object creation.
id	string Rented courier ID. Used in Route objects for thrid-party tracking.
order_id *	string Order identifier from provider.
provider *	string Identifier of provider. Possible values: yandex_taxi_cargo.

* Required parameter

Authorization error. Make sure that the request header contains the correct OAuth token.

Error accessing the object. The user doesn't have the rights to access the object.

Incorrect input. The operation can't be performed.

Error working with the API. Repeat the request.