Получить план-факт для точек по версии

  1. HTTP-запрос
  2. Path-параметры
  3. Query-параметры
  4. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 400
    3. Код 403
    4. Код 422
    5. Код 500

Возвращает все обновления план-факта, возникшие после переданной предыдущей версии, для заказов/складов/гаражей компании.

HTTP-запрос

GET https://courier.yandex.ru/api/v1/analytics/companies/{company_id}/plan-fact/versioned/nodes\
?prev_version={string}\
&page={integer}\
&per_page={integer}

Path-параметры

company_id *

integer

ID компании, используемый в запросах к API Мониторинга.

company_id *

integer

ID компании, используемый в запросах к API Мониторинга.

Query-параметры

prev_version *

string

Версия, полученная на пролшом вызове данного метода. Для первоначальной выгрузки используйте значение 0

page

integer

Номер страницы. Каждая страница содержит per_page объектов.

Минимальное значение: 1.
Значение по умолчанию: 1.

per_page

integer

Количество точек на страницу.

Минимальное значение: 1.
Максимальное значение: 1000.
Значение по умолчанию: 200.

prev_version *

string

Версия, полученная на пролшом вызове данного метода. Для первоначальной выгрузки используйте значение 0

page

integer

Номер страницы. Каждая страница содержит per_page объектов.

Минимальное значение: 1.
Значение по умолчанию: 1.

per_page

integer

Количество точек на страницу.

Минимальное значение: 1.
Максимальное значение: 1000.
Значение по умолчанию: 200.

Ответы

Код 200

Успех.

