Get versioned plan-fact for nodes

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

Returns all plan-fact updates occurring after the given previous version for the orders/depots/garages of the company.

HTTP Request

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

prev_version *

string

Version returned by the previous call to this method. For the initial call, use the value 0

page

integer

Page number. Each page contains per_page objects sorted by node's route date in ascending order.

Minimum value: 1.
Default value: 1.

per_page

integer

Count of nodes per page.

Minimum value: 1.
Maximum value: 1000.
Default value: 200.

prev_version *

string

Version returned by the previous call to this method. For the initial call, use the value 0

page

integer

Page number. Each page contains per_page objects sorted by node's route date in ascending order.

Minimum value: 1.
Default value: 1.

per_page

integer

Count of nodes per page.

Minimum value: 1.
Maximum value: 1000.
Default value: 200.

Responses

Code 200

Success.

{
  "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
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

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

Node arrival time.

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

Node departure time.

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

Node position.

data[].fact.point.lat

number

Node position latitude.

data[].fact.point.lon

number

Node position longitude.

data[].fact.point_radius *

number

data[].fact.real_sequence_pos *

integer

Actual sequence position of the node.

data[].fact.refined_lat *

number

data[].fact.refined_lon *

number

data[].fact.sequence_pos *

integer

Sequence position of the node as approved by the logistician.

data[].fact.service_duration_s *

integer

data[].fact.status *

string

data[].fact.status_comments[] *

array

data[].fact.time_window *

object

Time window of the node.

data[].fact.time_window.end *

object

Time window end time.

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

string

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

integer

data[].fact.time_window.start *

object

Time window start time.

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

Node type.

Allowed values
  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

Node arrival time.

data[].plan.arrival_time.text *

string

data[].plan.arrival_time.value *

integer

data[].plan.customer_name *

string

data[].plan.departure_time *

object

Node departure time.

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

Node position.

data[].plan.point.lat

number

Node position latitude.

data[].plan.point.lon

number

Node position longitude.

data[].plan.sequence_pos *

integer

Sequence position of the node.

data[].plan.service_duration_s *

integer

data[].plan.shared_service_duration_s *

integer

data[].plan.time_window *

object

Time window of the node.

data[].plan.time_window.end *

object

Time window end time.

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

string

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

integer

data[].plan.time_window.start *

object

Time window start time.

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

Node type.

Allowed values
  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

Change type in version.

Allowed values
  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

Node arrival time.

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

Node departure time.

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

Node position.

data[].fact.point.lat

number

Node position latitude.

data[].fact.point.lon

number

Node position longitude.

data[].fact.point_radius *

number

data[].fact.real_sequence_pos *

integer

Actual sequence position of the node.

data[].fact.refined_lat *

number

data[].fact.refined_lon *

number

data[].fact.sequence_pos *

integer

Sequence position of the node as approved by the logistician.

data[].fact.service_duration_s *

integer

data[].fact.status *

string

data[].fact.status_comments[] *

array

data[].fact.time_window *

object

Time window of the node.

data[].fact.time_window.end *

object

Time window end time.

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

string

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

integer

data[].fact.time_window.start *

object

Time window start time.

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

Node type.

Allowed values
  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

Node arrival time.

data[].plan.arrival_time.text *

string

data[].plan.arrival_time.value *

integer

data[].plan.customer_name *

string

data[].plan.departure_time *

object

Node departure time.

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

Node position.

data[].plan.point.lat

number

Node position latitude.

data[].plan.point.lon

number

Node position longitude.

data[].plan.sequence_pos *

integer

Sequence position of the node.

data[].plan.service_duration_s *

integer

data[].plan.shared_service_duration_s *

integer

data[].plan.time_window *

object

Time window of the node.

data[].plan.time_window.end *

object

Time window end time.

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

string

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

integer

data[].plan.time_window.start *

object

Time window start time.

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

Node type.

Allowed values
  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

Change type in version.

Allowed values
  1. added
  2. modified
  3. deleted

version *

string

Code 400

Invalid parameters were passed.

Code 403

You do not have access to this object.

Code 422

Incorrect input.

Code 500

Server error during request processing.