Adds route plans.
Adds info about route plans.
HTTP Request
POST https://courier.yandex.ru/api/v1/companies/{company_id}/route-plans
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. |
* Required parameter
Request Body
[ { "nodes": [ { "arrival_time_s": number, "departure_time_s": number, "transit_distance_m": number, "type": string, "used_time_window": string, "value": { "address": string, "customer_name": string, "multi_order": boolean, "number": string, "point": { "lat": number, "lon": number }, "service_duration_s": integer, "shared_service_duration_s": integer, "shipment_size": { "amount": number, "volume_cbm": number, "weight_kg": number } } } ], "number": string } ]
Copied to clipboard
Representation
Fields
nodes[] * | array Planned route nodes. |
nodes[]. | number Arrival ETA in seconds from midnight. Minimum value: |
nodes[]. | number Time of departure from the location. Minimum value: |
nodes[]. | number Transit distance to a location, meters. Minimum value: |
nodes[]. | string Node type. Always equals |
nodes[]. | string Planned service time interval in "T - T" or "T-T" time format, where T represents time in HH, HH:MM or HH:MM:SS format. |
nodes[]. | object |
nodes[]. | string Node address in text format. |
nodes[]. | string Node number. |
nodes[]. | object |
nodes[]. | number Location latitude. |
nodes[]. | number Location longitude. |
nodes[]. | integer Time spent in the node. Minimum value: |
nodes[]. | number Arrival ETA in seconds from midnight. Minimum value: |
nodes[]. | number Time of departure from the location. Minimum value: |
nodes[]. | number Transit distance to a location, meters. Minimum value: |
nodes[]. | string Node type. Always equals |
nodes[]. | string Planned service time interval in "T - T" or "T-T" time format, where T represents time in HH, HH:MM or HH:MM:SS format. |
nodes[]. | object |
nodes[]. | string Node address in text format. |
nodes[]. | string Node number. |
nodes[]. | object |
nodes[]. | number Location latitude. |
nodes[]. | number Location longitude. |
nodes[]. | integer Time spent in the node. Minimum value: |
nodes[]. | number Arrival ETA in seconds from midnight. Minimum value: |
nodes[]. | number Time of departure from the location. Minimum value: |
nodes[]. | number Transit distance to a location, meters. Minimum value: |
nodes[]. | string Node type. Always equals |
nodes[]. | string Planned service time interval in "T - T" or "T-T" time format, where T represents time in HH, HH:MM or HH:MM:SS format. |
nodes[]. | object |
nodes[]. | string Node address in text format. |
nodes[]. | string Customer name of the order. |
nodes[]. | boolean Defines if an order is one of several orders at exactly the same location. |
nodes[]. | string Node number. |
nodes[]. | object |
nodes[]. | number Location latitude. |
nodes[]. | number Location longitude. |
nodes[]. | integer Time spent in the node. Minimum value: |
nodes[]. | integer Service duration at the location, which can be shared with other orders at the same location. Minimum value: |
nodes[]. | object |
nodes[]. | number Size of shipment in custom units. Minimum value: |
nodes[]. | number Order volume. Minimum value: |
nodes[]. | number Order weight. Minimum value: |
number * | string Route number. |
nodes[] * | array Planned route nodes. |
nodes[]. | number Arrival ETA in seconds from midnight. Minimum value: |
nodes[]. | number Time of departure from the location. Minimum value: |
nodes[]. | number Transit distance to a location, meters. Minimum value: |
nodes[]. | string Node type. Always equals |
nodes[]. | string Planned service time interval in "T - T" or "T-T" time format, where T represents time in HH, HH:MM or HH:MM:SS format. |
nodes[]. | object |
nodes[]. | string Node address in text format. |
nodes[]. | string Node number. |
nodes[]. | object |
nodes[]. | number Location latitude. |
nodes[]. | number Location longitude. |
nodes[]. | integer Time spent in the node. Minimum value: |
nodes[]. | number Arrival ETA in seconds from midnight. Minimum value: |
nodes[]. | number Time of departure from the location. Minimum value: |
nodes[]. | number Transit distance to a location, meters. Minimum value: |
nodes[]. | string Node type. Always equals |
nodes[]. | string Planned service time interval in "T - T" or "T-T" time format, where T represents time in HH, HH:MM or HH:MM:SS format. |
nodes[]. | object |
nodes[]. | string Node address in text format. |
nodes[]. | string Node number. |
nodes[]. | object |
nodes[]. | number Location latitude. |
nodes[]. | number Location longitude. |
nodes[]. | integer Time spent in the node. Minimum value: |
nodes[]. | number Arrival ETA in seconds from midnight. Minimum value: |
nodes[]. | number Time of departure from the location. Minimum value: |
nodes[]. | number Transit distance to a location, meters. Minimum value: |
nodes[]. | string Node type. Always equals |
nodes[]. | string Planned service time interval in "T - T" or "T-T" time format, where T represents time in HH, HH:MM or HH:MM:SS format. |
nodes[]. | object |
nodes[]. | string Node address in text format. |
nodes[]. | string Customer name of the order. |
nodes[]. | boolean Defines if an order is one of several orders at exactly the same location. |
nodes[]. | string Node number. |
nodes[]. | object |
nodes[]. | number Location latitude. |
nodes[]. | number Location longitude. |
nodes[]. | integer Time spent in the node. Minimum value: |
nodes[]. | integer Service duration at the location, which can be shared with other orders at the same location. Minimum value: |
nodes[]. | object |
nodes[]. | number Size of shipment in custom units. Minimum value: |
nodes[]. | number Order volume. Minimum value: |
nodes[]. | number Order weight. Minimum value: |
number * | string Route number. |
* Required parameter
Responses
Code 200
Route plans were added.
Code 401
Authorization failed. Send the correct OAuth token in the authorization header.
Code 403
You do not have access to this object.
Code 422
Incorrect input.