{
  "data": [
    {
      "courier": {
        "id": integer,
        "name": string,
        "number": string
      },
      "depot": {
        "id": integer,
        "name": string,
        "number": string,
        "timezone": string
      },
      "fact": {
        "address": string,
        "amount": number,
        "comments": string,
        "customer_name": string,
        "failed_time_window": boolean,
        "node_idle_duration_s": integer,
        "number": string,
        "point": {
          "lat": number,
          "lon": number
        },
        "point_radius": number,
        "real_sequence_pos": integer,
        "refined_lat": number,
        "refined_lon": number,
        "sequence_pos": integer,
        "service_duration_s": integer,
        "status": string,
        "status_comments": [
          {}
        ],
        "transit_distance_m": number,
        "transit_duration_s": integer,
        "transit_idle_duration_s": integer,
        "type": string,
        "volume_cbm": number,
        "weight_kg": number
      },
      "plan": {
        "address": string,
        "amount": number,
        "customer_name": string,
        "failed_time_window": boolean,
        "number": string,
        "point": {
          "lat": number,
          "lon": number
        },
        "sequence_pos": integer,
        "service_duration_s": integer,
        "shared_service_duration_s": integer,
        "transit_distance_m": number,
        "transit_duration_s": integer,
        "type": string,
        "volume_cbm": number,
        "weight_kg": number
      },
      "route": {
        "date": string,
        "id": integer,
        "number": string
      },
      "version_status": string
    }
  ],
  "version": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

data[] *

array

data[].courier *

object

data[].courier.id *

integer

data[].courier.name *

string

data[].courier.number *

string

data[].depot *

object

data[].depot.id *

integer

data[].depot.name *

string

data[].depot.number *

string

data[].depot.timezone *

string

data[].fact *

object

data[].fact.address *

string

data[].fact.amount *

number

data[].fact.arrival_time *

object

Время прибытия в точку.

data[].fact.arrival_time.text *

string

data[].fact.arrival_time.value *

integer

data[].fact.comments *

string

data[].fact.customer_name *

string

data[].fact.departure_time *

object

Время отправления из точки.

data[].fact.departure_time.text *

string

data[].fact.departure_time.value *

integer

data[].fact.failed_time_window *

boolean

data[].fact.node_idle_duration_s *

integer

data[].fact.number *

string

data[].fact.point *

object

Позиция точки.

data[].fact.point.lat

number

Широта позиции точки.

data[].fact.point.lon

number

Долгота позиции точки.

data[].fact.point_radius *

number

data[].fact.real_sequence_pos *

integer

Фактический порядковый номер точки.

data[].fact.refined_lat *

number

data[].fact.refined_lon *

number

data[].fact.sequence_pos *

integer

Порядковый номер точки, утвержденный логистом.

data[].fact.service_duration_s *

integer

data[].fact.status *

string

data[].fact.status_comments[] *

array

data[].fact.time_window *

object

Временное окно точки.

data[].fact.time_window.end *

object

Время окончания временного окна.

data[].fact.time_window.end.text *

string

data[].fact.time_window.end.value *

integer

data[].fact.time_window.start *

object

Время начала временного окна.

data[].fact.time_window.start.text *

string

data[].fact.time_window.start.value *

integer

data[].fact.transit_distance_m *

number

data[].fact.transit_duration_s *

integer

data[].fact.transit_idle_duration_s *

integer

data[].fact.type *

string

Тип точки.

Возможные значения
  1. order
  2. depot
  3. garage

data[].fact.volume_cbm *

number

data[].fact.weight_kg *

number

data[].plan *

object

data[].plan.address *

string

data[].plan.amount *

number

data[].plan.arrival_time *

object

Время прибытия в точку.

data[].plan.arrival_time.text *

string

data[].plan.arrival_time.value *

integer

data[].plan.customer_name *

string

data[].plan.departure_time *

object

Время отправления из точки.

data[].plan.departure_time.text *

string

data[].plan.departure_time.value *

integer

data[].plan.failed_time_window *

boolean

data[].plan.number *

string

data[].plan.point *

object

Позиция точки.

data[].plan.point.lat

number

Широта позиции точки.

data[].plan.point.lon

number

Долгота позиции точки.

data[].plan.sequence_pos *

integer

Порядковый номер точки.

data[].plan.service_duration_s *

integer

data[].plan.shared_service_duration_s *

integer

data[].plan.time_window *

object

Временное окно точки.

data[].plan.time_window.end *

object

Время окончания временного окна.

data[].plan.time_window.end.text *

string

data[].plan.time_window.end.value *

integer

data[].plan.time_window.start *

object

Время начала временного окна.

data[].plan.time_window.start.text *

string

data[].plan.time_window.start.value *

integer

data[].plan.transit_distance_m *

number

data[].plan.transit_duration_s *

integer

data[].plan.type *

string

Тип точки.

Возможные значения
  1. order
  2. depot
  3. garage

data[].plan.volume_cbm *

number

data[].plan.weight_kg *

number

data[].route *

object

data[].route.date *

string

data[].route.id *

integer

data[].route.number *

string

data[].version_status *

string

Тип изменения в версии.

Возможные значения
  1. added
  2. modified
  3. deleted

version *

string

data[] *

array

data[].courier *

object

data[].courier.id *

integer

data[].courier.name *

string

data[].courier.number *

string

data[].depot *

object

data[].depot.id *

integer

data[].depot.name *

string

data[].depot.number *

string

data[].depot.timezone *

string

data[].fact *

object

data[].fact.address *

string

data[].fact.amount *

number

data[].fact.arrival_time *

object

Время прибытия в точку.

data[].fact.arrival_time.text *

string

data[].fact.arrival_time.value *

integer

data[].fact.comments *

string

data[].fact.customer_name *

string

data[].fact.departure_time *

object

Время отправления из точки.

data[].fact.departure_time.text *

string

data[].fact.departure_time.value *

integer

data[].fact.failed_time_window *

boolean

data[].fact.node_idle_duration_s *

integer

data[].fact.number *

string

data[].fact.point *

object

Позиция точки.

data[].fact.point.lat

number

Широта позиции точки.

data[].fact.point.lon

number

Долгота позиции точки.

data[].fact.point_radius *

number

data[].fact.real_sequence_pos *

integer

Фактический порядковый номер точки.

data[].fact.refined_lat *

number

data[].fact.refined_lon *

number

data[].fact.sequence_pos *

integer

Порядковый номер точки, утвержденный логистом.

data[].fact.service_duration_s *

integer

data[].fact.status *

string

data[].fact.status_comments[] *

array

data[].fact.time_window *

object

Временное окно точки.

data[].fact.time_window.end *

object

Время окончания временного окна.

data[].fact.time_window.end.text *

string

data[].fact.time_window.end.value *

integer

data[].fact.time_window.start *

object

Время начала временного окна.

data[].fact.time_window.start.text *

string

data[].fact.time_window.start.value *

integer

data[].fact.transit_distance_m *

number

data[].fact.transit_duration_s *

integer

data[].fact.transit_idle_duration_s *

integer

data[].fact.type *

string

Тип точки.

Возможные значения
  1. order
  2. depot
  3. garage

data[].fact.volume_cbm *

number

data[].fact.weight_kg *

number

data[].plan *

object

data[].plan.address *

string

data[].plan.amount *

number

data[].plan.arrival_time *

object

Время прибытия в точку.

data[].plan.arrival_time.text *

string

data[].plan.arrival_time.value *

integer

data[].plan.customer_name *

string

data[].plan.departure_time *

object

Время отправления из точки.

data[].plan.departure_time.text *

string

data[].plan.departure_time.value *

integer

data[].plan.failed_time_window *

boolean

data[].plan.number *

string

data[].plan.point *

object

Позиция точки.

data[].plan.point.lat

number

Широта позиции точки.

data[].plan.point.lon

number

Долгота позиции точки.

data[].plan.sequence_pos *

integer

Порядковый номер точки.

data[].plan.service_duration_s *

integer

data[].plan.shared_service_duration_s *

integer

data[].plan.time_window *

object

Временное окно точки.

data[].plan.time_window.end *

object

Время окончания временного окна.

data[].plan.time_window.end.text *

string

data[].plan.time_window.end.value *

integer

data[].plan.time_window.start *

object

Время начала временного окна.

data[].plan.time_window.start.text *

string

data[].plan.time_window.start.value *

integer

data[].plan.transit_distance_m *

number

data[].plan.transit_duration_s *

integer

data[].plan.type *

string

Тип точки.

Возможные значения
  1. order
  2. depot
  3. garage

data[].plan.volume_cbm *

number

data[].plan.weight_kg *

number

data[].route *

object

data[].route.date *

string

data[].route.id *

integer

data[].route.number *

string

data[].version_status *

string

Тип изменения в версии.

Возможные значения
  1. added
  2. modified
  3. deleted

version *

string

Код 400

Недопустимые параметры были переданы.

Код 403

У вас нет доступа к этому объекту.

Код 422

Неправильный ввод.

Код 500

Ошибка сервера при обработке запроса.