Gets photos.

  1. HTTP Request
  2. Path Parameters
  3. Query Parameters
  4. Responses
    1. Code 200
      1. Representation
      2. Fields
    2. Code 401
    3. Code 403
    4. Code 404
    5. Code 422
    6. Code 500

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.

company_id *

integer

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

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.

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.

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.

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.

Code 401

Authorization failed.

Code 403

Forbidden.

Code 404

Specified object not found.

Code 422

Incorrect input.

Code 500

Server error during request processing.