Gets photos

HTTP Request

GET https://courier.yandex.ru/api/v1/companies/{company_id}/photos\
?page={integer}\
&per_page={integer}\
&route_ids={string}\
&order_ids={string}\
&ids={string}\
&tag={string}\
&courier_id={integer}

Path Parameters

company_id *

integer

The ID of the company that is used in requests to the Track & Trace API.

* Required parameter

Query Parameters

page	integer Page number. Each page contains `per_page` objects. Minimum value: `1`. Default value: `1`.
per_page	integer Number of photos per page. Minimum value: `1`. Maximum value: `2000`. Default value: `100`.
route_ids	string List of IDs of routes.
order_ids	string List of IDs of orders.
ids	string List of IDs of photos.
tag	string Photo tag.
courier_id	integer Courier id.

* Required parameter

Responses

Code 200

The list of photos.

[
  {
    "comment": string,
    "courier_id": string,
    "created_at": string,
    "id": string,
    "link": string,
    "order_id": string,
    "point": {
      "lat": number,
      "lon": number
    },
    "route_id": string,
    "tags": [
      string
    ],
    "ttl_s": integer
  }
]
Copied to clipboard

Representation

Collapse all

Expand all

Fields

comment	string Photo comment.
courier_id	string Courier ID.
created_at	string Date and time of photo upload in ISO 8601 format. Example - '2018-09-06T10:15:00+03:00'
id	string ID of the photo.
link	string Link to the photo.
order_id	string Order ID.
point	object Posion where photo was taken.
point.lat *	number Node position latitude.
point.lon *	number Node position longitude.
route_id	string Route ID.
tags[]	array Photo tags.
ttl_s	integer Photo guaranteed time to live in seconds.

* Required parameter

Code 401

Authorization failed.

Code 403

Forbidden.

Code 404

Specified object not found.

Code 422

Incorrect input.

Code 500

Server error during request processing.