Gets photos

Gets photos.

Request

GET

https://courier.yandex.ru/api/v1/companies/{company_id}/photos

Path parameters

Name

Description

company_id*

Type: integer<int64>

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

Query parameters

Name	Description
courier_id	Type: integer<int64> Courier id.
ids	Type: string<list_of_integers> List of IDs of photos.
order_ids	Type: string<list_of_integers> List of IDs of orders.
page	Type: integer Page number. Each page contains `per_page` objects. Default: `1` Min value: `1`
per_page	Type: integer<int32> Number of photos per page. Default: `100` Min value: `1` Max value: `2000`
route_ids	Type: string<list_of_integers> List of IDs of routes.
tag	Type: string Photo tag.

Responses

200 OK

The list of photos.

Body

application/json

[
    {
        "id": "string",
        "link": "string",
        "created_at": "string",
        "route_id": "string",
        "courier_id": "string",
        "order_id": "string",
        "tags": [
            "string"
        ],
        "comment": "string",
        "ttl_s": 0,
        "point": {
            "lat": 0,
            "lon": 0
        }
    }
]

PhotosGetList[]

PhotosGetList

Name	Description
comment	Type: string Photo comment.
courier_id	Type: string Courier ID.
created_at	Type: string<datetime> Date and time of photo upload in ISO 8601 format. Example - '2018-09-06T10:15:00+03:00'
id	Type: string ID of the photo.
link	Type: string Link to the photo.
order_id	Type: string Order ID.
point	Type: PhotosGet_point Posion where photo was taken.
route_id	Type: string Route ID.
tags	Type: string[] Photo tags.
ttl_s	Type: integer Photo guaranteed time to live in seconds.

PhotosGet_point

Posion where photo was taken.

Name

Description

lat*

Type: number<float>

Node position latitude.

lon*

Type: number<float>

Node position longitude.

401 Unauthorized

Authorization failed.

403 Forbidden

Forbidden.

404 Not Found

Specified object not found.

422 Unprocessable Entity

Incorrect input.

500 Internal Server Error

Server error during request processing.

Was the article helpful?

Overview