7.3. Get estimated time of arrival at locations
Returns a list of points and the courier's estimated time of arrival at the point
If a courier hasn't been assigned yet, returns 409 with the no_performer_info code
If the claim has already been completed, returns 409 with the inappropriate_status code
If, for some reason, it wasn't possible to determine the courier's coordinates, returns 409 with the unknown_performer_position code
HTTP Request
POST b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/points-eta\
?claim_id={string}
Query Parameters
claim_id * | string Claim ID, received upon creation of claim |
claim_id * | string Claim ID, received upon creation of claim |
* Required parameter
Header Parameters
Accept-Language * | string Preferred language of response. Examples: "ru" — Russian, "en" — English |
Accept-Language * | string Preferred language of response. Examples: "ru" — Russian, "en" — English |
* Required parameter
Responses
Code 200
Estimated time of arrival at locations
{ "id": string, "performer_position": [ "number" ], "route_points": [ { "address": { "building": string, "building_name": string, "city": string, "comment": string, "coordinates": [ "number" ], "country": string, "description": string, "door_code": string, "door_code_extra": string, "doorbell_name": string, "flat": integer, "floor": integer, "fullname": string, "porch": string, "sflat": string, "sfloor": string, "shortname": string, "street": string, "uri": string }, "id": integer, "type": string, "visit_order": integer, "visit_status": string, "visited_at": { "actual": string, "expected": string, "expected_waiting_time_sec": integer } } ] }
Copied to clipboard
Representation
Fields
id * | string Claim ID, received upon creation of claim |
performer_position[] | array [lon, lat] |
route_points[] * | array Route locations with ETA |
route_points[]. | object |
route_points[]. | string Building |
route_points[]. | string Name of the apartment (building) |
route_points[]. | string City |
route_points[]. | string Comments for the courier. For point A (pickup point), use the template: "Delivery from the store <>. Inform the manager that it's a Yandex Delivery order. State the order number <> and collect the parcel. The order is for non-cash payment, the delivery must be completed without requiring delivery payment from the recipient." For B points (destination), pass the recipient's requests or instructions via the comment field. For example, "the intercom does not work", "the barrier is closed, call 10 minutes in advance", "do not call, the baby is asleep". |
route_points[]. | array Array of two real numbers [longitude, latitude]. The order is important! Rounded coordinate values are specified. |
route_points[]. | string Country |
route_points[]. | string Geographic area that specifies shortname to global match |
route_points[]. | string Intercom code |
route_points[]. | string Additional instructions on intercoms |
route_points[]. | string Name on the doorbell |
route_points[]. | integer Apartment (DEPRECATED) (int64) |
route_points[]. | integer Floor (DEPRECATED) (int64) |
route_points[]. | string Full name indicating the city (Moscow, Sadovnicheskaya Naberezhnaya, 82 bld. 2). |
route_points[]. | string Entrance (can be A) |
route_points[]. | string Apartment |
route_points[]. | string Floor |
route_points[]. | string Address within the city as shown in Taximeter (Sadovnicheskaya Naberezhnaya, 82 bld. 2) |
route_points[]. | string Street |
route_points[]. | string Map uri of geo object |
route_points[]. | integer Integer ID of the point (int64) |
route_points[]. | string point type:
|
route_points[]. | integer Order of visiting the point (int64) |
route_points[]. | string Status of visiting this point: pending: the point has not yet been visited; arrived: the driver arrived at the point; visited: the driver delivered or picked up the shipment at the point; partial_delivery: the point was visited, but part of the shipment wasn't delivered; skipped: the point was skipped (in the case of a return when the client couldn't receive the shipment) Allowed values
|
route_points[]. | object Information about the time of visit to the point |
route_points[]. | string Actual time of visit to the point. |
route_points[]. | string Expected time of visit. Can be filled out (in some cases) only for unvisited points. |
route_points[]. | integer Expected waiting time at the point (int64). |
id * | string Claim ID, received upon creation of claim |
performer_position[] | array [lon, lat] |
route_points[] * | array Route locations with ETA |
route_points[]. | object |
route_points[]. | string Building |
route_points[]. | string Name of the apartment (building) |
route_points[]. | string City |
route_points[]. | string Comments for the courier. For point A (pickup point), use the template: "Delivery from the store <>. Inform the manager that it's a Yandex Delivery order. State the order number <> and collect the parcel. The order is for non-cash payment, the delivery must be completed without requiring delivery payment from the recipient." For B points (destination), pass the recipient's requests or instructions via the comment field. For example, "the intercom does not work", "the barrier is closed, call 10 minutes in advance", "do not call, the baby is asleep". |
route_points[]. | array Array of two real numbers [longitude, latitude]. The order is important! Rounded coordinate values are specified. |
route_points[]. | string Country |
route_points[]. | string Geographic area that specifies shortname to global match |
route_points[]. | string Intercom code |
route_points[]. | string Additional instructions on intercoms |
route_points[]. | string Name on the doorbell |
route_points[]. | integer Apartment (DEPRECATED) (int64) |
route_points[]. | integer Floor (DEPRECATED) (int64) |
route_points[]. | string Full name indicating the city (Moscow, Sadovnicheskaya Naberezhnaya, 82 bld. 2). |
route_points[]. | string Entrance (can be A) |
route_points[]. | string Apartment |
route_points[]. | string Floor |
route_points[]. | string Address within the city as shown in Taximeter (Sadovnicheskaya Naberezhnaya, 82 bld. 2) |
route_points[]. | string Street |
route_points[]. | string Map uri of geo object |
route_points[]. | integer Integer ID of the point (int64) |
route_points[]. | string point type:
|
route_points[]. | integer Order of visiting the point (int64) |
route_points[]. | string Status of visiting this point: pending: the point has not yet been visited; arrived: the driver arrived at the point; visited: the driver delivered or picked up the shipment at the point; partial_delivery: the point was visited, but part of the shipment wasn't delivered; skipped: the point was skipped (in the case of a return when the client couldn't receive the shipment) Allowed values
|
route_points[]. | object Information about the time of visit to the point |
route_points[]. | string Actual time of visit to the point. |
route_points[]. | string Expected time of visit. Can be filled out (in some cases) only for unvisited points. |
route_points[]. | integer Expected waiting time at the point (int64). |
* Required parameter
Code 404
Claim not found
{ "code": string, "message": string }
Copied to clipboard
Representation
Fields
code * | string String error code Allowed values
|
message * | string Human-readable error message |
* Required parameter
Code 409
The claim is inactive | No performer has been assigned yet| Couldn't determine the performer's position
{ "code": string, "message": string }
Copied to clipboard
Representation
Fields
code * | string String error code Allowed values
|
message * | string Human-readable error message |
* Required parameter
Code 429
Too many requests
{ "code": string, "message": string }
Copied to clipboard
Representation
Fields
code * | string String error code Allowed values
|
message * | string Human-readable error message |
* Required parameter
Example
Responses:
{ "id": "741cedf82cd464fa6fa16d87155c636", "performer_position": [ 52.569089, 39.60258 ], "route_points": [ { "address": { "building": "23k1A", "building_name": "Krasnaya Roza business center", "city": "Saint Petersburg", "comment": "The intercom doesn't work", "country": "Russian Federation", "description": "Odintsovo, Moscow oblast, Russia", "door_code": "169", "door_code_extra": "code to enter the yard #1234, apartment code #4321", "doorbell_name": "Magidovich", "flat": 1, "floor": 1, "fullname": "St. Petersburg, Bolshaya Monetnaya Ulitsa, 1 bld. 1A", "porch": "A", "sflat": "1", "sfloor": "1", "shortname": "Bolshaya Monetnaya Ulitsa, 1, apt. 1A", "street": "Bolshaya Monetnaya ulitsa", "uri": "ymapsbm1://geo?ll=38.805%2C55.084" }, "id": 1, "type": "source", "visit_order": 1, "visit_status": "pending" } ] }
Copied to clipboard
{ "code": "not_found", "message": "Claim not found" }
Copied to clipboard
{ "code": "inappropriate_status", "message": "Invalid action on the claim" }
Copied to clipboard
{ "code": "too_many_requests", "message": "Too many requests" }
Copied to clipboard