Gets rented courier
Returns information about the rented courier by its ID.
HTTP Request
GET https://courier.yandex.ru/api/v1/companies/{company_id}/rented-couriers/{rented_courier_id}
Path Parameters
company_id * | integer Company ID used in requests to the Track & Trace API. |
rented_courier_id * | string Rented courier ID. Used in Route objects for thrid-party tracking. |
* Required parameter
Responses
Code 200
Information about the retned courier was received.
{ "company_id": integer, "created_at": string, "id": string, "order_id": string, "provider": string }
Copied to clipboard
Representation
Fields
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. |
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
Code 401
Authorization error. Make sure that the request header contains the correct OAuth token.
Code 403
Error accessing the object. The user doesn't have the rights to access the object.
Code 404
Object search error. Object not found.
Code 422
Incorrect input. The operation can't be performed.
Code 504
Error working with the API. Repeat the request.