Veeroute Monitor API.
Create new folder.
Request to create a folder. In the parent_key
field, you must specify the key of the folder in which the new folder will be created. If parent_key
is not specified, the folder is created in the root.
parent_key | string or null <uuid> (unique_key_null) Example: "11111111-2222-3333-4444-555555555555" Parent folder key, null if the folder is root. |
name required | string (folder_name) [ 1 .. 100 ] characters Example: "folder_1" Folder name. |
comment | string or null (folder_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Folder comment. |
color | string or null (folder_color) [ 1 .. 20 ] characters Example: "red" Folder color. |
Array of objects (attributes) [ 0 .. 250 ] items unique Attributes. Used to add service information. |
New folder key.
{- "parent_key": "11111111-2222-3333-4444-555555555555",
- "name": "folder_1",
- "comment": "long long long long text",
- "color": "red",
- "attributes": [ ]
}
"11111111-2222-3333-4444-555555555555"
Getting a filesystem.
folder_key | string or null <uuid> (unique_key_null) Default: null Example: folder_key=11111111-2222-3333-4444-555555555555 Parent folder key, if not specified - a list of root folders is returned |
filter | string [ 1 .. 64 ] characters Example: filter=example text Filter for searching by text fields - only those folders that contain a substring from the filter are returned:
|
offset | integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set. |
limit | integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return. |
sort_field | string (filesystem_column_type) Default: "NAME" Enum: "NAME" "OWNER_COMPANY_KEY" "OWNER_USERNAME" … 3 more Example: sort_field=CREATION_DATE The name of the column in the table with folders. |
sort_direction | string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction. |
required | object (folder) Folder is an element of a virtual file system. |
required | Array of objects (folder) [ 0 .. 2001 ] items List of folders. |
required | object (table_list_counters) Counters by list. |
{- "folders": [
- {
- "key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091",
- "parent_key": "65fb88e5-128d-4f3f-9a50-4c2754adcbed",
- "name": "My Folder",
- "owner_company_key": "veeroute",
- "owner_username": "username_1",
- "comment": "long text",
- "counters": {
- "folders_count": 0,
- "files_count": 3
}
}
], - "counters": {
- "overall": {
- "total": 20
}, - "filter": {
- "total": 1
}
}
}
Rename and move folder.
folder_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Folder key, unique identifier. |
Folder update request.
parent_key | string or null <uuid> (unique_key_null) Example: "11111111-2222-3333-4444-555555555555" Parent folder key, null if the folder is root. |
name required | string (folder_name) [ 1 .. 100 ] characters Example: "folder_1" Folder name. |
comment | string or null (folder_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Folder comment. |
color | string or null (folder_color) [ 1 .. 20 ] characters Example: "red" Folder color. |
Array of objects (attributes) [ 0 .. 250 ] items unique Attributes. Used to add service information. |
required | object (folder) Folder is an element of a virtual file system. |
required | Array of objects (folder) [ 0 .. 2001 ] items List of folders. |
required | object (table_list_counters) Counters by list. |
{- "parent_key": "11111111-2222-3333-4444-555555555555",
- "name": "folder_1",
- "comment": "long long long long text",
- "color": "red",
- "attributes": [ ]
}
{- "folders": [
- {
- "key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091",
- "parent_key": "65fb88e5-128d-4f3f-9a50-4c2754adcbed",
- "name": "My Folder",
- "owner_company_key": "veeroute",
- "owner_username": "username_1",
- "comment": "long text",
- "counters": {
- "folders_count": 0,
- "files_count": 3
}
}
], - "counters": {
- "overall": {
- "total": 20
}, - "filter": {
- "total": 1
}
}
}
Folder removal by key.
folder_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Folder key, unique identifier. |
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Getting a folder specification.
folder_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Folder key, unique identifier. |
parent_key | string or null <uuid> (unique_key_null) Example: "11111111-2222-3333-4444-555555555555" Parent folder key, null if the folder is root. |
name required | string (folder_name) [ 1 .. 100 ] characters Example: "folder_1" Folder name. |
comment | string or null (folder_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Folder comment. |
color | string or null (folder_color) [ 1 .. 20 ] characters Example: "red" Folder color. |
Array of objects (attributes) [ 0 .. 250 ] items unique Attributes. Used to add service information. |
{- "parent_key": "11111111-2222-3333-4444-555555555555",
- "name": "folder_1",
- "comment": "long long long long text",
- "color": "red",
- "attributes": [ ]
}
Folder path.
folder_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Folder key, unique identifier. |
required | Array of objects (folder) [ 0 .. 1000 ] items List of folders. |
{- "folders": [
- {
- "key": "11111111-2222-3333-4444-555555555555",
- "type": "FOLDER",
- "parent_key": "11111111-2222-3333-4444-555555555555",
- "name": "folder_1",
- "comment": "long long long long text",
- "color": "red",
- "attributes": [ ],
- "owner_company_key": "smart_company",
- "owner_username": "username_for_login",
- "creation_date": "2025-09-21T19:45:00Z",
- "counters": {
- "folders_count": 12,
- "files_count": 16
}
}
]
}
Batch delete folders.
List of folder keys that need to be deleted.
Key, unique identifier.
[- "11111111-2222-3333-4444-555555555555"
]
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Batch delete files.
List of file's keys that need to be deleted.
Key, unique identifier.
[- "11111111-2222-3333-4444-555555555555"
]
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Getting a virtual filesystem counters.
required | object (folder_counters) Current number of available folders/files. |
required | object (folder_counters) Max number of available folders/files. |
{- "current": {
- "folders_count": 12,
- "files_count": 16
}, - "max": {
- "folders_count": 12,
- "files_count": 16
}
}
Export folder with experiments.
folder_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Folder key, unique identifier. |
ZIP archive with data.
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Import folder with experiments. The folder should not be of type ROOT and should be empty.
folder_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Folder key, unique identifier. |
Data (ZIP).
ZIP archive with data.
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
New crew creation.
Crew creation request.
key required | string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Unique crew key. |
username required | string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Unique username for login. |
password | string or null <password> (user_password) [ 10 .. 256 ] characters Example: "long_strong_password" Password. |
company_key required | string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Unique company key. |
required | object (performer) Performer. Fulfills orders using transport. |
required | object (transport) Transport. Used by performer for relocating and cargo transfer. |
object (device) Mobile device. | |
specification | string or null (user_specification) [ 2 .. 256 ] characters Example: "User full name" Crew specification. |
Array of objects (deal_list) [ 0 .. 30 ] items Linked current deals. |
key required | string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Unique crew key. |
username required | string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Unique username for login. |
company_key required | string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Unique company key. |
required | object (performer) Performer. Fulfills orders using transport. |
required | object (transport) Transport. Used by performer for relocating and cargo transfer. |
object (device) Mobile device. | |
specification | string or null (user_specification) [ 2 .. 256 ] characters Example: "User full name" Crew specification. |
Array of objects (deal_list) [ 0 .. 30 ] items Linked current deals. |
{- "key": "mega_crew",
- "username": "username_for_login",
- "password": "long_strong_password",
- "company_key": "smart_company",
- "performer": {
- "key": "performer0001",
- "shifts": [
- {
- "key": "shift01",
- "availability_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "working_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "start_location_key": "start_location_01",
- "finish_location_key": "finish_location_01",
- "max_locations": 15,
- "max_stops": 15,
- "tariff": {
- "cost_per_shift": 2000,
- "constraints": [
- {
- "stage_length": "P30D",
- "cost_per_unit": 0.001
}
], - "max_penalty_cost": 2000
}, - "work_and_rest_rules": {
- "rest_rules": {
- "consecutive": {
- "relocating_duration_sum": "PT1H45M",
- "operating_duration_sum": "PT2H12M34.3S",
- "duration": "PT1H45M"
}
}, - "break_rules": {
- "first": {
- "relocating_duration_sum": "PT1H45M",
- "operating_duration_sum": "PT2H12M34.3S",
- "duration": "PT1H45M"
}, - "consecutive": {
- "relocating_duration_sum": "PT1H45M",
- "operating_duration_sum": "PT2H12M34.3S",
- "duration": "PT1H45M"
}, - "relocating_duration_type": "CONTINUOUS"
}, - "reset_location_keys": [
- "location_01"
], - "ignore_location_keys": [
- "location_01"
]
}, - "name": "X1-ABC",
- "attributes": [ ]
}
], - "own_transport_type": "CAR",
- "compatibilities": {
- "performer_features": [ ],
- "performer_features_lifetimes": [ ],
- "transport_restrictions": [ ]
}, - "limits": {
- "max_work_shifts": 3,
- "demand_extra_durations": [
- {
- "demand_key": "demand01.1",
- "additional_duration": "PT1H45M"
}
]
}, - "name": "X1-ABC",
- "attributes": [ ]
}, - "transport": {
- "key": "transport001",
- "shifts": [
- {
- "key": "shift01",
- "availability_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "start_location_key": "start_location_01",
- "finish_location_key": "finish_location_01",
- "tariff": {
- "cost_per_shift": 2000,
- "constraints": [
- {
- "stage_length": 100000000,
- "cost_per_unit": 0.001
}
], - "transportation_cost": {
- "mass": 11,
- "volume": 22,
- "capacity_a": 11,
- "capacity_b": 22,
- "capacity_c": 31
}
}, - "name": "X1-ABC",
- "attributes": [ ]
}
], - "transport_type": "CAR",
- "boxes": [
- {
- "key": "box01",
- "capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}, - "compatibilities": {
- "width": 1,
- "height": 3.1,
- "length": 2.1,
- "box_features": [ ]
}, - "limits": {
- "max_one_cargo_capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}
}
}
], - "compatibilities": {
- "transport_features": [ ],
- "transport_features_lifetimes": [ ],
- "performer_restrictions": [ ]
}, - "limits": {
- "max_boxes": 2,
- "max_capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}
}, - "name": "X1-ABC",
- "attributes": [ ]
}, - "device": {
- "phone": "+71112223333",
- "online": true,
- "app_version": "7.21",
- "os_version": "15.0",
- "manufacturer": "samsung",
- "model": "S25 Ultra"
}, - "specification": "User full name",
- "deals": [
- {
- "key": "11111111-2222-3333-4444-555555555555",
- "specification": {
- "crew_key": "mega_crew",
- "wave_key": "11111111-2222-3333-4444-555555555555",
- "trip_key": "trip-0000-9999"
}
}
]
}
{- "key": "mega_crew",
- "username": "username_for_login",
- "company_key": "smart_company",
- "performer": {
- "key": "performer0001",
- "shifts": [
- {
- "key": "shift01",
- "availability_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "working_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "start_location_key": "start_location_01",
- "finish_location_key": "finish_location_01",
- "max_locations": 15,
- "max_stops": 15,
- "tariff": {
- "cost_per_shift": 2000,
- "constraints": [
- {
- "stage_length": "P30D",
- "cost_per_unit": 0.001
}
], - "max_penalty_cost": 2000
}, - "work_and_rest_rules": {
- "rest_rules": {
- "consecutive": {
- "relocating_duration_sum": "PT1H45M",
- "operating_duration_sum": "PT2H12M34.3S",
- "duration": "PT1H45M"
}
}, - "break_rules": {
- "first": {
- "relocating_duration_sum": "PT1H45M",
- "operating_duration_sum": "PT2H12M34.3S",
- "duration": "PT1H45M"
}, - "consecutive": {
- "relocating_duration_sum": "PT1H45M",
- "operating_duration_sum": "PT2H12M34.3S",
- "duration": "PT1H45M"
}, - "relocating_duration_type": "CONTINUOUS"
}, - "reset_location_keys": [
- "location_01"
], - "ignore_location_keys": [
- "location_01"
]
}, - "name": "X1-ABC",
- "attributes": [ ]
}
], - "own_transport_type": "CAR",
- "compatibilities": {
- "performer_features": [ ],
- "performer_features_lifetimes": [ ],
- "transport_restrictions": [ ]
}, - "limits": {
- "max_work_shifts": 3,
- "demand_extra_durations": [
- {
- "demand_key": "demand01.1",
- "additional_duration": "PT1H45M"
}
]
}, - "name": "X1-ABC",
- "attributes": [ ]
}, - "transport": {
- "key": "transport001",
- "shifts": [
- {
- "key": "shift01",
- "availability_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "start_location_key": "start_location_01",
- "finish_location_key": "finish_location_01",
- "tariff": {
- "cost_per_shift": 2000,
- "constraints": [
- {
- "stage_length": 100000000,
- "cost_per_unit": 0.001
}
], - "transportation_cost": {
- "mass": 11,
- "volume": 22,
- "capacity_a": 11,
- "capacity_b": 22,
- "capacity_c": 31
}
}, - "name": "X1-ABC",
- "attributes": [ ]
}
], - "transport_type": "CAR",
- "boxes": [
- {
- "key": "box01",
- "capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}, - "compatibilities": {
- "width": 1,
- "height": 3.1,
- "length": 2.1,
- "box_features": [ ]
}, - "limits": {
- "max_one_cargo_capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}
}
}
], - "compatibilities": {
- "transport_features": [ ],
- "transport_features_lifetimes": [ ],
- "performer_restrictions": [ ]
}, - "limits": {
- "max_boxes": 2,
- "max_capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}
}, - "name": "X1-ABC",
- "attributes": [ ]
}, - "device": {
- "phone": "+71112223333",
- "online": true,
- "app_version": "7.21",
- "os_version": "15.0",
- "manufacturer": "samsung",
- "model": "S25 Ultra"
}, - "specification": "User full name",
- "deals": [
- {
- "key": "11111111-2222-3333-4444-555555555555",
- "specification": {
- "crew_key": "mega_crew",
- "wave_key": "11111111-2222-3333-4444-555555555555",
- "trip_key": "trip-0000-9999"
}
}
]
}
Updating the crew information.
Crew update request.
key required | string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Unique crew key. |
username required | string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Unique username for login. |
password | string or null <password> (user_password) [ 10 .. 256 ] characters Example: "long_strong_password" Password. |
company_key required | string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Unique company key. |
required | object (performer) Performer. Fulfills orders using transport. |
required | object (transport) Transport. Used by performer for relocating and cargo transfer. |
object (device) Mobile device. | |
specification | string or null (user_specification) [ 2 .. 256 ] characters Example: "User full name" Crew specification. |
Array of objects (deal_list) [ 0 .. 30 ] items Linked current deals. |
key required | string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Unique crew key. |
username required | string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Unique username for login. |
company_key required | string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Unique company key. |
required | object (performer) Performer. Fulfills orders using transport. |
required | object (transport) Transport. Used by performer for relocating and cargo transfer. |
object (device) Mobile device. | |
specification | string or null (user_specification) [ 2 .. 256 ] characters Example: "User full name" Crew specification. |
Array of objects (deal_list) [ 0 .. 30 ] items Linked current deals. |
{- "key": "mega_crew",
- "username": "username_for_login",
- "password": "long_strong_password",
- "company_key": "smart_company",
- "performer": {
- "key": "performer0001",
- "shifts": [
- {
- "key": "shift01",
- "availability_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "working_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "start_location_key": "start_location_01",
- "finish_location_key": "finish_location_01",
- "max_locations": 15,
- "max_stops": 15,
- "tariff": {
- "cost_per_shift": 2000,
- "constraints": [
- {
- "stage_length": "P30D",
- "cost_per_unit": 0.001
}
], - "max_penalty_cost": 2000
}, - "work_and_rest_rules": {
- "rest_rules": {
- "consecutive": {
- "relocating_duration_sum": "PT1H45M",
- "operating_duration_sum": "PT2H12M34.3S",
- "duration": "PT1H45M"
}
}, - "break_rules": {
- "first": {
- "relocating_duration_sum": "PT1H45M",
- "operating_duration_sum": "PT2H12M34.3S",
- "duration": "PT1H45M"
}, - "consecutive": {
- "relocating_duration_sum": "PT1H45M",
- "operating_duration_sum": "PT2H12M34.3S",
- "duration": "PT1H45M"
}, - "relocating_duration_type": "CONTINUOUS"
}, - "reset_location_keys": [
- "location_01"
], - "ignore_location_keys": [
- "location_01"
]
}, - "name": "X1-ABC",
- "attributes": [ ]
}
], - "own_transport_type": "CAR",
- "compatibilities": {
- "performer_features": [ ],
- "performer_features_lifetimes": [ ],
- "transport_restrictions": [ ]
}, - "limits": {
- "max_work_shifts": 3,
- "demand_extra_durations": [
- {
- "demand_key": "demand01.1",
- "additional_duration": "PT1H45M"
}
]
}, - "name": "X1-ABC",
- "attributes": [ ]
}, - "transport": {
- "key": "transport001",
- "shifts": [
- {
- "key": "shift01",
- "availability_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "start_location_key": "start_location_01",
- "finish_location_key": "finish_location_01",
- "tariff": {
- "cost_per_shift": 2000,
- "constraints": [
- {
- "stage_length": 100000000,
- "cost_per_unit": 0.001
}
], - "transportation_cost": {
- "mass": 11,
- "volume": 22,
- "capacity_a": 11,
- "capacity_b": 22,
- "capacity_c": 31
}
}, - "name": "X1-ABC",
- "attributes": [ ]
}
], - "transport_type": "CAR",
- "boxes": [
- {
- "key": "box01",
- "capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}, - "compatibilities": {
- "width": 1,
- "height": 3.1,
- "length": 2.1,
- "box_features": [ ]
}, - "limits": {
- "max_one_cargo_capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}
}
}
], - "compatibilities": {
- "transport_features": [ ],
- "transport_features_lifetimes": [ ],
- "performer_restrictions": [ ]
}, - "limits": {
- "max_boxes": 2,
- "max_capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}
}, - "name": "X1-ABC",
- "attributes": [ ]
}, - "device": {
- "phone": "+71112223333",
- "online": true,
- "app_version": "7.21",
- "os_version": "15.0",
- "manufacturer": "samsung",
- "model": "S25 Ultra"
}, - "specification": "User full name",
- "deals": [
- {
- "key": "11111111-2222-3333-4444-555555555555",
- "specification": {
- "crew_key": "mega_crew",
- "wave_key": "11111111-2222-3333-4444-555555555555",
- "trip_key": "trip-0000-9999"
}
}
]
}
{- "key": "mega_crew",
- "username": "username_for_login",
- "company_key": "smart_company",
- "performer": {
- "key": "performer0001",
- "shifts": [
- {
- "key": "shift01",
- "availability_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "working_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "start_location_key": "start_location_01",
- "finish_location_key": "finish_location_01",
- "max_locations": 15,
- "max_stops": 15,
- "tariff": {
- "cost_per_shift": 2000,
- "constraints": [
- {
- "stage_length": "P30D",
- "cost_per_unit": 0.001
}
], - "max_penalty_cost": 2000
}, - "work_and_rest_rules": {
- "rest_rules": {
- "consecutive": {
- "relocating_duration_sum": "PT1H45M",
- "operating_duration_sum": "PT2H12M34.3S",
- "duration": "PT1H45M"
}
}, - "break_rules": {
- "first": {
- "relocating_duration_sum": "PT1H45M",
- "operating_duration_sum": "PT2H12M34.3S",
- "duration": "PT1H45M"
}, - "consecutive": {
- "relocating_duration_sum": "PT1H45M",
- "operating_duration_sum": "PT2H12M34.3S",
- "duration": "PT1H45M"
}, - "relocating_duration_type": "CONTINUOUS"
}, - "reset_location_keys": [
- "location_01"
], - "ignore_location_keys": [
- "location_01"
]
}, - "name": "X1-ABC",
- "attributes": [ ]
}
], - "own_transport_type": "CAR",
- "compatibilities": {
- "performer_features": [ ],
- "performer_features_lifetimes": [ ],
- "transport_restrictions": [ ]
}, - "limits": {
- "max_work_shifts": 3,
- "demand_extra_durations": [
- {
- "demand_key": "demand01.1",
- "additional_duration": "PT1H45M"
}
]
}, - "name": "X1-ABC",
- "attributes": [ ]
}, - "transport": {
- "key": "transport001",
- "shifts": [
- {
- "key": "shift01",
- "availability_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "start_location_key": "start_location_01",
- "finish_location_key": "finish_location_01",
- "tariff": {
- "cost_per_shift": 2000,
- "constraints": [
- {
- "stage_length": 100000000,
- "cost_per_unit": 0.001
}
], - "transportation_cost": {
- "mass": 11,
- "volume": 22,
- "capacity_a": 11,
- "capacity_b": 22,
- "capacity_c": 31
}
}, - "name": "X1-ABC",
- "attributes": [ ]
}
], - "transport_type": "CAR",
- "boxes": [
- {
- "key": "box01",
- "capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}, - "compatibilities": {
- "width": 1,
- "height": 3.1,
- "length": 2.1,
- "box_features": [ ]
}, - "limits": {
- "max_one_cargo_capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}
}
}
], - "compatibilities": {
- "transport_features": [ ],
- "transport_features_lifetimes": [ ],
- "performer_restrictions": [ ]
}, - "limits": {
- "max_boxes": 2,
- "max_capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}
}, - "name": "X1-ABC",
- "attributes": [ ]
}, - "device": {
- "phone": "+71112223333",
- "online": true,
- "app_version": "7.21",
- "os_version": "15.0",
- "manufacturer": "samsung",
- "model": "S25 Ultra"
}, - "specification": "User full name",
- "deals": [
- {
- "key": "11111111-2222-3333-4444-555555555555",
- "specification": {
- "crew_key": "mega_crew",
- "wave_key": "11111111-2222-3333-4444-555555555555",
- "trip_key": "trip-0000-9999"
}
}
]
}
Getting crew information by key.
crew_key required | string (crew_key) [ 3 .. 256 ] characters \w+ Example: mega_crew Parameter (path) with crew key. |
required | object (crew) Crew. |
object (table_crew_fields) Crew fields for table. | |
Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences. |
{- "crew": {
- "key": "mega_crew",
- "username": "username_for_login",
- "company_key": "smart_company",
- "performer": {
- "key": "performer0001",
- "shifts": [
- {
- "key": "shift01",
- "availability_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "working_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "start_location_key": "start_location_01",
- "finish_location_key": "finish_location_01",
- "max_locations": 15,
- "max_stops": 15,
- "tariff": {
- "cost_per_shift": 2000,
- "constraints": [
- {
- "stage_length": "P30D",
- "cost_per_unit": 0.001
}
], - "max_penalty_cost": 2000
}, - "work_and_rest_rules": {
- "rest_rules": {
- "consecutive": {
- "relocating_duration_sum": "PT1H45M",
- "operating_duration_sum": "PT2H12M34.3S",
- "duration": "PT1H45M"
}
}, - "break_rules": {
- "first": {
- "relocating_duration_sum": "PT1H45M",
- "operating_duration_sum": "PT2H12M34.3S",
- "duration": "PT1H45M"
}, - "consecutive": {
- "relocating_duration_sum": "PT1H45M",
- "operating_duration_sum": "PT2H12M34.3S",
- "duration": "PT1H45M"
}, - "relocating_duration_type": "CONTINUOUS"
}, - "reset_location_keys": [
- "location_01"
], - "ignore_location_keys": [
- "location_01"
]
}, - "name": "X1-ABC",
- "attributes": [ ]
}
], - "own_transport_type": "CAR",
- "compatibilities": {
- "performer_features": [ ],
- "performer_features_lifetimes": [ ],
- "transport_restrictions": [ ]
}, - "limits": {
- "max_work_shifts": 3,
- "demand_extra_durations": [
- {
- "demand_key": "demand01.1",
- "additional_duration": "PT1H45M"
}
]
}, - "name": "X1-ABC",
- "attributes": [ ]
}, - "transport": {
- "key": "transport001",
- "shifts": [
- {
- "key": "shift01",
- "availability_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "start_location_key": "start_location_01",
- "finish_location_key": "finish_location_01",
- "tariff": {
- "cost_per_shift": 2000,
- "constraints": [
- {
- "stage_length": 100000000,
- "cost_per_unit": 0.001
}
], - "transportation_cost": {
- "mass": 11,
- "volume": 22,
- "capacity_a": 11,
- "capacity_b": 22,
- "capacity_c": 31
}
}, - "name": "X1-ABC",
- "attributes": [ ]
}
], - "transport_type": "CAR",
- "boxes": [
- {
- "key": "box01",
- "capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}, - "compatibilities": {
- "width": 1,
- "height": 3.1,
- "length": 2.1,
- "box_features": [ ]
}, - "limits": {
- "max_one_cargo_capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}
}
}
], - "compatibilities": {
- "transport_features": [ ],
- "transport_features_lifetimes": [ ],
- "performer_restrictions": [ ]
}, - "limits": {
- "max_boxes": 2,
- "max_capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}
}, - "name": "X1-ABC",
- "attributes": [ ]
}, - "device": {
- "phone": "+71112223333",
- "online": true,
- "app_version": "7.21",
- "os_version": "15.0",
- "manufacturer": "samsung",
- "model": "S25 Ultra"
}, - "specification": "User full name",
- "deals": [
- {
- "key": "11111111-2222-3333-4444-555555555555",
- "specification": {
- "crew_key": "mega_crew",
- "wave_key": "11111111-2222-3333-4444-555555555555",
- "trip_key": "trip-0000-9999"
}
}
]
}, - "fields": {
- "essence_key": "key01",
- "username": "AAA",
- "company_key": "key01",
- "device_phone": "AAA",
- "device_online": true
}, - "linked_essences": [
- {
- "essence_key": "key01",
- "essence_type": "LOCATION"
}
]
}
Removing a crew by key.
crew_key required | string (crew_key) [ 3 .. 256 ] characters \w+ Example: mega_crew Parameter (path) with crew key. |
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Getting a list of crews.
offset | integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set. |
limit | integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return. |
sort_field | string (table_crew_column_type) Default: "USERNAME" Enum: "ESSENCE_KEY" "USERNAME" "COMPANY_KEY" … 2 more Example: sort_field=DEVICE_ONLINE Crew table column name. |
sort_direction | string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction. |
Crews filter.
Array of objects (table_crew_filter) [ 0 .. 50 ] items A list of filters. |
required | Array of objects (table_crew) [ 0 .. 2001 ] items A list. |
required | object (table_list_counters) Counters by list. |
{- "filters": [
- {
- "type": "STRING_SEARCH",
- "column": "ESSENCE_KEY",
- "string_search": {
- "text": "key01",
- "strict": false
}
}
]
}
{- "essences": [
- {
- "fields": {
- "essence_key": "key01",
- "username": "AAA",
- "company_key": "key01",
- "device_phone": "AAA",
- "device_online": true
}
}
], - "counters": {
- "overall": {
- "total": 1
}, - "filter": {
- "total": 1
}
}
}
Batch crews delete.
Request to delete crews.
Unique crew key.
[- "mega_crew"
]
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Getting a crew geopoints.
offset | integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set. |
limit | integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return. |
Crews filter.
Array of objects (table_crew_filter) [ 0 .. 50 ] items A list of filters. |
required | Array of objects (crew_geopoint) [ 0 .. 2001 ] items A list of points. |
required | object (table_list_counters) Counters by list of entities. |
required | object (table_list_counters_detail) Counters by list of points. |
{- "filters": [
- {
- "type": "STRING_SEARCH",
- "column": "ESSENCE_KEY",
- "string_search": {
- "text": "key01",
- "strict": false
}
}
]
}
{- "geopoints": [
- {
- "geopoint": {
- "latitude": 55.692789,
- "longitude": 37.554554
}, - "crew_key": "mega_crew"
}
], - "counters": {
- "overall": {
- "total": 1
}, - "filter": {
- "total": 1
}
}, - "geopoints_counters": {
- "total": 1
}
}
Getting crew information by login.
key required | string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Unique crew key. |
username required | string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Unique username for login. |
company_key required | string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Unique company key. |
required | object (performer) Performer. Fulfills orders using transport. |
required | object (transport) Transport. Used by performer for relocating and cargo transfer. |
object (device) Mobile device. | |
specification | string or null (user_specification) [ 2 .. 256 ] characters Example: "User full name" Crew specification. |
Array of objects (deal_list) [ 0 .. 30 ] items Linked current deals. |
{- "key": "mega_crew",
- "username": "username_for_login",
- "company_key": "smart_company",
- "performer": {
- "key": "performer0001",
- "shifts": [
- {
- "key": "shift01",
- "availability_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "working_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "start_location_key": "start_location_01",
- "finish_location_key": "finish_location_01",
- "max_locations": 15,
- "max_stops": 15,
- "tariff": {
- "cost_per_shift": 2000,
- "constraints": [
- {
- "stage_length": "P30D",
- "cost_per_unit": 0.001
}
], - "max_penalty_cost": 2000
}, - "work_and_rest_rules": {
- "rest_rules": {
- "consecutive": {
- "relocating_duration_sum": "PT1H45M",
- "operating_duration_sum": "PT2H12M34.3S",
- "duration": "PT1H45M"
}
}, - "break_rules": {
- "first": {
- "relocating_duration_sum": "PT1H45M",
- "operating_duration_sum": "PT2H12M34.3S",
- "duration": "PT1H45M"
}, - "consecutive": {
- "relocating_duration_sum": "PT1H45M",
- "operating_duration_sum": "PT2H12M34.3S",
- "duration": "PT1H45M"
}, - "relocating_duration_type": "CONTINUOUS"
}, - "reset_location_keys": [
- "location_01"
], - "ignore_location_keys": [
- "location_01"
]
}, - "name": "X1-ABC",
- "attributes": [ ]
}
], - "own_transport_type": "CAR",
- "compatibilities": {
- "performer_features": [ ],
- "performer_features_lifetimes": [ ],
- "transport_restrictions": [ ]
}, - "limits": {
- "max_work_shifts": 3,
- "demand_extra_durations": [
- {
- "demand_key": "demand01.1",
- "additional_duration": "PT1H45M"
}
]
}, - "name": "X1-ABC",
- "attributes": [ ]
}, - "transport": {
- "key": "transport001",
- "shifts": [
- {
- "key": "shift01",
- "availability_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "start_location_key": "start_location_01",
- "finish_location_key": "finish_location_01",
- "tariff": {
- "cost_per_shift": 2000,
- "constraints": [
- {
- "stage_length": 100000000,
- "cost_per_unit": 0.001
}
], - "transportation_cost": {
- "mass": 11,
- "volume": 22,
- "capacity_a": 11,
- "capacity_b": 22,
- "capacity_c": 31
}
}, - "name": "X1-ABC",
- "attributes": [ ]
}
], - "transport_type": "CAR",
- "boxes": [
- {
- "key": "box01",
- "capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}, - "compatibilities": {
- "width": 1,
- "height": 3.1,
- "length": 2.1,
- "box_features": [ ]
}, - "limits": {
- "max_one_cargo_capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}
}
}
], - "compatibilities": {
- "transport_features": [ ],
- "transport_features_lifetimes": [ ],
- "performer_restrictions": [ ]
}, - "limits": {
- "max_boxes": 2,
- "max_capacity": {
- "mass": 10,
- "volume": 2,
- "capacity_a": 1,
- "capacity_b": 2,
- "capacity_c": 3
}
}, - "name": "X1-ABC",
- "attributes": [ ]
}, - "device": {
- "phone": "+71112223333",
- "online": true,
- "app_version": "7.21",
- "os_version": "15.0",
- "manufacturer": "samsung",
- "model": "S25 Ultra"
}, - "specification": "User full name",
- "deals": [
- {
- "key": "11111111-2222-3333-4444-555555555555",
- "specification": {
- "crew_key": "mega_crew",
- "wave_key": "11111111-2222-3333-4444-555555555555",
- "trip_key": "trip-0000-9999"
}
}
]
}
Getting a crew trips by login.
required | object (trip) A trip is a set of works planned to be performed by a specific performer on a specific transport, expressed through a change in the states of the performer. |
required | object (trip_statistics) Statistics for a specific trip. |
object (table_trip_fields) Trip\stops fields for table. | |
Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences. |
[- {
- "trip": {
- "key": "trip-0000-9999",
- "performer": {
- "performer_key": "performer0001",
- "shift_key": "performer0001_shift01",
- "shift_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}
}, - "transport": {
- "transport_key": "transport001",
- "shift_key": "performer01",
- "shift_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}
}, - "states": [
- {
- "time": "2025-09-21T09:30:00+03:00",
- "order_key": "order01",
- "demand_key": "demand01.1",
- "event_key": "event01",
- "location_key": "location_01",
- "flags": [
- "RELOCATING"
], - "cargo_actions": [
- {
- "box_key": "box01",
- "cargo_key": "cargo01",
- "cargo_action_type": "ADD"
}
], - "distance": 5200,
- "cost": 1231.1,
- "reward": 2343.3,
- "attributes": [ ]
}
], - "waitlist": [
- "order02"
], - "name": "X1-ABC",
- "attributes": [ ]
}, - "trip_statistics": {
- "trip_key": "trip01",
- "general_statistics": {
- "cost": 1231.1,
- "reward": 2343.3,
- "profit": 1231.1,
- "measurements": {
- "time_window": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "driving_time": "PT1H45M",
- "waiting_time": "PT1H45M",
- "working_time": "PT1H45M",
- "break_time": "PT1H45M",
- "rest_time": "PT1H45M",
- "arriving_time": "PT1H45M",
- "departure_time": "PT1H45M",
- "total_time": "PT1H45M",
- "distance": 5200
}, - "trips_count": 250,
- "performers_count": 157,
- "orders_count": 1700,
- "plan_orders_count": 1003,
- "waitlist_orders_count": 697,
- "stops_count": 87,
- "locations_count": 45,
- "cargo_capacity_sum": {
- "mass": 105500,
- "volume": 220034,
- "capacity_a": 100000,
- "capacity_b": 200000,
- "capacity_c": 300000
}, - "cargo_capacity_ratio": {
- "mass": 0.5,
- "volume": 0.1,
- "capacity_a": 0.7,
- "capacity_b": 0.8,
- "capacity_c": 0.9
}, - "max_transport_load": {
- "mass": 0.5,
- "volume": 0.1,
- "capacity_a": 0.7,
- "capacity_b": 0.8,
- "capacity_c": 0.9
}, - "average_speed": 43.1,
- "round_trips_count": 2,
- "average_roundtrip_distance": 23.4,
- "average_roundtrip_time": "PT1H45M",
- "attributes": [ ]
}, - "load_statistics": {
- "total_load": {
- "count": 1460,
- "capacity": {
- "mass": 105500,
- "volume": 220034,
- "capacity_a": 100000,
- "capacity_b": 200000,
- "capacity_c": 300000
}
}, - "max_load": {
- "count": 1460,
- "capacity": {
- "mass": 105500,
- "volume": 220034,
- "capacity_a": 100000,
- "capacity_b": 200000,
- "capacity_c": 300000
}
}, - "max_transfer_load": {
- "count": 1460,
- "capacity": {
- "mass": 105500,
- "volume": 220034,
- "capacity_a": 100000,
- "capacity_b": 200000,
- "capacity_c": 300000
}
}
}, - "stop_statistics": [
- {
- "location_key": "location_01",
- "stop_demands": [
- {
- "demand_key": "demand_key_01",
- "event_key": "event_key_01",
- "demand_time_window": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}
}
], - "stop_time_window": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "measurements": {
- "time_window": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "driving_time": "PT1H45M",
- "waiting_time": "PT1H45M",
- "working_time": "PT1H45M",
- "break_time": "PT1H45M",
- "rest_time": "PT1H45M",
- "arriving_time": "PT1H45M",
- "departure_time": "PT1H45M",
- "total_time": "PT1H45M",
- "distance": 5200
}, - "upload": {
- "count": 1460,
- "capacity": {
- "mass": 105500,
- "volume": 220034,
- "capacity_a": 100000,
- "capacity_b": 200000,
- "capacity_c": 300000
}
}, - "download": {
- "count": 1460,
- "capacity": {
- "mass": 105500,
- "volume": 220034,
- "capacity_a": 100000,
- "capacity_b": 200000,
- "capacity_c": 300000
}
}, - "max_load": {
- "count": 1460,
- "capacity": {
- "mass": 105500,
- "volume": 220034,
- "capacity_a": 100000,
- "capacity_b": 200000,
- "capacity_c": 300000
}
}, - "arrival_load": {
- "count": 1460,
- "capacity": {
- "mass": 105500,
- "volume": 220034,
- "capacity_a": 100000,
- "capacity_b": 200000,
- "capacity_c": 300000
}
}, - "departure_load": {
- "count": 1460,
- "capacity": {
- "mass": 105500,
- "volume": 220034,
- "capacity_a": 100000,
- "capacity_b": 200000,
- "capacity_c": 300000
}
}, - "attributes": [ ]
}
], - "roundtrip_statistics": [
- {
- "roundtrip_key": "trip_01_round_02",
- "general_statistics": {
- "cost": 1231.1,
- "reward": 2343.3,
- "profit": 1231.1,
- "measurements": {
- "time_window": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "driving_time": "PT1H45M",
- "waiting_time": "PT1H45M",
- "working_time": "PT1H45M",
- "break_time": "PT1H45M",
- "rest_time": "PT1H45M",
- "arriving_time": "PT1H45M",
- "departure_time": "PT1H45M",
- "total_time": "PT1H45M",
- "distance": 5200
}, - "trips_count": 250,
- "performers_count": 157,
- "orders_count": 1700,
- "plan_orders_count": 1003,
- "waitlist_orders_count": 697,
- "stops_count": 87,
- "locations_count": 45,
- "cargo_capacity_sum": {
- "mass": 105500,
- "volume": 220034,
- "capacity_a": 100000,
- "capacity_b": 200000,
- "capacity_c": 300000
}, - "cargo_capacity_ratio": {
- "mass": 0.5,
- "volume": 0.1,
- "capacity_a": 0.7,
- "capacity_b": 0.8,
- "capacity_c": 0.9
}, - "max_transport_load": {
- "mass": 0.5,
- "volume": 0.1,
- "capacity_a": 0.7,
- "capacity_b": 0.8,
- "capacity_c": 0.9
}, - "average_speed": 43.1,
- "round_trips_count": 2,
- "average_roundtrip_distance": 23.4,
- "average_roundtrip_time": "PT1H45M",
- "attributes": [ ]
}
}
], - "attributes": [ ]
}, - "fields": {
- "essence_type": "TRIP",
- "essence_key": "key01",
- "trip_name": "X1-ABC",
- "crew_key": "mega_crew",
- "cost": 1231.1,
- "reward": 2343.3,
- "profit": 1231.1,
- "driving_time": "PT1H45M",
- "waiting_time": "PT1H45M",
- "break_time": "PT1H45M",
- "rest_time": "PT1H45M",
- "working_time": "PT1H45M",
- "arriving_time": "PT1H45M",
- "departure_time": "PT1H45M",
- "total_time": "PT1H45M",
- "distance": 5200,
- "time_window": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "orders_count": 1700,
- "plan_orders_count": 1003,
- "waitlist_orders_count": 697,
- "stops_count": 87,
- "locations_count": 45,
- "cargo_capacity_ratio_mass": 10,
- "cargo_capacity_ratio_volume": 2,
- "cargo_capacity_ratio_capacity_a": 1,
- "cargo_capacity_ratio_capacity_b": 2,
- "cargo_capacity_ratio_capacity_c": 3,
- "max_transport_load_mass": 0.1,
- "max_transport_load_volume": 0.1,
- "max_transport_load_capacity_a": 0.1,
- "max_transport_load_capacity_b": 0.1,
- "max_transport_load_capacity_c": 0.1,
- "attributes": "key1:value1, key2:value2",
- "customfields": {
- "datetime_1": "2025-09-21T18:00:00+03:00",
- "datetime_2": "2025-09-21T18:00:00+03:00",
- "datetime_3": "2025-09-21T18:00:00+03:00",
- "datetime_4": "2025-09-21T18:00:00+03:00",
- "datetime_5": "2025-09-21T18:00:00+03:00",
- "int_1": 1,
- "int_2": 1,
- "int_3": 1,
- "int_4": 1,
- "int_5": 1,
- "float_1": 2343.3,
- "float_2": 2343.3,
- "float_3": 2343.3,
- "float_4": 2343.3,
- "float_5": 2343.3,
- "duration_1": "PT2H12M34.3S",
- "duration_2": "PT2H12M34.3S",
- "duration_3": "PT2H12M34.3S",
- "duration_4": "PT2H12M34.3S",
- "duration_5": "PT2H12M34.3S",
- "bool_1": true,
- "bool_2": true,
- "bool_3": true,
- "bool_4": true,
- "bool_5": true,
- "string_1": "value01",
- "string_2": "value01",
- "string_3": "value01",
- "string_4": "value01",
- "string_5": "value01"
}
}, - "linked_essences": [
- {
- "essence_key": "key01",
- "essence_type": "LOCATION"
}
]
}
]
New deal creation.
Deal creation request.
crew_key required | string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Unique crew key. |
wave_key required | string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Key, unique identifier. |
trip_key required | string [ 1 .. 1024 ] characters Example: "trip-0000-9999" Unique trip identifier. |
key required | string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Unique deal identifier. |
required | object (deal_specification) Deal description. |
{- "crew_key": "mega_crew",
- "wave_key": "11111111-2222-3333-4444-555555555555",
- "trip_key": "trip-0000-9999"
}
{- "key": "11111111-2222-3333-4444-555555555555",
- "specification": {
- "crew_key": "mega_crew",
- "wave_key": "11111111-2222-3333-4444-555555555555",
- "trip_key": "trip-0000-9999"
}
}
Updating the deal information.
Deal update request.
key required | string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Unique deal identifier. |
required | object (deal_specification) Deal description. |
key required | string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Unique deal identifier. |
required | object (deal_specification) Deal description. |
{- "key": "11111111-2222-3333-4444-555555555555",
- "specification": {
- "crew_key": "mega_crew",
- "wave_key": "11111111-2222-3333-4444-555555555555",
- "trip_key": "trip-0000-9999"
}
}
{- "key": "11111111-2222-3333-4444-555555555555",
- "specification": {
- "crew_key": "mega_crew",
- "wave_key": "11111111-2222-3333-4444-555555555555",
- "trip_key": "trip-0000-9999"
}
}
Getting deal information by key.
deal_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
key required | string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Unique deal identifier. |
required | object (deal_specification) Deal description. |
{- "key": "11111111-2222-3333-4444-555555555555",
- "specification": {
- "crew_key": "mega_crew",
- "wave_key": "11111111-2222-3333-4444-555555555555",
- "trip_key": "trip-0000-9999"
}
}
Removing a deal by key.
deal_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Create new wave.
wave create request.
name required | string [ 1 .. 100 ] characters Example: "wave_1" Wave name. |
comment required | string or null [ 0 .. 10000 ] characters Default: null Example: "long long long long text" Wave comment. |
folder_key required | string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Parent folder key. |
New wave key.
{- "name": "wave_1",
- "comment": "long long long long text",
- "folder_key": "11111111-2222-3333-4444-555555555555"
}
"11111111-2222-3333-4444-555555555555"
Getting wave information by key.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
key required | string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Key, unique identifier. |
required | object (wave_specification) Wave description. |
required | object (experiment_settings) Experiment settings. |
required | object (experiment_statistics) Experiment statistics. |
object or null (calculation_state) Current calculation state. | |
object or null (experiment_check) The result of checking the data on the file. | |
edit_date required | |
creation_date required |
{- "key": "da4e62b0-86cb-4423-b187-5c1a633ca703",
- "specification": {
- "name": "new wave 3000",
- "comment": "just run it",
- "folder_key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091"
}, - "settings": {
- "plan_settings": {
- "trips_settings": {
- "configuration": "default",
- "assumptions": {
- "disable_compatibility": false,
- "disable_capacity": false,
- "same_order_time_window": false,
- "expand_shift_time_window": false
}, - "penalties": {
- "compatibilities": [ ]
}
}, - "geo_settings": {
- "geo_provider": "VRT",
- "toll_roads": true,
- "ferry_crossing": true,
- "traffic_jams": true,
- "flight_distance": false
}, - "calculation_settings": {
- "max_calculation_time": "PT20M",
- "max_waiting_time": "PT30M",
- "result_ttl": "PT20M",
- "result_timezone": 0,
- "treat_warnings_as_errors": false,
- "precision": 2
}
}, - "actualize_settings": {
- "current_time": "2025-09-07T22:30:00Z",
- "max_delay_duration": "PT1H"
}, - "replan_settings": {
- "replan_strategy": {
- "reorder": true,
- "plan_new_orders": true,
- "create_new_trips": true
}
}
}, - "statistics": {
- "indicators": [
- "data_statistics_hardlinks",
- "data_statistics_locations",
- "data_statistics_orders",
- "data_statistics_performers",
- "data_statistics_transports",
- "data_statistics_trips",
- "data_statistics_facts",
- "total_statistics_max_transport_load_capacity_a",
- "total_statistics_max_transport_load_capacity_b",
- "total_statistics_max_transport_load_capacity_c",
- "total_statistics_max_transport_load_mass",
- "total_statistics_max_transport_load_volume",
- "total_statistics_cargo_capacity_ratio_capacity_a",
- "total_statistics_cargo_capacity_ratio_capacity_b",
- "total_statistics_cargo_capacity_ratio_capacity_c",
- "total_statistics_cargo_capacity_ratio_mass",
- "total_statistics_cargo_capacity_ratio_volume",
- "total_statistics_cost",
- "total_statistics_measurements_arriving_time",
- "total_statistics_measurements_departure_time",
- "total_statistics_measurements_distance",
- "total_statistics_measurements_driving_time",
- "total_statistics_measurements_time_window_from",
- "total_statistics_measurements_time_window_to",
- "total_statistics_measurements_total_time",
- "total_statistics_measurements_waiting_time",
- "total_statistics_measurements_working_time",
- "total_statistics_orders_count",
- "total_statistics_performers_count",
- "total_statistics_plan_orders_count",
- "quality_hard_time_window_violations_after_count",
- "quality_hard_time_window_violations_before_count",
- "quality_soft_time_window_violations_after_count",
- "quality_soft_time_window_violations_before_count",
- "total_statistics_reward",
- "total_statistics_waitlist_orders_count"
], - "total_statistics": {
- "profit": 1,
- "cost": 0,
- "reward": 0,
- "measurements": {
- "driving_time": "P0D",
- "waiting_time": "P0D",
- "break_time": "P0D",
- "rest_time": "PT0S",
- "working_time": "P0D",
- "arriving_time": "P0D",
- "departure_time": "P0D",
- "total_time": "P0D",
- "distance": 0,
- "time_window": {
- "from": "2025-09-15T13:56:07.697Z",
- "to": "2025-09-15T13:56:07.697Z"
}
}, - "performers_count": 0,
- "trips_count": 0,
- "orders_count": 0,
- "plan_orders_count": 0,
- "waitlist_orders_count": 0,
- "stops_count": 1,
- "locations_count": 1,
- "average_speed": 45.2,
- "round_trips_count": 1,
- "cargo_capacity_sum": {
- "mass": 1.9,
- "volume": 2,
- "capacity_a": 3,
- "capacity_b": 1,
- "capacity_c": 1
}, - "cargo_capacity_ratio": {
- "mass": 0,
- "volume": 0,
- "capacity_a": 0,
- "capacity_b": 0,
- "capacity_c": 0
}, - "max_transport_load": {
- "mass": 0,
- "volume": 0,
- "capacity_a": 0,
- "capacity_b": 0,
- "capacity_c": 0
}
}, - "quality": {
- "locations_limits_penalty": 0,
- "soft_time_window_violations": {
- "before": {
- "demand_keys": [ ],
- "count": 0
}, - "after": {
- "demand_keys": [ ],
- "count": 0
}
}, - "hard_time_window_violations": {
- "before": {
- "demand_keys": [ ],
- "count": 0
}, - "after": {
- "demand_keys": [ ],
- "count": 0
}
}
}, - "task_statistics": {
- "planning_horizon": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}
}, - "data_statistics": {
- "locations": 958,
- "orders": 1000,
- "performers": 1000,
- "transports": 1000,
- "hardlinks": 0,
- "trips": 0,
- "facts": 1,
- "external_routing": false
}
}, - "edit_date": "2025-09-15T13:56:07.728Z",
- "creation_date": "2025-09-15T13:56:07.728Z"
}
Rename \ move wave.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
wave specification update request.
name required | string [ 1 .. 100 ] characters Example: "wave_1" Wave name. |
comment required | string or null [ 0 .. 10000 ] characters Default: null Example: "long long long long text" Wave comment. |
folder_key required | string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Parent folder key. |
key required | string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Key, unique identifier. |
required | object (wave_specification) Wave description. |
required | object (experiment_settings) Experiment settings. |
required | object (experiment_statistics) Experiment statistics. |
object or null (calculation_state) Current calculation state. | |
object or null (experiment_check) The result of checking the data on the file. | |
edit_date required | |
creation_date required |
{- "name": "wave_1",
- "comment": "long long long long text",
- "folder_key": "11111111-2222-3333-4444-555555555555"
}
{- "key": "da4e62b0-86cb-4423-b187-5c1a633ca703",
- "specification": {
- "name": "new wave 3000",
- "comment": "just run it",
- "folder_key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091"
}, - "settings": {
- "plan_settings": {
- "trips_settings": {
- "configuration": "default",
- "assumptions": {
- "disable_compatibility": false,
- "disable_capacity": false,
- "same_order_time_window": false,
- "expand_shift_time_window": false
}, - "penalties": {
- "compatibilities": [ ]
}
}, - "geo_settings": {
- "geo_provider": "VRT",
- "toll_roads": true,
- "ferry_crossing": true,
- "traffic_jams": true,
- "flight_distance": false
}, - "calculation_settings": {
- "max_calculation_time": "PT20M",
- "max_waiting_time": "PT30M",
- "result_ttl": "PT20M",
- "result_timezone": 0,
- "treat_warnings_as_errors": false,
- "precision": 2
}
}, - "actualize_settings": {
- "current_time": "2025-09-07T22:30:00Z",
- "max_delay_duration": "PT1H"
}, - "replan_settings": {
- "replan_strategy": {
- "reorder": true,
- "plan_new_orders": true,
- "create_new_trips": true
}
}
}, - "statistics": {
- "indicators": [
- "data_statistics_hardlinks",
- "data_statistics_locations",
- "data_statistics_orders",
- "data_statistics_performers",
- "data_statistics_transports",
- "data_statistics_trips",
- "data_statistics_facts",
- "total_statistics_max_transport_load_capacity_a",
- "total_statistics_max_transport_load_capacity_b",
- "total_statistics_max_transport_load_capacity_c",
- "total_statistics_max_transport_load_mass",
- "total_statistics_max_transport_load_volume",
- "total_statistics_cargo_capacity_ratio_capacity_a",
- "total_statistics_cargo_capacity_ratio_capacity_b",
- "total_statistics_cargo_capacity_ratio_capacity_c",
- "total_statistics_cargo_capacity_ratio_mass",
- "total_statistics_cargo_capacity_ratio_volume",
- "total_statistics_cost",
- "total_statistics_measurements_arriving_time",
- "total_statistics_measurements_departure_time",
- "total_statistics_measurements_distance",
- "total_statistics_measurements_driving_time",
- "total_statistics_measurements_time_window_from",
- "total_statistics_measurements_time_window_to",
- "total_statistics_measurements_total_time",
- "total_statistics_measurements_waiting_time",
- "total_statistics_measurements_working_time",
- "total_statistics_orders_count",
- "total_statistics_performers_count",
- "total_statistics_plan_orders_count",
- "quality_hard_time_window_violations_after_count",
- "quality_hard_time_window_violations_before_count",
- "quality_soft_time_window_violations_after_count",
- "quality_soft_time_window_violations_before_count",
- "total_statistics_reward",
- "total_statistics_waitlist_orders_count"
], - "total_statistics": {
- "profit": 1,
- "cost": 0,
- "reward": 0,
- "measurements": {
- "driving_time": "P0D",
- "waiting_time": "P0D",
- "break_time": "P0D",
- "rest_time": "PT0S",
- "working_time": "P0D",
- "arriving_time": "P0D",
- "departure_time": "P0D",
- "total_time": "P0D",
- "distance": 0,
- "time_window": {
- "from": "2025-09-15T13:56:07.697Z",
- "to": "2025-09-15T13:56:07.697Z"
}
}, - "performers_count": 0,
- "trips_count": 0,
- "orders_count": 0,
- "plan_orders_count": 0,
- "waitlist_orders_count": 0,
- "stops_count": 1,
- "locations_count": 1,
- "average_speed": 45.2,
- "round_trips_count": 1,
- "cargo_capacity_sum": {
- "mass": 1.9,
- "volume": 2,
- "capacity_a": 3,
- "capacity_b": 1,
- "capacity_c": 1
}, - "cargo_capacity_ratio": {
- "mass": 0,
- "volume": 0,
- "capacity_a": 0,
- "capacity_b": 0,
- "capacity_c": 0
}, - "max_transport_load": {
- "mass": 0,
- "volume": 0,
- "capacity_a": 0,
- "capacity_b": 0,
- "capacity_c": 0
}
}, - "quality": {
- "locations_limits_penalty": 0,
- "soft_time_window_violations": {
- "before": {
- "demand_keys": [ ],
- "count": 0
}, - "after": {
- "demand_keys": [ ],
- "count": 0
}
}, - "hard_time_window_violations": {
- "before": {
- "demand_keys": [ ],
- "count": 0
}, - "after": {
- "demand_keys": [ ],
- "count": 0
}
}
}, - "task_statistics": {
- "planning_horizon": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}
}, - "data_statistics": {
- "locations": 958,
- "orders": 1000,
- "performers": 1000,
- "transports": 1000,
- "hardlinks": 0,
- "trips": 0,
- "facts": 1,
- "external_routing": false
}
}, - "edit_date": "2025-09-15T13:56:07.728Z",
- "creation_date": "2025-09-15T13:56:07.728Z"
}
Wave removal by key.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Getting a table with wave.
folder_key | string or null <uuid> (unique_key_null) Default: null Example: folder_key=11111111-2222-3333-4444-555555555555 Folder key, unique identifier. |
offset | integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set. |
limit | integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return. |
sort_field | string (table_wave_column_type) Default: "SPECIFICATION_NAME" Enum: "ESSENCE_KEY" "SPECIFICATION_NAME" "SPECIFICATION_COMMENT" … 1 more Example: sort_field=SPECIFICATION_FOLDER_KEY Wave table column name. |
sort_direction | string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction. |
Waves filter.
Array of objects (table_wave_filter) [ 0 .. 50 ] items A list of filters. |
required | Array of objects (table_wave) [ 0 .. 2001 ] items A list. |
required | object (table_list_counters) Counters by list. |
{- "filters": [
- {
- "type": "STRING_SEARCH",
- "column": "ESSENCE_KEY",
- "string_search": {
- "text": "key01",
- "strict": false
}
}
]
}
{- "essences": [
- {
- "fields": {
- "essence_key": "wave1",
- "specification_folder_key": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
}
], - "counters": {
- "overall": {
- "total": 1
}, - "filter": {
- "total": 1
}
}
}
Batch waves delete.
Request to delete waves.
Key, unique identifier.
[- "11111111-2222-3333-4444-555555555555"
]
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Wave duplicate.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
wave duplicate request.
name required | string [ 1 .. 100 ] characters Example: "wave_1" Wave name. |
comment required | string or null [ 0 .. 10000 ] characters Default: null Example: "long long long long text" Wave comment. |
folder_key required | string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Parent folder key. |
Duplicated wave key.
{- "name": "wave_1",
- "comment": "long long long long text",
- "folder_key": "11111111-2222-3333-4444-555555555555"
}
"11111111-2222-3333-4444-555555555555"
Wave path.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
required | Array of objects (folder) [ 0 .. 1000 ] items List of folders. |
{- "folders": [
- {
- "key": "11111111-2222-3333-4444-555555555555",
- "type": "FOLDER",
- "parent_key": "11111111-2222-3333-4444-555555555555",
- "name": "folder_1",
- "comment": "long long long long text",
- "color": "red",
- "attributes": [ ],
- "owner_company_key": "smart_company",
- "owner_username": "username_for_login",
- "creation_date": "2025-09-21T19:45:00Z",
- "counters": {
- "folders_count": 12,
- "files_count": 16
}
}
]
}
Importing new data from an XLSX file. If an entity is already present (determined by its key), it is updated. If not, a new one is created. The data time zone is taken from the XLSX file.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
Data (XLSX).
File with data in XLSX format.
key required | string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Key, unique identifier. |
required | object (wave_specification) Wave description. |
required | object (experiment_settings) Experiment settings. |
required | object (experiment_statistics) Experiment statistics. |
object or null (calculation_state) Current calculation state. | |
object or null (experiment_check) The result of checking the data on the file. | |
edit_date required | |
creation_date required |
{- "key": "da4e62b0-86cb-4423-b187-5c1a633ca703",
- "specification": {
- "name": "new wave 3000",
- "comment": "just run it",
- "folder_key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091"
}, - "settings": {
- "plan_settings": {
- "trips_settings": {
- "configuration": "default",
- "assumptions": {
- "disable_compatibility": false,
- "disable_capacity": false,
- "same_order_time_window": false,
- "expand_shift_time_window": false
}, - "penalties": {
- "compatibilities": [ ]
}
}, - "geo_settings": {
- "geo_provider": "VRT",
- "toll_roads": true,
- "ferry_crossing": true,
- "traffic_jams": true,
- "flight_distance": false
}, - "calculation_settings": {
- "max_calculation_time": "PT20M",
- "max_waiting_time": "PT30M",
- "result_ttl": "PT20M",
- "result_timezone": 0,
- "treat_warnings_as_errors": false,
- "precision": 2
}
}, - "actualize_settings": {
- "current_time": "2025-09-07T22:30:00Z",
- "max_delay_duration": "PT1H"
}, - "replan_settings": {
- "replan_strategy": {
- "reorder": true,
- "plan_new_orders": true,
- "create_new_trips": true
}
}
}, - "statistics": {
- "indicators": [
- "data_statistics_hardlinks",
- "data_statistics_locations",
- "data_statistics_orders",
- "data_statistics_performers",
- "data_statistics_transports",
- "data_statistics_trips",
- "data_statistics_facts",
- "total_statistics_max_transport_load_capacity_a",
- "total_statistics_max_transport_load_capacity_b",
- "total_statistics_max_transport_load_capacity_c",
- "total_statistics_max_transport_load_mass",
- "total_statistics_max_transport_load_volume",
- "total_statistics_cargo_capacity_ratio_capacity_a",
- "total_statistics_cargo_capacity_ratio_capacity_b",
- "total_statistics_cargo_capacity_ratio_capacity_c",
- "total_statistics_cargo_capacity_ratio_mass",
- "total_statistics_cargo_capacity_ratio_volume",
- "total_statistics_cost",
- "total_statistics_measurements_arriving_time",
- "total_statistics_measurements_departure_time",
- "total_statistics_measurements_distance",
- "total_statistics_measurements_driving_time",
- "total_statistics_measurements_time_window_from",
- "total_statistics_measurements_time_window_to",
- "total_statistics_measurements_total_time",
- "total_statistics_measurements_waiting_time",
- "total_statistics_measurements_working_time",
- "total_statistics_orders_count",
- "total_statistics_performers_count",
- "total_statistics_plan_orders_count",
- "quality_hard_time_window_violations_after_count",
- "quality_hard_time_window_violations_before_count",
- "quality_soft_time_window_violations_after_count",
- "quality_soft_time_window_violations_before_count",
- "total_statistics_reward",
- "total_statistics_waitlist_orders_count"
], - "total_statistics": {
- "profit": 1,
- "cost": 0,
- "reward": 0,
- "measurements": {
- "driving_time": "P0D",
- "waiting_time": "P0D",
- "break_time": "P0D",
- "rest_time": "PT0S",
- "working_time": "P0D",
- "arriving_time": "P0D",
- "departure_time": "P0D",
- "total_time": "P0D",
- "distance": 0,
- "time_window": {
- "from": "2025-09-15T13:56:07.697Z",
- "to": "2025-09-15T13:56:07.697Z"
}
}, - "performers_count": 0,
- "trips_count": 0,
- "orders_count": 0,
- "plan_orders_count": 0,
- "waitlist_orders_count": 0,
- "stops_count": 1,
- "locations_count": 1,
- "average_speed": 45.2,
- "round_trips_count": 1,
- "cargo_capacity_sum": {
- "mass": 1.9,
- "volume": 2,
- "capacity_a": 3,
- "capacity_b": 1,
- "capacity_c": 1
}, - "cargo_capacity_ratio": {
- "mass": 0,
- "volume": 0,
- "capacity_a": 0,
- "capacity_b": 0,
- "capacity_c": 0
}, - "max_transport_load": {
- "mass": 0,
- "volume": 0,
- "capacity_a": 0,
- "capacity_b": 0,
- "capacity_c": 0
}
}, - "quality": {
- "locations_limits_penalty": 0,
- "soft_time_window_violations": {
- "before": {
- "demand_keys": [ ],
- "count": 0
}, - "after": {
- "demand_keys": [ ],
- "count": 0
}
}, - "hard_time_window_violations": {
- "before": {
- "demand_keys": [ ],
- "count": 0
}, - "after": {
- "demand_keys": [ ],
- "count": 0
}
}
}, - "task_statistics": {
- "planning_horizon": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}
}, - "data_statistics": {
- "locations": 958,
- "orders": 1000,
- "performers": 1000,
- "transports": 1000,
- "hardlinks": 0,
- "trips": 0,
- "facts": 1,
- "external_routing": false
}
}, - "edit_date": "2025-09-15T13:56:07.728Z",
- "creation_date": "2025-09-15T13:56:07.728Z"
}
Importing new data from VRt.Universal JSON file. If the entity is already present (determined by its key), it is updated. If not, a new one is created.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
Data (JSON).
Array of objects (location_list) [ 0 .. 15001 ] items unique List of locations used for orders and shifts. | |
Array of objects (order_list) [ 0 .. 15001 ] items unique List of orders that need to be completed. | |
Array of objects (performer_list) [ 0 .. 15001 ] items unique Available performers list. The performer fulfills orders using transport. | |
Array of objects (transport_list) [ 0 .. 15001 ] items unique Available transports list. Transport is used by the trip performer to fulfill orders. | |
Array of objects (hardlink_list) [ 0 .. 15001 ] items unique Assignments list. | |
Array of objects (trip_list) [ 0 .. 15001 ] items unique Trip list. A trip is a set of works planned to be performed by a specific performer on a specific transport, expressed through a change in the states of the performer. | |
Array of objects (fact_list) [ 0 .. 15001 ] items unique Trip list. A fact is an event that has occurred that affects further trip operations. | |
object or null (plan_statistics) General statistics on the calculation result. | |
Array of objects (routing_transport_matrix_list) [ 0 .. 16 ] items unique List of matrices of times and distances for each type of transport that are indicated in the data.
The matrix should describe all locations for each type of transport from the data.
When specifying an external routing matrix | |
object (plan_settings) Planning settings. | |
object (replan_settings) Replanning settings. | |
object (actualize_settings) Actualize settings. | |
dataset_name | string (dataset_name) [ 0 .. 512 ] characters Example: "custom_dataset_one" The name of the dataset. A technical field that does not affect calculation. |
key required | string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Key, unique identifier. |
required | object (wave_specification) Wave description. |
required | object (experiment_settings) Experiment settings. |
required | object (experiment_statistics) Experiment statistics. |
object or null (calculation_state) Current calculation state. | |
object or null (experiment_check) The result of checking the data on the file. | |
edit_date required | |
creation_date required |
{- "locations": [
- {
- "key": "location_client_1",
- "geopoint": {
- "latitude": 55.713699,
- "longitude": 37.621839
}
}, - {
- "key": "location_client_2",
- "geopoint": {
- "latitude": 55.630721,
- "longitude": 37.62493
}
}, - {
- "key": "location_client_3",
- "geopoint": {
- "latitude": 55.722801,
- "longitude": 37.674984
}
}, - {
- "key": "location_storage",
- "geopoint": {
- "latitude": 55.685853,
- "longitude": 37.43181
}
}
], - "orders": [
- {
- "key": "order_1",
- "demands": [
- {
- "key": "demand_1_drop",
- "demand_type": "DROP",
- "target_cargos": [
- "order_1_cargos"
], - "possible_events": [
- {
- "key": "demand_1_drop_event",
- "location_key": "location_client_1",
- "duration": "PT10M",
- "hard_time_window": {
- "from": "2025-09-08T05:00:00+00:00",
- "to": "2025-09-08T07:00:00+00:00"
}
}
]
}, - {
- "key": "demand_1_pickup",
- "demand_type": "PICKUP",
- "target_cargos": [
- "order_1_cargos"
], - "possible_events": [
- {
- "key": "demand_1_pickup_event",
- "location_key": "location_storage",
- "duration": "P0D",
- "reward": 0,
- "hard_time_window": {
- "from": "2025-09-07T21:00:00+00:00",
- "to": "2025-09-08T20:59:59+00:00"
}
}
]
}
], - "cargos": [
- {
- "key": "order_1_cargos",
- "capacity": {
- "mass": 1
}
}
]
}, - {
- "key": "order_2",
- "demands": [
- {
- "key": "demand_2_drop",
- "demand_type": "DROP",
- "target_cargos": [
- "order_2_cargos"
], - "possible_events": [
- {
- "key": "demand_2_drop_event",
- "location_key": "location_client_2",
- "duration": "PT10M",
- "hard_time_window": {
- "from": "2025-09-08T05:00:00+00:00",
- "to": "2025-09-08T07:00:00+00:00"
}
}
]
}, - {
- "key": "demand_2_pickup",
- "demand_type": "PICKUP",
- "target_cargos": [
- "order_2_cargos"
], - "possible_events": [
- {
- "key": "demand_2_pickup_event",
- "location_key": "location_storage",
- "duration": "P0D",
- "reward": 0,
- "hard_time_window": {
- "from": "2025-09-07T21:00:00+00:00",
- "to": "2025-09-08T20:59:59+00:00"
}
}
]
}
], - "cargos": [
- {
- "key": "order_2_cargos",
- "capacity": {
- "mass": 1
}
}
]
}, - {
- "key": "order_3",
- "demands": [
- {
- "key": "demand_3_work",
- "demand_type": "WORK",
- "possible_events": [
- {
- "key": "demand_3_work_event",
- "location_key": "location_client_3",
- "duration": "PT15M",
- "hard_time_window": {
- "from": "2025-09-08T05:00:00+00:00",
- "to": "2025-09-08T07:00:00+00:00"
}
}
]
}
]
}
], - "performers": [
- {
- "key": "performer_1",
- "shifts": [
- {
- "key": "performer_1_shift",
- "availability_time": {
- "from": "2025-09-07T21:00:00+00:00",
- "to": "2025-09-08T20:59:59+00:00"
}, - "working_time": {
- "from": "2025-09-07T21:00:00+00:00",
- "to": "2025-09-08T20:59:59+00:00"
}, - "tariff": {
- "cost_per_shift": 1000,
- "constraints": [
- {
- "stage_length": "PT10H",
- "cost_per_unit": 1
}
]
}
}
]
}
], - "transports": [
- {
- "key": "transport_1",
- "shifts": [
- {
- "key": "transport_1_shift",
- "availability_time": {
- "from": "2025-09-07T21:00:00+00:00",
- "to": "2025-09-08T20:59:59+00:00"
}, - "tariff": {
- "cost_per_shift": 1000,
- "constraints": [
- {
- "stage_length": 1000000,
- "cost_per_unit": 0.01
}
]
}
}
], - "transport_type": "CAR",
- "boxes": [
- {
- "key": "box_1",
- "capacity": {
- "mass": 300
}
}
]
}
], - "trips": [
- {
- "key": "performer_1_shift",
- "performer": {
- "performer_key": "performer_1",
- "shift_key": "performer_1_shift",
- "shift_time": {
- "from": "2025-09-08T04:38:34Z",
- "to": "2025-09-08T05:53:39Z"
}
}, - "transport": {
- "transport_key": "transport_1",
- "shift_key": "transport_1_shift",
- "shift_time": {
- "from": "2025-09-08T04:38:34Z",
- "to": "2025-09-08T05:53:39Z"
}
}, - "states": [
- {
- "time": "2025-09-08T04:38:34Z",
- "flags": [
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "location_key": "location_storage",
- "cargo_actions": [ ],
- "attributes": [ ]
}, - {
- "time": "2025-09-08T04:38:34Z",
- "flags": [
- "ON_DEMAND",
- "INSIDE_EVENT_HARD_WINDOW",
- "INSIDE_LOCATION_WINDOW",
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "order_key": "order_2",
- "demand_key": "demand_2_pickup",
- "event_key": "demand_2_pickup_event",
- "location_key": "location_storage",
- "cargo_actions": [ ],
- "attributes": [ ]
}, - {
- "time": "2025-09-08T04:38:34Z",
- "flags": [
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "location_key": "location_storage",
- "cargo_actions": [
- {
- "box_key": "box_1",
- "cargo_key": "order_2_cargos",
- "cargo_action_type": "ADD"
}
], - "attributes": [ ]
}, - {
- "time": "2025-09-08T04:38:34Z",
- "flags": [
- "ON_DEMAND",
- "INSIDE_EVENT_HARD_WINDOW",
- "INSIDE_LOCATION_WINDOW",
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "order_key": "order_1",
- "demand_key": "demand_1_pickup",
- "event_key": "demand_1_pickup_event",
- "location_key": "location_storage",
- "cargo_actions": [
- {
- "box_key": "box_1",
- "cargo_key": "order_2_cargos",
- "cargo_action_type": "ADD"
}
], - "attributes": [ ]
}, - {
- "time": "2025-09-08T04:38:34Z",
- "flags": [
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "location_key": "location_storage",
- "cargo_actions": [
- {
- "box_key": "box_1",
- "cargo_key": "order_1_cargos",
- "cargo_action_type": "ADD"
}, - {
- "box_key": "box_1",
- "cargo_key": "order_2_cargos",
- "cargo_action_type": "ADD"
}
], - "attributes": [ ]
}, - {
- "time": "2025-09-08T04:38:34Z",
- "flags": [
- "RELOCATING"
], - "cargo_actions": [
- {
- "box_key": "box_1",
- "cargo_key": "order_1_cargos",
- "cargo_action_type": "ADD"
}, - {
- "box_key": "box_1",
- "cargo_key": "order_2_cargos",
- "cargo_action_type": "ADD"
}
], - "attributes": [ ]
}, - {
- "time": "2025-09-08T05:00:00Z",
- "flags": [
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "location_key": "location_client_2",
- "cargo_actions": [
- {
- "box_key": "box_1",
- "cargo_key": "order_1_cargos",
- "cargo_action_type": "ADD"
}, - {
- "box_key": "box_1",
- "cargo_key": "order_2_cargos",
- "cargo_action_type": "ADD"
}
], - "attributes": [ ]
}, - {
- "time": "2025-09-08T05:00:00Z",
- "flags": [
- "ON_DEMAND",
- "INSIDE_EVENT_HARD_WINDOW",
- "INSIDE_LOCATION_WINDOW",
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "order_key": "order_2",
- "demand_key": "demand_2_drop",
- "event_key": "demand_2_drop_event",
- "location_key": "location_client_2",
- "cargo_actions": [
- {
- "box_key": "box_1",
- "cargo_key": "order_1_cargos",
- "cargo_action_type": "ADD"
}, - {
- "box_key": "box_1",
- "cargo_key": "order_2_cargos",
- "cargo_action_type": "ADD"
}
], - "attributes": [ ]
}, - {
- "time": "2025-09-08T05:10:00Z",
- "flags": [
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "location_key": "location_client_2",
- "cargo_actions": [
- {
- "box_key": "box_1",
- "cargo_key": "order_1_cargos",
- "cargo_action_type": "ADD"
}
], - "attributes": [ ]
}, - {
- "time": "2025-09-08T05:10:00Z",
- "flags": [
- "RELOCATING"
], - "cargo_actions": [
- {
- "box_key": "box_1",
- "cargo_key": "order_1_cargos",
- "cargo_action_type": "ADD"
}
], - "attributes": [ ]
}, - {
- "time": "2025-09-08T05:20:52Z",
- "flags": [
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "location_key": "location_client_1",
- "cargo_actions": [
- {
- "box_key": "box_1",
- "cargo_key": "order_1_cargos",
- "cargo_action_type": "ADD"
}
], - "attributes": [ ]
}, - {
- "time": "2025-09-08T05:20:52Z",
- "flags": [
- "ON_DEMAND",
- "INSIDE_EVENT_HARD_WINDOW",
- "INSIDE_LOCATION_WINDOW",
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "order_key": "order_1",
- "demand_key": "demand_1_drop",
- "event_key": "demand_1_drop_event",
- "location_key": "location_client_1",
- "cargo_actions": [
- {
- "box_key": "box_1",
- "cargo_key": "order_1_cargos",
- "cargo_action_type": "ADD"
}
], - "attributes": [ ]
}, - {
- "time": "2025-09-08T05:30:52Z",
- "flags": [
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "location_key": "location_client_1",
- "cargo_actions": [ ],
- "attributes": [ ]
}, - {
- "time": "2025-09-08T05:30:52Z",
- "flags": [
- "RELOCATING"
], - "cargo_actions": [ ],
- "attributes": [ ]
}, - {
- "time": "2025-09-08T05:38:39Z",
- "flags": [
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "location_key": "location_client_3",
- "cargo_actions": [ ],
- "attributes": [ ]
}, - {
- "time": "2025-09-08T05:38:39Z",
- "flags": [
- "ON_DEMAND",
- "INSIDE_EVENT_HARD_WINDOW",
- "INSIDE_LOCATION_WINDOW",
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "order_key": "order_3",
- "demand_key": "demand_3_work",
- "event_key": "demand_3_work_event",
- "location_key": "location_client_3",
- "cargo_actions": [ ],
- "attributes": [ ]
}, - {
- "time": "2025-09-08T05:53:39Z",
- "flags": [
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "location_key": "location_client_3",
- "cargo_actions": [ ],
- "attributes": [ ]
}
], - "waitlist": [ ],
- "attributes": [ ]
}
]
}
{- "key": "da4e62b0-86cb-4423-b187-5c1a633ca703",
- "specification": {
- "name": "new wave 3000",
- "comment": "just run it",
- "folder_key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091"
}, - "settings": {
- "plan_settings": {
- "trips_settings": {
- "configuration": "default",
- "assumptions": {
- "disable_compatibility": false,
- "disable_capacity": false,
- "same_order_time_window": false,
- "expand_shift_time_window": false
}, - "penalties": {
- "compatibilities": [ ]
}
}, - "geo_settings": {
- "geo_provider": "VRT",
- "toll_roads": true,
- "ferry_crossing": true,
- "traffic_jams": true,
- "flight_distance": false
}, - "calculation_settings": {
- "max_calculation_time": "PT20M",
- "max_waiting_time": "PT30M",
- "result_ttl": "PT20M",
- "result_timezone": 0,
- "treat_warnings_as_errors": false,
- "precision": 2
}
}, - "actualize_settings": {
- "current_time": "2025-09-07T22:30:00Z",
- "max_delay_duration": "PT1H"
}, - "replan_settings": {
- "replan_strategy": {
- "reorder": true,
- "plan_new_orders": true,
- "create_new_trips": true
}
}
}, - "statistics": {
- "indicators": [
- "data_statistics_hardlinks",
- "data_statistics_locations",
- "data_statistics_orders",
- "data_statistics_performers",
- "data_statistics_transports",
- "data_statistics_trips",
- "data_statistics_facts",
- "total_statistics_max_transport_load_capacity_a",
- "total_statistics_max_transport_load_capacity_b",
- "total_statistics_max_transport_load_capacity_c",
- "total_statistics_max_transport_load_mass",
- "total_statistics_max_transport_load_volume",
- "total_statistics_cargo_capacity_ratio_capacity_a",
- "total_statistics_cargo_capacity_ratio_capacity_b",
- "total_statistics_cargo_capacity_ratio_capacity_c",
- "total_statistics_cargo_capacity_ratio_mass",
- "total_statistics_cargo_capacity_ratio_volume",
- "total_statistics_cost",
- "total_statistics_measurements_arriving_time",
- "total_statistics_measurements_departure_time",
- "total_statistics_measurements_distance",
- "total_statistics_measurements_driving_time",
- "total_statistics_measurements_time_window_from",
- "total_statistics_measurements_time_window_to",
- "total_statistics_measurements_total_time",
- "total_statistics_measurements_waiting_time",
- "total_statistics_measurements_working_time",
- "total_statistics_orders_count",
- "total_statistics_performers_count",
- "total_statistics_plan_orders_count",
- "quality_hard_time_window_violations_after_count",
- "quality_hard_time_window_violations_before_count",
- "quality_soft_time_window_violations_after_count",
- "quality_soft_time_window_violations_before_count",
- "total_statistics_reward",
- "total_statistics_waitlist_orders_count"
], - "total_statistics": {
- "profit": 1,
- "cost": 0,
- "reward": 0,
- "measurements": {
- "driving_time": "P0D",
- "waiting_time": "P0D",
- "break_time": "P0D",
- "rest_time": "PT0S",
- "working_time": "P0D",
- "arriving_time": "P0D",
- "departure_time": "P0D",
- "total_time": "P0D",
- "distance": 0,
- "time_window": {
- "from": "2025-09-15T13:56:07.697Z",
- "to": "2025-09-15T13:56:07.697Z"
}
}, - "performers_count": 0,
- "trips_count": 0,
- "orders_count": 0,
- "plan_orders_count": 0,
- "waitlist_orders_count": 0,
- "stops_count": 1,
- "locations_count": 1,
- "average_speed": 45.2,
- "round_trips_count": 1,
- "cargo_capacity_sum": {
- "mass": 1.9,
- "volume": 2,
- "capacity_a": 3,
- "capacity_b": 1,
- "capacity_c": 1
}, - "cargo_capacity_ratio": {
- "mass": 0,
- "volume": 0,
- "capacity_a": 0,
- "capacity_b": 0,
- "capacity_c": 0
}, - "max_transport_load": {
- "mass": 0,
- "volume": 0,
- "capacity_a": 0,
- "capacity_b": 0,
- "capacity_c": 0
}
}, - "quality": {
- "locations_limits_penalty": 0,
- "soft_time_window_violations": {
- "before": {
- "demand_keys": [ ],
- "count": 0
}, - "after": {
- "demand_keys": [ ],
- "count": 0
}
}, - "hard_time_window_violations": {
- "before": {
- "demand_keys": [ ],
- "count": 0
}, - "after": {
- "demand_keys": [ ],
- "count": 0
}
}
}, - "task_statistics": {
- "planning_horizon": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}
}, - "data_statistics": {
- "locations": 958,
- "orders": 1000,
- "performers": 1000,
- "transports": 1000,
- "hardlinks": 0,
- "trips": 0,
- "facts": 1,
- "external_routing": false
}
}, - "edit_date": "2025-09-15T13:56:07.728Z",
- "creation_date": "2025-09-15T13:56:07.728Z"
}
Export (XLSX).
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
timezone | integer <int32> (timezone) [ -12 .. 12 ] Default: 0 Example: timezone=3 Target time zone. |
File with data in XLSX format.
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Export data to VRt.Universal JSON file.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
Array of objects (location_list) [ 0 .. 15001 ] items unique List of locations used for orders and shifts. | |
Array of objects (order_list) [ 0 .. 15001 ] items unique List of orders that need to be completed. | |
Array of objects (performer_list) [ 0 .. 15001 ] items unique Available performers list. The performer fulfills orders using transport. | |
Array of objects (transport_list) [ 0 .. 15001 ] items unique Available transports list. Transport is used by the trip performer to fulfill orders. | |
Array of objects (hardlink_list) [ 0 .. 15001 ] items unique Assignments list. | |
Array of objects (trip_list) [ 0 .. 15001 ] items unique Trip list. A trip is a set of works planned to be performed by a specific performer on a specific transport, expressed through a change in the states of the performer. | |
Array of objects (fact_list) [ 0 .. 15001 ] items unique Trip list. A fact is an event that has occurred that affects further trip operations. | |
object or null (plan_statistics) General statistics on the calculation result. | |
Array of objects (routing_transport_matrix_list) [ 0 .. 16 ] items unique List of matrices of times and distances for each type of transport that are indicated in the data.
The matrix should describe all locations for each type of transport from the data.
When specifying an external routing matrix | |
object (plan_settings) Planning settings. | |
object (replan_settings) Replanning settings. | |
object (actualize_settings) Actualize settings. | |
dataset_name | string (dataset_name) [ 0 .. 512 ] characters Example: "custom_dataset_one" The name of the dataset. A technical field that does not affect calculation. |
{- "locations": [
- {
- "key": "location_client_1",
- "geopoint": {
- "latitude": 55.713699,
- "longitude": 37.621839
}
}, - {
- "key": "location_client_2",
- "geopoint": {
- "latitude": 55.630721,
- "longitude": 37.62493
}
}, - {
- "key": "location_client_3",
- "geopoint": {
- "latitude": 55.722801,
- "longitude": 37.674984
}
}, - {
- "key": "location_storage",
- "geopoint": {
- "latitude": 55.685853,
- "longitude": 37.43181
}
}
], - "orders": [
- {
- "key": "order_1",
- "demands": [
- {
- "key": "demand_1_drop",
- "demand_type": "DROP",
- "target_cargos": [
- "order_1_cargos"
], - "possible_events": [
- {
- "key": "demand_1_drop_event",
- "location_key": "location_client_1",
- "duration": "PT10M",
- "hard_time_window": {
- "from": "2025-09-08T05:00:00+00:00",
- "to": "2025-09-08T07:00:00+00:00"
}
}
]
}, - {
- "key": "demand_1_pickup",
- "demand_type": "PICKUP",
- "target_cargos": [
- "order_1_cargos"
], - "possible_events": [
- {
- "key": "demand_1_pickup_event",
- "location_key": "location_storage",
- "duration": "P0D",
- "reward": 0,
- "hard_time_window": {
- "from": "2025-09-07T21:00:00+00:00",
- "to": "2025-09-08T20:59:59+00:00"
}
}
]
}
], - "cargos": [
- {
- "key": "order_1_cargos",
- "capacity": {
- "mass": 1
}
}
]
}, - {
- "key": "order_2",
- "demands": [
- {
- "key": "demand_2_drop",
- "demand_type": "DROP",
- "target_cargos": [
- "order_2_cargos"
], - "possible_events": [
- {
- "key": "demand_2_drop_event",
- "location_key": "location_client_2",
- "duration": "PT10M",
- "hard_time_window": {
- "from": "2025-09-08T05:00:00+00:00",
- "to": "2025-09-08T07:00:00+00:00"
}
}
]
}, - {
- "key": "demand_2_pickup",
- "demand_type": "PICKUP",
- "target_cargos": [
- "order_2_cargos"
], - "possible_events": [
- {
- "key": "demand_2_pickup_event",
- "location_key": "location_storage",
- "duration": "P0D",
- "reward": 0,
- "hard_time_window": {
- "from": "2025-09-07T21:00:00+00:00",
- "to": "2025-09-08T20:59:59+00:00"
}
}
]
}
], - "cargos": [
- {
- "key": "order_2_cargos",
- "capacity": {
- "mass": 1
}
}
]
}, - {
- "key": "order_3",
- "demands": [
- {
- "key": "demand_3_work",
- "demand_type": "WORK",
- "possible_events": [
- {
- "key": "demand_3_work_event",
- "location_key": "location_client_3",
- "duration": "PT15M",
- "hard_time_window": {
- "from": "2025-09-08T05:00:00+00:00",
- "to": "2025-09-08T07:00:00+00:00"
}
}
]
}
]
}
], - "performers": [
- {
- "key": "performer_1",
- "shifts": [
- {
- "key": "performer_1_shift",
- "availability_time": {
- "from": "2025-09-07T21:00:00+00:00",
- "to": "2025-09-08T20:59:59+00:00"
}, - "working_time": {
- "from": "2025-09-07T21:00:00+00:00",
- "to": "2025-09-08T20:59:59+00:00"
}, - "tariff": {
- "cost_per_shift": 1000,
- "constraints": [
- {
- "stage_length": "PT10H",
- "cost_per_unit": 1
}
]
}
}
]
}
], - "transports": [
- {
- "key": "transport_1",
- "shifts": [
- {
- "key": "transport_1_shift",
- "availability_time": {
- "from": "2025-09-07T21:00:00+00:00",
- "to": "2025-09-08T20:59:59+00:00"
}, - "tariff": {
- "cost_per_shift": 1000,
- "constraints": [
- {
- "stage_length": 1000000,
- "cost_per_unit": 0.01
}
]
}
}
], - "transport_type": "CAR",
- "boxes": [
- {
- "key": "box_1",
- "capacity": {
- "mass": 300
}
}
]
}
], - "trips": [
- {
- "key": "performer_1_shift",
- "performer": {
- "performer_key": "performer_1",
- "shift_key": "performer_1_shift",
- "shift_time": {
- "from": "2025-09-08T04:38:34Z",
- "to": "2025-09-08T05:53:39Z"
}
}, - "transport": {
- "transport_key": "transport_1",
- "shift_key": "transport_1_shift",
- "shift_time": {
- "from": "2025-09-08T04:38:34Z",
- "to": "2025-09-08T05:53:39Z"
}
}, - "states": [
- {
- "time": "2025-09-08T04:38:34Z",
- "flags": [
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "location_key": "location_storage",
- "cargo_actions": [ ],
- "attributes": [ ]
}, - {
- "time": "2025-09-08T04:38:34Z",
- "flags": [
- "ON_DEMAND",
- "INSIDE_EVENT_HARD_WINDOW",
- "INSIDE_LOCATION_WINDOW",
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "order_key": "order_2",
- "demand_key": "demand_2_pickup",
- "event_key": "demand_2_pickup_event",
- "location_key": "location_storage",
- "cargo_actions": [ ],
- "attributes": [ ]
}, - {
- "time": "2025-09-08T04:38:34Z",
- "flags": [
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "location_key": "location_storage",
- "cargo_actions": [
- {
- "box_key": "box_1",
- "cargo_key": "order_2_cargos",
- "cargo_action_type": "ADD"
}
], - "attributes": [ ]
}, - {
- "time": "2025-09-08T04:38:34Z",
- "flags": [
- "ON_DEMAND",
- "INSIDE_EVENT_HARD_WINDOW",
- "INSIDE_LOCATION_WINDOW",
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "order_key": "order_1",
- "demand_key": "demand_1_pickup",
- "event_key": "demand_1_pickup_event",
- "location_key": "location_storage",
- "cargo_actions": [
- {
- "box_key": "box_1",
- "cargo_key": "order_2_cargos",
- "cargo_action_type": "ADD"
}
], - "attributes": [ ]
}, - {
- "time": "2025-09-08T04:38:34Z",
- "flags": [
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "location_key": "location_storage",
- "cargo_actions": [
- {
- "box_key": "box_1",
- "cargo_key": "order_1_cargos",
- "cargo_action_type": "ADD"
}, - {
- "box_key": "box_1",
- "cargo_key": "order_2_cargos",
- "cargo_action_type": "ADD"
}
], - "attributes": [ ]
}, - {
- "time": "2025-09-08T04:38:34Z",
- "flags": [
- "RELOCATING"
], - "cargo_actions": [
- {
- "box_key": "box_1",
- "cargo_key": "order_1_cargos",
- "cargo_action_type": "ADD"
}, - {
- "box_key": "box_1",
- "cargo_key": "order_2_cargos",
- "cargo_action_type": "ADD"
}
], - "attributes": [ ]
}, - {
- "time": "2025-09-08T05:00:00Z",
- "flags": [
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "location_key": "location_client_2",
- "cargo_actions": [
- {
- "box_key": "box_1",
- "cargo_key": "order_1_cargos",
- "cargo_action_type": "ADD"
}, - {
- "box_key": "box_1",
- "cargo_key": "order_2_cargos",
- "cargo_action_type": "ADD"
}
], - "attributes": [ ]
}, - {
- "time": "2025-09-08T05:00:00Z",
- "flags": [
- "ON_DEMAND",
- "INSIDE_EVENT_HARD_WINDOW",
- "INSIDE_LOCATION_WINDOW",
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "order_key": "order_2",
- "demand_key": "demand_2_drop",
- "event_key": "demand_2_drop_event",
- "location_key": "location_client_2",
- "cargo_actions": [
- {
- "box_key": "box_1",
- "cargo_key": "order_1_cargos",
- "cargo_action_type": "ADD"
}, - {
- "box_key": "box_1",
- "cargo_key": "order_2_cargos",
- "cargo_action_type": "ADD"
}
], - "attributes": [ ]
}, - {
- "time": "2025-09-08T05:10:00Z",
- "flags": [
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "location_key": "location_client_2",
- "cargo_actions": [
- {
- "box_key": "box_1",
- "cargo_key": "order_1_cargos",
- "cargo_action_type": "ADD"
}
], - "attributes": [ ]
}, - {
- "time": "2025-09-08T05:10:00Z",
- "flags": [
- "RELOCATING"
], - "cargo_actions": [
- {
- "box_key": "box_1",
- "cargo_key": "order_1_cargos",
- "cargo_action_type": "ADD"
}
], - "attributes": [ ]
}, - {
- "time": "2025-09-08T05:20:52Z",
- "flags": [
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "location_key": "location_client_1",
- "cargo_actions": [
- {
- "box_key": "box_1",
- "cargo_key": "order_1_cargos",
- "cargo_action_type": "ADD"
}
], - "attributes": [ ]
}, - {
- "time": "2025-09-08T05:20:52Z",
- "flags": [
- "ON_DEMAND",
- "INSIDE_EVENT_HARD_WINDOW",
- "INSIDE_LOCATION_WINDOW",
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "order_key": "order_1",
- "demand_key": "demand_1_drop",
- "event_key": "demand_1_drop_event",
- "location_key": "location_client_1",
- "cargo_actions": [
- {
- "box_key": "box_1",
- "cargo_key": "order_1_cargos",
- "cargo_action_type": "ADD"
}
], - "attributes": [ ]
}, - {
- "time": "2025-09-08T05:30:52Z",
- "flags": [
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "location_key": "location_client_1",
- "cargo_actions": [ ],
- "attributes": [ ]
}, - {
- "time": "2025-09-08T05:30:52Z",
- "flags": [
- "RELOCATING"
], - "cargo_actions": [ ],
- "attributes": [ ]
}, - {
- "time": "2025-09-08T05:38:39Z",
- "flags": [
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "location_key": "location_client_3",
- "cargo_actions": [ ],
- "attributes": [ ]
}, - {
- "time": "2025-09-08T05:38:39Z",
- "flags": [
- "ON_DEMAND",
- "INSIDE_EVENT_HARD_WINDOW",
- "INSIDE_LOCATION_WINDOW",
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "order_key": "order_3",
- "demand_key": "demand_3_work",
- "event_key": "demand_3_work_event",
- "location_key": "location_client_3",
- "cargo_actions": [ ],
- "attributes": [ ]
}, - {
- "time": "2025-09-08T05:53:39Z",
- "flags": [
- "INSIDE_LOCATION",
- "AROUND_LOCATION"
], - "location_key": "location_client_3",
- "cargo_actions": [ ],
- "attributes": [ ]
}
], - "waitlist": [ ],
- "attributes": [ ]
}
]
}
Getting trip information by key.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
essence_key required | string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Key, unique identifier. |
required | object (trip) A trip is a set of works planned to be performed by a specific performer on a specific transport, expressed through a change in the states of the performer. |
required | object (trip_statistics) Statistics for a specific trip. |
object (table_trip_fields) Trip\stops fields for table. | |
Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences. |
{- "trip": {
- "key": "trip-0000-9999",
- "performer": {
- "performer_key": "performer0001",
- "shift_key": "performer0001_shift01",
- "shift_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}
}, - "transport": {
- "transport_key": "transport001",
- "shift_key": "performer01",
- "shift_time": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}
}, - "states": [
- {
- "time": "2025-09-21T09:30:00+03:00",
- "order_key": "order01",
- "demand_key": "demand01.1",
- "event_key": "event01",
- "location_key": "location_01",
- "flags": [
- "RELOCATING"
], - "cargo_actions": [
- {
- "box_key": "box01",
- "cargo_key": "cargo01",
- "cargo_action_type": "ADD"
}
], - "distance": 5200,
- "cost": 1231.1,
- "reward": 2343.3,
- "attributes": [ ]
}
], - "waitlist": [
- "order02"
], - "name": "X1-ABC",
- "attributes": [ ]
}, - "trip_statistics": {
- "trip_key": "trip01",
- "general_statistics": {
- "cost": 1231.1,
- "reward": 2343.3,
- "profit": 1231.1,
- "measurements": {
- "time_window": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "driving_time": "PT1H45M",
- "waiting_time": "PT1H45M",
- "working_time": "PT1H45M",
- "break_time": "PT1H45M",
- "rest_time": "PT1H45M",
- "arriving_time": "PT1H45M",
- "departure_time": "PT1H45M",
- "total_time": "PT1H45M",
- "distance": 5200
}, - "trips_count": 250,
- "performers_count": 157,
- "orders_count": 1700,
- "plan_orders_count": 1003,
- "waitlist_orders_count": 697,
- "stops_count": 87,
- "locations_count": 45,
- "cargo_capacity_sum": {
- "mass": 105500,
- "volume": 220034,
- "capacity_a": 100000,
- "capacity_b": 200000,
- "capacity_c": 300000
}, - "cargo_capacity_ratio": {
- "mass": 0.5,
- "volume": 0.1,
- "capacity_a": 0.7,
- "capacity_b": 0.8,
- "capacity_c": 0.9
}, - "max_transport_load": {
- "mass": 0.5,
- "volume": 0.1,
- "capacity_a": 0.7,
- "capacity_b": 0.8,
- "capacity_c": 0.9
}, - "average_speed": 43.1,
- "round_trips_count": 2,
- "average_roundtrip_distance": 23.4,
- "average_roundtrip_time": "PT1H45M",
- "attributes": [ ]
}, - "load_statistics": {
- "total_load": {
- "count": 1460,
- "capacity": {
- "mass": 105500,
- "volume": 220034,
- "capacity_a": 100000,
- "capacity_b": 200000,
- "capacity_c": 300000
}
}, - "max_load": {
- "count": 1460,
- "capacity": {
- "mass": 105500,
- "volume": 220034,
- "capacity_a": 100000,
- "capacity_b": 200000,
- "capacity_c": 300000
}
}, - "max_transfer_load": {
- "count": 1460,
- "capacity": {
- "mass": 105500,
- "volume": 220034,
- "capacity_a": 100000,
- "capacity_b": 200000,
- "capacity_c": 300000
}
}
}, - "stop_statistics": [
- {
- "location_key": "location_01",
- "stop_demands": [
- {
- "demand_key": "demand_key_01",
- "event_key": "event_key_01",
- "demand_time_window": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}
}
], - "stop_time_window": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "measurements": {
- "time_window": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "driving_time": "PT1H45M",
- "waiting_time": "PT1H45M",
- "working_time": "PT1H45M",
- "break_time": "PT1H45M",
- "rest_time": "PT1H45M",
- "arriving_time": "PT1H45M",
- "departure_time": "PT1H45M",
- "total_time": "PT1H45M",
- "distance": 5200
}, - "upload": {
- "count": 1460,
- "capacity": {
- "mass": 105500,
- "volume": 220034,
- "capacity_a": 100000,
- "capacity_b": 200000,
- "capacity_c": 300000
}
}, - "download": {
- "count": 1460,
- "capacity": {
- "mass": 105500,
- "volume": 220034,
- "capacity_a": 100000,
- "capacity_b": 200000,
- "capacity_c": 300000
}
}, - "max_load": {
- "count": 1460,
- "capacity": {
- "mass": 105500,
- "volume": 220034,
- "capacity_a": 100000,
- "capacity_b": 200000,
- "capacity_c": 300000
}
}, - "arrival_load": {
- "count": 1460,
- "capacity": {
- "mass": 105500,
- "volume": 220034,
- "capacity_a": 100000,
- "capacity_b": 200000,
- "capacity_c": 300000
}
}, - "departure_load": {
- "count": 1460,
- "capacity": {
- "mass": 105500,
- "volume": 220034,
- "capacity_a": 100000,
- "capacity_b": 200000,
- "capacity_c": 300000
}
}, - "attributes": [ ]
}
], - "roundtrip_statistics": [
- {
- "roundtrip_key": "trip_01_round_02",
- "general_statistics": {
- "cost": 1231.1,
- "reward": 2343.3,
- "profit": 1231.1,
- "measurements": {
- "time_window": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "driving_time": "PT1H45M",
- "waiting_time": "PT1H45M",
- "working_time": "PT1H45M",
- "break_time": "PT1H45M",
- "rest_time": "PT1H45M",
- "arriving_time": "PT1H45M",
- "departure_time": "PT1H45M",
- "total_time": "PT1H45M",
- "distance": 5200
}, - "trips_count": 250,
- "performers_count": 157,
- "orders_count": 1700,
- "plan_orders_count": 1003,
- "waitlist_orders_count": 697,
- "stops_count": 87,
- "locations_count": 45,
- "cargo_capacity_sum": {
- "mass": 105500,
- "volume": 220034,
- "capacity_a": 100000,
- "capacity_b": 200000,
- "capacity_c": 300000
}, - "cargo_capacity_ratio": {
- "mass": 0.5,
- "volume": 0.1,
- "capacity_a": 0.7,
- "capacity_b": 0.8,
- "capacity_c": 0.9
}, - "max_transport_load": {
- "mass": 0.5,
- "volume": 0.1,
- "capacity_a": 0.7,
- "capacity_b": 0.8,
- "capacity_c": 0.9
}, - "average_speed": 43.1,
- "round_trips_count": 2,
- "average_roundtrip_distance": 23.4,
- "average_roundtrip_time": "PT1H45M",
- "attributes": [ ]
}
}
], - "attributes": [ ]
}, - "fields": {
- "essence_type": "TRIP",
- "essence_key": "key01",
- "trip_name": "X1-ABC",
- "crew_key": "mega_crew",
- "cost": 1231.1,
- "reward": 2343.3,
- "profit": 1231.1,
- "driving_time": "PT1H45M",
- "waiting_time": "PT1H45M",
- "break_time": "PT1H45M",
- "rest_time": "PT1H45M",
- "working_time": "PT1H45M",
- "arriving_time": "PT1H45M",
- "departure_time": "PT1H45M",
- "total_time": "PT1H45M",
- "distance": 5200,
- "time_window": {
- "from": "2025-09-21T09:30:00+03:00",
- "to": "2025-09-21T19:45:00Z"
}, - "orders_count": 1700,
- "plan_orders_count": 1003,
- "waitlist_orders_count": 697,
- "stops_count": 87,
- "locations_count": 45,
- "cargo_capacity_ratio_mass": 10,
- "cargo_capacity_ratio_volume": 2,
- "cargo_capacity_ratio_capacity_a": 1,
- "cargo_capacity_ratio_capacity_b": 2,
- "cargo_capacity_ratio_capacity_c": 3,
- "max_transport_load_mass": 0.1,
- "max_transport_load_volume": 0.1,
- "max_transport_load_capacity_a": 0.1,
- "max_transport_load_capacity_b": 0.1,
- "max_transport_load_capacity_c": 0.1,
- "attributes": "key1:value1, key2:value2",
- "customfields": {
- "datetime_1": "2025-09-21T18:00:00+03:00",
- "datetime_2": "2025-09-21T18:00:00+03:00",
- "datetime_3": "2025-09-21T18:00:00+03:00",
- "datetime_4": "2025-09-21T18:00:00+03:00",
- "datetime_5": "2025-09-21T18:00:00+03:00",
- "int_1": 1,
- "int_2": 1,
- "int_3": 1,
- "int_4": 1,
- "int_5": 1,
- "float_1": 2343.3,
- "float_2": 2343.3,
- "float_3": 2343.3,
- "float_4": 2343.3,
- "float_5": 2343.3,
- "duration_1": "PT2H12M34.3S",
- "duration_2": "PT2H12M34.3S",
- "duration_3": "PT2H12M34.3S",
- "duration_4": "PT2H12M34.3S",
- "duration_5": "PT2H12M34.3S",
- "bool_1": true,
- "bool_2": true,
- "bool_3": true,
- "bool_4": true,
- "bool_5": true,
- "string_1": "value01",
- "string_2": "value01",
- "string_3": "value01",
- "string_4": "value01",
- "string_5": "value01"
}
}, - "linked_essences": [
- {
- "essence_key": "key01",
- "essence_type": "LOCATION"
}
]
}
Removing a trip by key.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
essence_key required | string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Key, unique identifier. |
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Getting a trips list.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
offset | integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set. |
limit | integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return. |
sort_field | string (table_trip_column_type) Default: "TRIP_NAME" Enum: "ESSENCE_KEY" "TRIP_NAME" "CREW_KEY" … 30 more Example: sort_field=DISTANCE Trip table column name. |
sort_customfield | string or null (table_customfields_column_type) Default: null Enum: "DATETIME_1" "DATETIME_2" "DATETIME_3" … 27 more Example: sort_customfield=NONE The name of the additional column in the table. |
sort_direction | string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction. |
Trip filter.
Array of objects (table_trip_filter) [ 0 .. 50 ] items A list of filters. |
required | Array of objects (table_trip) [ 0 .. 2001 ] items A list. |
required | object (table_list_counters) Counters by list. |
{- "filters": [
- {
- "type": "STRING_SEARCH",
- "column": "ESSENCE_KEY",
- "string_search": {
- "text": "key01",
- "strict": false
}
}
]
}
{- "essences": [ ],
- "counters": {
- "overall": {
- "total": 0
}, - "filter": {
- "total": 0
}
}
}
Removing trips from the wave.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
Request to delete trips.
Essence key, unique identifier.
[- "key01"
]
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Getting a tracks.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
tracks_type required | string (track_type) Default: "LINE" Enum: "LINE" "ROAD" "CUSTOM" Example: ROAD Tracks type:
|
offset | integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set. |
limit | integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return. |
Trips filter.
Array of objects (table_trip_filter) [ 0 .. 50 ] items A list of filters. |
required | Array of objects (track) [ 0 .. 2001 ] items A list of tracks. |
required | object (table_list_counters) Counters by list. |
{- "filters": [
- {
- "type": "STRING_SEARCH",
- "column": "ESSENCE_KEY",
- "string_search": {
- "text": "key01",
- "strict": false
}
}
]
}
{- "tracks": [
- {
- "geotrack": [
- {
- "latitude": 55.692789,
- "longitude": 37.554554,
- "time": "2025-09-21T09:30:00+03: 00"
}, - {
- "latitude": 55.692788,
- "longitude": 37.55467,
- "time": "2025-09-21T09:35:00+03: 00"
}
], - "trip_key": "trip_01",
- "performer_key": "performer_01",
- "performer_shift_key": "performer_shift_01",
- "transport_key": "transport_01",
- "transport_shift_key": "transport_shift_01",
- "trip_name": "X1-ABC"
}
], - "counters": {
- "overall": {
- "total": 1
}, - "filter": {
- "total": 1
}
}
}
Obtaining a list of crews that can perform the specified trip.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
essence_key required | string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Key, unique identifier. |
offset | integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set. |
limit | integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return. |
sort_field | string (table_crew_column_type) Default: "USERNAME" Enum: "ESSENCE_KEY" "USERNAME" "COMPANY_KEY" … 2 more Example: sort_field=DEVICE_ONLINE Crew table column name. |
sort_direction | string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction. |
Crews filter.
Array of objects (table_crew_filter) [ 0 .. 50 ] items A list of filters. |
required | Array of objects (table_crew) [ 0 .. 2001 ] items A list. |
required | object (table_list_counters) Counters by list. |
{- "filters": [
- {
- "type": "STRING_SEARCH",
- "column": "ESSENCE_KEY",
- "string_search": {
- "text": "key01",
- "strict": false
}
}
]
}
{- "essences": [
- {
- "fields": {
- "essence_key": "key01",
- "username": "AAA",
- "company_key": "key01",
- "device_phone": "AAA",
- "device_online": true
}
}
], - "counters": {
- "overall": {
- "total": 1
}, - "filter": {
- "total": 1
}
}
}
Run trips (batch). If the trip key list is empty, all trips from the wave are run.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
Request to run trips.
Essence key, unique identifier.
[- "key01"
]
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Stop trips (batch). If the trip key list is empty, all trips from the wave are stop.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
Request to stop trips.
Essence key, unique identifier.
[- "key01"
]
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Create new fact.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
New essence creation request.
key required | string [ 1 .. 1024 ] characters Example: "fact_01" Fact key. |
time required | string <date-time> (fact_time) Example: "2025-09-21T09:30:00+03:00" Fact creation time in the ISO 8601 format. |
type required | string (fact_type) Enum: "NEW_LOCATION" "ORDER_DONE" "DEMAND_START" … 1 more Example: "NEW_LOCATION" Possible order (demand) fact types:
|
trip_key required | string [ 1 .. 1024 ] characters Example: "trip_01" Trip key, to which the fact relates. |
order_key | string or null [ 1 .. 1024 ] characters Default: null Example: "order_01" Order key, required for facts with type |
demand_key | string or null [ 1 .. 1024 ] characters Default: null Example: "order_01_demand_01" Demand key, required for facts with types |
performer_key | string or null [ 1 .. 1024 ] characters Default: null Example: "performer_01" Performer key, required for facts with type |
location_key | string or null [ 1 .. 1024 ] characters Default: null Example: "location_01" Location key, required for facts with type |
Array of objects (attributes) [ 0 .. 250 ] items unique Attributes. Used to add service information. |
required | object (fact) The fact about the order is the action taken with the order or its part (demand). |
object (table_fact_fields) Fact fields for table. | |
Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences. |
{- "key": "fact_01",
- "type": "NEW_LOCATION",
- "time": "2025-09-07T22:00:00Z",
- "trip_key": "trip_for_performer_1",
- "performer_key": "performer_1",
- "location_key": "performer_1_current_location"
}
{- "fact": {
- "key": "fact_01",
- "type": "NEW_LOCATION",
- "time": "2025-09-07T22:00:00Z",
- "trip_key": "trip_for_performer_1",
- "performer_key": "performer_1",
- "location_key": "performer_1_current_location"
}, - "fields": {
- "essence_key": "fact_01",
- "enabled": true
}
}
Updating the fact by key.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
Essence update request.
key required | string [ 1 .. 1024 ] characters Example: "fact_01" Fact key. |
time required | string <date-time> (fact_time) Example: "2025-09-21T09:30:00+03:00" Fact creation time in the ISO 8601 format. |
type required | string (fact_type) Enum: "NEW_LOCATION" "ORDER_DONE" "DEMAND_START" … 1 more Example: "NEW_LOCATION" Possible order (demand) fact types:
|
trip_key required | string [ 1 .. 1024 ] characters Example: "trip_01" Trip key, to which the fact relates. |
order_key | string or null [ 1 .. 1024 ] characters Default: null Example: "order_01" Order key, required for facts with type |
demand_key | string or null [ 1 .. 1024 ] characters Default: null Example: "order_01_demand_01" Demand key, required for facts with types |
performer_key | string or null [ 1 .. 1024 ] characters Default: null Example: "performer_01" Performer key, required for facts with type |
location_key | string or null [ 1 .. 1024 ] characters Default: null Example: "location_01" Location key, required for facts with type |
Array of objects (attributes) [ 0 .. 250 ] items unique Attributes. Used to add service information. |
required | object (fact) The fact about the order is the action taken with the order or its part (demand). |
object (table_fact_fields) Fact fields for table. | |
Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences. |
{- "key": "fact_01",
- "type": "NEW_LOCATION",
- "time": "2025-09-07T22:00:00Z",
- "trip_key": "trip_for_performer_1",
- "performer_key": "performer_1",
- "location_key": "performer_1_current_location"
}
{- "fact": {
- "key": "fact_01",
- "type": "NEW_LOCATION",
- "time": "2025-09-07T22:00:00Z",
- "trip_key": "trip_for_performer_1",
- "performer_key": "performer_1",
- "location_key": "performer_1_current_location"
}, - "fields": {
- "essence_key": "fact_01",
- "enabled": true
}
}
Getting fact information by key.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
essence_key required | string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Key, unique identifier. |
required | object (fact) The fact about the order is the action taken with the order or its part (demand). |
object (table_fact_fields) Fact fields for table. | |
Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences. |
{- "fact": {
- "key": "fact_01",
- "type": "NEW_LOCATION",
- "time": "2025-09-07T22:00:00Z",
- "trip_key": "trip_for_performer_1",
- "performer_key": "performer_1",
- "location_key": "performer_1_current_location"
}, - "fields": {
- "essence_key": "fact_01",
- "enabled": true
}
}
Removing a fact by key.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
essence_key required | string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Key, unique identifier. |
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Getting a facts list.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
offset | integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set. |
limit | integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return. |
sort_field | string (table_fact_column_type) Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 8 more Example: sort_field=ESSENCE_KEY Fact table column name. |
sort_customfield | string or null (table_customfields_column_type) Default: null Enum: "DATETIME_1" "DATETIME_2" "DATETIME_3" … 27 more Example: sort_customfield=NONE The name of the additional column in the table. |
sort_direction | string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction. |
Facts filter.
Array of objects (table_fact_filter) [ 0 .. 50 ] items A list of filters. |
required | Array of objects (table_fact) [ 0 .. 2001 ] items A list of facts. |
required | object (table_list_counters) Counters by list. |
{- "filters": [
- {
- "type": "STRING_SEARCH",
- "column": "ESSENCE_KEY",
- "string_search": {
- "text": "key01",
- "strict": false
}
}
]
}
{- "essences": [ ],
- "counters": {
- "overall": {
- "total": 0
}, - "filter": {
- "total": 0
}
}
}
Removing facts from the experiment.
wave_key required | string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Key, unique identifier. |
Request to delete facts.
Essence key, unique identifier.
[- "key01"
]
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Setting the active user settings key.
New key.
Settings key, unique identifier.
settings_keys required | Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ] Example: ["path-key-01"] List of setting keys. |
active_key | string or null (settings_key_null) [ 1 .. 1024 ] characters Example: "path-key-01" Key of the currently active setting. A key from the |
"path-key-01"
{- "settings_keys": [
- "path-key-01"
], - "active_key": "path-key-01"
}
Reading the list of user settings keys.
settings_keys required | Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ] Example: ["path-key-01"] List of setting keys. |
active_key | string or null (settings_key_null) [ 1 .. 1024 ] characters Example: "path-key-01" Key of the currently active setting. A key from the |
{- "settings_keys": [
- "path-key-01"
], - "active_key": "path-key-01"
}
Create user settings.
settings_key required | string (settings_key) [ 1 .. 1024 ] characters Example: path-key-01 User settings key, unique identifier. |
New settings.
property name* additional property | any |
property name* additional property | any |
"{\"key1\":\"value1\"}"
"{\"key1\":\"value1\"}"
Reading user settings.
settings_key required | string (settings_key) [ 1 .. 1024 ] characters Example: path-key-01 User settings key, unique identifier. |
property name* additional property | any |
"{\"key1\":\"value1\"}"
Update user settings.
settings_key required | string (settings_key) [ 1 .. 1024 ] characters Example: path-key-01 User settings key, unique identifier. |
New settings.
property name* additional property | any |
property name* additional property | any |
"{\"key1\":\"value1\"}"
"{\"key1\":\"value1\"}"
Delete user settings.
settings_key required | string (settings_key) [ 1 .. 1024 ] characters Example: path-key-01 User settings key, unique identifier. |
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Custom field conversion settings.
The table provides additional columns for displaying values from attributes.
This setting defines the rules for converting attribute values into the corresponding typed fields.
Conversion occurs when reading data - therefore, the conversion rules do not affect the data and can be changed at any time.
Setting the active customfields key.
New key.
Settings key, unique identifier.
settings_keys required | Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ] Example: ["path-key-01"] List of setting keys. |
active_key | string or null (settings_key_null) [ 1 .. 1024 ] characters Example: "path-key-01" Key of the currently active setting. A key from the |
"path-key-01"
{- "settings_keys": [
- "path-key-01"
], - "active_key": "path-key-01"
}
Reading the list of custom field settings keys.
settings_keys required | Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ] Example: ["path-key-01"] List of setting keys. |
active_key | string or null (settings_key_null) [ 1 .. 1024 ] characters Example: "path-key-01" Key of the currently active setting. A key from the |
{- "settings_keys": [
- "path-key-01"
], - "active_key": "path-key-01"
}
Create custom fields settings.
settings_key required | string (settings_key) [ 1 .. 1024 ] characters Example: path-key-01 User settings key, unique identifier. |
New settings.
required | Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique List of rules for converting custom fields. |
required | Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique List of rules for converting custom fields. |
{- "rules": [
- {
- "entity_type": "LOCATION",
- "source_attribute_key": "max_trailer_weight",
- "target_customfield": "INT_1",
- "translations": {
- "ru": "Максимальная масса прицепа (кг)",
- "en": "Maximum trailer weight (kg)"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_name",
- "target_customfield": "STRING_1",
- "translations": {
- "ru": "Название стоянки прицепов",
- "en": "Trailer name"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_duration",
- "target_customfield": "DURATION_1",
- "translations": {
- "ru": "Время расцепки прицепов",
- "en": "Trailer action duration"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_creation_date",
- "target_customfield": "DATETIME_1",
- "translations": {
- "ru": "Дата основания",
- "en": "Creation Date"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_cost",
- "target_customfield": "FLOAT_1",
- "translations": {
- "ru": "Стоимость хранения",
- "en": "Storage Cost"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_state",
- "target_customfield": "BOOL_1",
- "translations": {
- "ru": "Наличие парковки для прицепа",
- "en": "Availability of trailer parking"
}
}
]
}
{- "rules": [
- {
- "entity_type": "LOCATION",
- "source_attribute_key": "max_trailer_weight",
- "target_customfield": "INT_1",
- "translations": {
- "ru": "Максимальная масса прицепа (кг)",
- "en": "Maximum trailer weight (kg)"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_name",
- "target_customfield": "STRING_1",
- "translations": {
- "ru": "Название стоянки прицепов",
- "en": "Trailer name"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_duration",
- "target_customfield": "DURATION_1",
- "translations": {
- "ru": "Время расцепки прицепов",
- "en": "Trailer action duration"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_creation_date",
- "target_customfield": "DATETIME_1",
- "translations": {
- "ru": "Дата основания",
- "en": "Creation Date"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_cost",
- "target_customfield": "FLOAT_1",
- "translations": {
- "ru": "Стоимость хранения",
- "en": "Storage Cost"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_state",
- "target_customfield": "BOOL_1",
- "translations": {
- "ru": "Наличие парковки для прицепа",
- "en": "Availability of trailer parking"
}
}
]
}
Reading custom field settings.
settings_key required | string (settings_key) [ 1 .. 1024 ] characters Example: path-key-01 User settings key, unique identifier. |
required | Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique List of rules for converting custom fields. |
{- "rules": [
- {
- "entity_type": "LOCATION",
- "source_attribute_key": "max_trailer_weight",
- "target_customfield": "INT_1",
- "translations": {
- "ru": "Максимальная масса прицепа (кг)",
- "en": "Maximum trailer weight (kg)"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_name",
- "target_customfield": "STRING_1",
- "translations": {
- "ru": "Название стоянки прицепов",
- "en": "Trailer name"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_duration",
- "target_customfield": "DURATION_1",
- "translations": {
- "ru": "Время расцепки прицепов",
- "en": "Trailer action duration"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_creation_date",
- "target_customfield": "DATETIME_1",
- "translations": {
- "ru": "Дата основания",
- "en": "Creation Date"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_cost",
- "target_customfield": "FLOAT_1",
- "translations": {
- "ru": "Стоимость хранения",
- "en": "Storage Cost"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_state",
- "target_customfield": "BOOL_1",
- "translations": {
- "ru": "Наличие парковки для прицепа",
- "en": "Availability of trailer parking"
}
}
]
}
Update custom fields settings.
settings_key required | string (settings_key) [ 1 .. 1024 ] characters Example: path-key-01 User settings key, unique identifier. |
New settings.
required | Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique List of rules for converting custom fields. |
required | Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique List of rules for converting custom fields. |
{- "rules": [
- {
- "entity_type": "LOCATION",
- "source_attribute_key": "max_trailer_weight",
- "target_customfield": "INT_1",
- "translations": {
- "ru": "Максимальная масса прицепа (кг)",
- "en": "Maximum trailer weight (kg)"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_name",
- "target_customfield": "STRING_1",
- "translations": {
- "ru": "Название стоянки прицепов",
- "en": "Trailer name"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_duration",
- "target_customfield": "DURATION_1",
- "translations": {
- "ru": "Время расцепки прицепов",
- "en": "Trailer action duration"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_creation_date",
- "target_customfield": "DATETIME_1",
- "translations": {
- "ru": "Дата основания",
- "en": "Creation Date"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_cost",
- "target_customfield": "FLOAT_1",
- "translations": {
- "ru": "Стоимость хранения",
- "en": "Storage Cost"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_state",
- "target_customfield": "BOOL_1",
- "translations": {
- "ru": "Наличие парковки для прицепа",
- "en": "Availability of trailer parking"
}
}
]
}
{- "rules": [
- {
- "entity_type": "LOCATION",
- "source_attribute_key": "max_trailer_weight",
- "target_customfield": "INT_1",
- "translations": {
- "ru": "Максимальная масса прицепа (кг)",
- "en": "Maximum trailer weight (kg)"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_name",
- "target_customfield": "STRING_1",
- "translations": {
- "ru": "Название стоянки прицепов",
- "en": "Trailer name"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_duration",
- "target_customfield": "DURATION_1",
- "translations": {
- "ru": "Время расцепки прицепов",
- "en": "Trailer action duration"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_creation_date",
- "target_customfield": "DATETIME_1",
- "translations": {
- "ru": "Дата основания",
- "en": "Creation Date"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_cost",
- "target_customfield": "FLOAT_1",
- "translations": {
- "ru": "Стоимость хранения",
- "en": "Storage Cost"
}
}, - {
- "entity_type": "LOCATION",
- "source_attribute_key": "trailer_state",
- "target_customfield": "BOOL_1",
- "translations": {
- "ru": "Наличие парковки для прицепа",
- "en": "Availability of trailer parking"
}
}
]
}
Delete custom fields settings.
settings_key required | string (settings_key) [ 1 .. 1024 ] characters Example: path-key-01 User settings key, unique identifier. |
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Setting the active customicons key.
New key.
Settings key, unique identifier.
settings_keys required | Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ] Example: ["path-key-01"] List of setting keys. |
active_key | string or null (settings_key_null) [ 1 .. 1024 ] characters Example: "path-key-01" Key of the currently active setting. A key from the |
"path-key-01"
{- "settings_keys": [
- "path-key-01"
], - "active_key": "path-key-01"
}
Reading the list of custom field settings keys.
settings_keys required | Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ] Example: ["path-key-01"] List of setting keys. |
active_key | string or null (settings_key_null) [ 1 .. 1024 ] characters Example: "path-key-01" Key of the currently active setting. A key from the |
{- "settings_keys": [
- "path-key-01"
], - "active_key": "path-key-01"
}
Create custom icons settings.
settings_key required | string (settings_key) [ 1 .. 1024 ] characters Example: path-key-01 User settings key, unique identifier. |
New settings.
ZIP archive with data.
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Reading custom field settings.
settings_key required | string (settings_key) [ 1 .. 1024 ] characters Example: path-key-01 User settings key, unique identifier. |
ZIP archive with data.
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Update custom icons settings.
settings_key required | string (settings_key) [ 1 .. 1024 ] characters Example: path-key-01 User settings key, unique identifier. |
New settings.
ZIP archive with data.
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Delete custom icons settings.
settings_key required | string (settings_key) [ 1 .. 1024 ] characters Example: path-key-01 User settings key, unique identifier. |
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}, - "message": "Bad Request",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
]
}
Checking the service availability.
health required | number <double> [ 0 .. 1 ] Example: "0.999" The current health indicator of the service.
|
{- "health": 0.999
}
Getting the service version.
major required | integer <int32> [ 1 .. 100 ] Example: "7" Product version. Within a single version, compatibility of common data structures between services is guaranteed. A version change indicates changes that are incompatible with previous versions of the product (and all services). |
minor required | integer <int32> [ 0 .. 111 ] Example: "15" Minor version of the service. A version change indicates new functionality. The update is backward compatible with the major version of the service. |
build required | string [ 1 .. 64 ] characters Example: "3754RC" Build version. |
{- "major": 7,
- "minor": 15,
- "build": "3754RC"
}
Getting the file with this service documentation.
filename required | string [ 6 .. 128 ] characters Example: file_en.html File name. |
File with data in HTML format.
{- "resource_key": "resource_key",
- "detail": {
- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2025-09-21T09:30:00+03:00"
}
}
}