Как оформить Заказ

После того, как вы добавили груз, отслеживайте его состояние:

Получение статусов Заказов

post

/v1.2/orders/get_orders_statuses

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

                        array
                      
                      [
  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
]

                      Список Id грузов
                    
        [guid]

CURL

Копировать

Пример ответа

Ответ

200 Возвращает объект Id груза - список статусов связанных Заказов

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

Пример

Модель

{...}

"any-key":[...]

{...}

"deal_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"status":0,

"deal_kind":0,

"inwork_status":0,

"tracker_offer_status":0,

"status_change_date_time":"1970-01-01T00:00:00.000Z"

}

]

}

{...}

any-key:[{...}]

Информация о статусе заказа

deal_id: guid

Id заказа

status: enum

[0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, -11, -10, -9, -8, -7, -6, -4, -3, -2]

Статус Заказа

0 — Груз зарезервирован перевозчиком
1 — Перевозчик заполнил информацию о реквизитах/водителе/машине и грузовладелец не просмотрел заявку
2 — Перевозчик заполнил информацию о реквизитах/водителе/машине и грузовладелец просмотрел заявку
3 — Грузовладелец отправил документ-заявку перевозчику
4 — Заказ в исполнении (перевозчик дал согласие на документ-заявку)
5 — Заказ завершен и перенесен в архив
7 — Есть только приглашение на Заказ
8 — Заказа нет, но есть Торги, у которых есть возможные победители
9 — Заказ отклонен автоматически, так как после последней даты загрузки прошло уже более 7 дней
10 — Заказ завершен, ожидается оплата
11 — В Торгах лучшая ставка из других Торгов
-11 — Заказ удален
-10 — Резерв груза перевозчиком отменен
-9 — Заказ отклонен грузовладельцем в Торгах после истечения срока подачи документов (смена победителя)
-8 — Грузовладелец отменил Заказ в исполнении
-7 — Перевозчик отменил Заказ в исполнении
-6 — Заказ отклонен грузовладельцем после удаления Торгов
-4 — Заказ отклонен грузовладельцем в Торгах (смена победителя)
-3 — Заказ отклонен грузовладельцем
-2 — Заказ отозван перевозчиком

deal_kind: enum

[0, 1, 2, 4, 8, 16, 32, 64]

Тип Заказа

0 — Заказ невозможен
1 — Взятие груза из поиска
2 — Заказ из Торгов
4 — Предложение груза
8 — Из перехвата машин
16 — Односторонний заказ
32 — Предложение груза из встречного предложения
64 — Предложение груза по контракту

inwork_status: enum (nullable)

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]

Статус перевозки

0 — Нет статуса
1 — Едет на загрузку
2 — Ожидает загрузку
3 — Загружается
4 — Загрузился, едет на выгрузку
5 — Ожидает выгрузку
6 — Выгружается
7 — Выгрузился
8 — Поломка
9 — ДТП
10 — Арест ТС
11 — Контейнер получен на погрузку
12 — Контейнер на погрузке
13 — Погрузка контейнера окончена
14 — Контейнер сдан с погрузки
15 — Контейнер получен на выгрузку
16 — Контейнер на выгрузке
17 — Выгрузка контейнера окончена
18 — Контейнер сдан с выгрузки
19 — Пустой контейнер получен
20 — Пустой контейнер сдан

tracker_offer_status: enum (nullable)

[0, 1, 2, 3]

status_change_date_time: date-time

Время изменения статуса

}]

}

Загрузка...

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

Загрузка...

Когда груз будет забронирован/взят перевозчиком, вы сможете запросить подробную информацию по Заказу:

Получение информации по Заказу

get

/v1.2/orders/{dealId}

dealId

guid

Id Заказа

CURL

Копировать

Пример ответа

Ответ

200 Возвращает информацию по Заказу

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

Пример

Модель

{...}

"load_copy":{...},

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"load_number":"string",

"load_meta":{...},

"load_meta_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"meta_data":"string"

"auction_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"updated_at":"1970-01-01T00:00:00.000Z",

"added_at":"1970-01-01T00:00:00.000Z",

"archive_date":"1970-01-01T00:00:00.000Z",

"distance":0,

"distance_type":0,

"platon_roads_length":0,

"toll_roads_length":0,

"travel_time":"?",

"true_price":0,

"true_currency_id":0,

"parent_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"is_unpublished":false,

"firm_id":0,

"contact_id1":0,

"contact_id2":0,

"note":"string",

"first_date":"1970-01-01T00:00:00.000Z",

"last_date":"1970-01-01T00:00:00.000Z",

"date_type":0,

"periodicity_id":0,

"order_number":"string",

"krugoreis":false,

"zimnik":false,

"ferries":false,

"loading":{...},

"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"city_id":0,

"latitude":0.5,

"longitude":0.5,

"street":"string",

"organization_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"time_start":"1970-01-01T00:00:00.000Z",

"time_end":"1970-01-01T00:00:00.000Z",

"is_round_the_clock":false,

"large_cities":[...],

"large_cities_with_distance":[...],

{...}

"city_id":0,

"distance":0.5

}

"loading_cargos":[...],

{...}

"cargo_id":0,

"name_id":0,

"name":"string",

"packaging_type":0,

"packaging_quantity":0,

"weight":0.5,

"volume":0.5,

"sizes":{...},

"length":0.5,

"width":0.5,

"height":0.5,

"diameter":0.5,

"length_highlight":false,

"width_highlight":false,

"height_highlight":false

"packaging_type_name":"string"

}

"organization":{...}

"organization_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"firm_id":0,

"name":"string",

"ownership":0,

"residency":0,

"inn":"string",

"phone":"string",

"extra_phone":0,

"docs_address":{...},

"postcode":"string",

"city_id":0,

"street_name":"string",

"house_no":"string",

"office_no":"string"

"stocks":[...],

{...}

"stock_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"address_latitude":0.5,

"address_longitude":0.5,

"note":"string",

"work_schedules":[...],

{...}

"stock_schedule_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"day_of_week":0,

"start_time":"?",

"end_time":"?"

}

"breaks_schedules":[...],

{...}

"stock_schedule_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"day_of_week":0,

"start_time":"?",

"end_time":"?"

}

"contact_persons":[...],

{...}

"contact_person_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"email":"string"

}

"schedule_summary":"string",

"stock_type":0,

"timeslots_binding":{...}

"warehouse_id":0,

"status":0

}

"contact_persons":[...],

{...}

"contact_person_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"email":"string"

}

"ownership_name":"string"

}

"extra_points":[...],

{...}

"route_point_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"load_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"city_id":0,

"point_type":0,

"ordinal_id":0,

"distance":0,

"street":"string",

"latitude":0.5,

"longitude":0.5,

"organization_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"loading_date_start":"1970-01-01T00:00:00.000Z",

"loading_date_end":"1970-01-01T00:00:00.000Z",

"loading_time_start":null,

"loading_time_end":null,

"is_round_the_clock":false,

"city_name":"string",

"loading_cargos":[...],

{...}

"cargo_id":0,

"name_id":0,

"name":"string",

"packaging_type":0,

"packaging_quantity":0,

"weight":0.5,

"volume":0.5,

"sizes":{...},

"length":0.5,

"width":0.5,

"height":0.5,

"diameter":0.5,

"length_highlight":false,

"width_highlight":false,

"height_highlight":false

"packaging_type_name":"string"

}

"unloading_cargos":[...],

{...}

"cargo_id":0,

"weight":0.5,

"volume":0.5,

"packaging_quantity":0,

"is_defined_by_ttn":false

}

"organization":{...}

"organization_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"firm_id":0,

"name":"string",

"ownership":0,

"residency":0,

"inn":"string",

"phone":"string",

"extra_phone":0,

"docs_address":{...},

"postcode":"string",

"city_id":0,

"street_name":"string",

"house_no":"string",

"office_no":"string"

"stocks":[...],

{...}

"stock_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"address_latitude":0.5,

"address_longitude":0.5,

"note":"string",

"work_schedules":[...],

{...}

"stock_schedule_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"day_of_week":0,

"start_time":"?",

"end_time":"?"

}

"breaks_schedules":[...],

{...}

"stock_schedule_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"day_of_week":0,

"start_time":"?",

"end_time":"?"

}

"contact_persons":[...],

{...}

"contact_person_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"email":"string"

}

"schedule_summary":"string",

"stock_type":0,

"timeslots_binding":{...}

"warehouse_id":0,

"status":0

}

"contact_persons":[...],

{...}

"contact_person_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"email":"string"

}

"ownership_name":"string"

}

"unloading":{...},

"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"city_id":0,

"latitude":0.5,

"longitude":0.5,

"street":"string",

"organization_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"time_start":"1970-01-01T00:00:00.000Z",

"time_end":"1970-01-01T00:00:00.000Z",

"is_round_the_clock":false,

"large_cities":[...],

"large_cities_with_distance":[...],

{...}

"city_id":0,

"distance":0.5

}

"loading_cargos":[...],

{...}

"cargo_id":0,

"name_id":0,

"name":"string",

"packaging_type":0,

"packaging_quantity":0,

"weight":0.5,

"volume":0.5,

"sizes":{...},

"length":0.5,

"width":0.5,

"height":0.5,

"diameter":0.5,

"length_highlight":false,

"width_highlight":false,

"height_highlight":false

"packaging_type_name":"string"

}

"organization":{...}

"organization_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"firm_id":0,

"name":"string",

"ownership":0,

"residency":0,

"inn":"string",

"phone":"string",

"extra_phone":0,

"docs_address":{...},

"postcode":"string",

"city_id":0,

"street_name":"string",

"house_no":"string",

"office_no":"string"

"stocks":[...],

{...}

"stock_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"address_latitude":0.5,

"address_longitude":0.5,

"note":"string",

"work_schedules":[...],

{...}

"stock_schedule_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"day_of_week":0,

"start_time":"?",

"end_time":"?"

}

"breaks_schedules":[...],

{...}

"stock_schedule_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"day_of_week":0,

"start_time":"?",

"end_time":"?"

}

"contact_persons":[...],

{...}

"contact_person_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"email":"string"

}

"schedule_summary":"string",

"stock_type":0,

"timeslots_binding":{...}

"warehouse_id":0,

"status":0

}

"contact_persons":[...],

{...}

"contact_person_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"email":"string"

}

"ownership_name":"string"

}

"cargo":{...},

"weight":0.5,

"volume":0.5,

"adr":0,

"cargo_type_id":0,

"cargo_type":"string",

"pack_type":0,

"pallet_count":0,

"belt_count":0,

"dogruz_type":0,

"sbor_gruz":false,

"size":{...}

"length":0.5,

"width":0.5,

"height":0.5,

"diameter":0.5,

"length_highlight":false,

"width_highlight":false,

"height_highlight":false

}

"transport":{...},

"car_type":0,

"car_type_string":"string",

"loading_type":0,

"loading_logical_operator":"string",

"unloading_type":0,

"unloading_logical_operator":"string",

"trucks_quantity":0,

"temperature_from":0,

"temperature_to":0,

"stsepka":false,

"pnevmohod":false,

"koniki":false,

"tir":false,

"cmr":false,

"t1":false,

"san_passport":false,

"is_tracking":false,

"required_capacity":0.5

"boards":[...],

{...}

"board_id":"string",

"name":"string",

"color":"string"

}

"unload_first_date":"1970-01-01T00:00:00.000Z",

"unload_last_date":"1970-01-01T00:00:00.000Z"

"deal":{...}

"deal_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"load_copy_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"load_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"taker_ati_id":"string",

"taker_persistent_user_id":0,

"taker_contact_id":0,

"cargo_owner_ati_id":"string",

"cargo_owner_persistent_user_id":0,

"updated_at":"1970-01-01T00:00:00.000Z",

"end_of_reservation":"1970-01-01T00:00:00.000Z",

"auction_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"status":0,

"counterparty_status":0,

"payment":{...},

"rates":[...],

{...}

"rate":0.5,

"rate_type":0,

"currency":0,

"active":false

}

"prepay_percent":0,

"prepay_percent_enabled":false,

"on_unloading":false,

"in_fuel":false,

"pay_days_enabled":false,

"pay_days":0,

"fixed_rate":false,

"torg":false,

"direct_contract":false,

"money_type":0

"pay_docs":{...},

"documents_copies":{...},

"checked":false,

"date":"1970-01-01T00:00:00.000Z"

"documents_original":{...},

"checked":false,

"date":"1970-01-01T00:00:00.000Z"

"documents_original_track":{...},

"transport_company_id":0,

"tracking_url":"string",

"tracking_number":"string",

"sending_date":"1970-01-01T00:00:00.000Z"

"payment":{...}

"checked":false,

"date":"1970-01-01T00:00:00.000Z"

}

"files":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"storage_file_id":"string",

"access":0,

"add_date":"1970-01-01T00:00:00.000Z",

"deal_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"is_counterparty_file":false,

"file_name":"string",

"size":0,

"link":"string",

"source_type":0,

"source_file_type":0,

"file_type":0,

"timeslots_warehouse_ids":[...]

]

}

"document_templates":[...],

{...}

"organization_address":"string",

"templates":[...]

{...}

"add_date":"1970-01-01T00:00:00.000Z",

"access":0,

"timeslots_warehouse_ids":[...],

"deal_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"deal_point_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"owner_firm_id":0,

"cargoes_ids_hash":0,

"contact_id":0,

"file_name":"string",

"file_id":"string",

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"size":0,

"link":"string"

}

]

}

"is_tracking":false,

"should_show_rate_to_driver":false,

"started_at":"1970-01-01T00:00:00.000Z",

"finished_at":"1970-01-01T00:00:00.000Z",

"denial_reason":"string",

"taker_requisites":{...},

"requisite_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"requisite_firm_name":"string",

"signer_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"own_ship_id":0,

"inn":"string",

"kpp":"string",

"requisite_type_id":0

"driver":{...},

"driver_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"parent_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"first_name":"string",

"second_name":"string",

"patronymic":"string",

"phone_number":"string",

"driver_license_number":"string",

"passport_series":"string",

"passport_number":"string",

"passport_issued_by":"string",

"passport_when_issued":"1970-01-01T00:00:00.000Z",

"registration":"string",

"is_attracted_driver":false,

"last_deal_related_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"description":"string",

"attracted_from":"string",

"scans":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"path":"string",

"name":"string",

"type":0

}

"origin":0,

"date_of_birth":"1970-01-01T00:00:00.000Z",

"department_code_in_passport":"string",

"driver_inn":"string",

"in_cargo_owner_black_list":false,

"black_list_reasons":[...]

"string"

]

"truck":{...},

"truck_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"parent_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"last_deal_related_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"type":0,

"description":"string",

"brand_id":0,

"model":"string",

"number":"string",

"phone_number":"string",

"is_attracted_truck":false,

"ownership_type":0,

"car_type_id":0,

"capacity":0.5,

"volume":0.5,

"length":0.5,

"width":0.5,

"height":0.5,

"manufacture_year":0,

"vin":"string",

"vrc":"string",

"body_number":"string",

"dimension":0,

"truck_passport_number":"string",

"can_refrigerator":false,

"has_gen_set":false,

"truck_owner_name":"string",

"can_carry_heavy_container":false,

"can_carry_tall_container":false,

"verified":false,

"modification_restricted":false,

"scans":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"path":"string",

"name":"string",

"type":0

}

"origin":0

"trailer":{...},

"truck_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"parent_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"last_deal_related_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"type":0,

"description":"string",

"brand_id":0,

"model":"string",

"number":"string",

"phone_number":"string",

"is_attracted_truck":false,

"ownership_type":0,

"car_type_id":0,

"capacity":0.5,

"volume":0.5,

"length":0.5,

"width":0.5,

"height":0.5,

"manufacture_year":0,

"vin":"string",

"vrc":"string",

"body_number":"string",

"dimension":0,

"truck_passport_number":"string",

"can_refrigerator":false,

"has_gen_set":false,

"truck_owner_name":"string",

"can_carry_heavy_container":false,

"can_carry_tall_container":false,

"verified":false,

"modification_restricted":false,

"scans":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"path":"string",

"name":"string",

"type":0

}

"origin":0

"semi_trailer":{...},

"truck_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"parent_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"last_deal_related_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"type":0,

"description":"string",

"brand_id":0,

"model":"string",

"number":"string",

"phone_number":"string",

"is_attracted_truck":false,

"ownership_type":0,

"car_type_id":0,

"capacity":0.5,

"volume":0.5,

"length":0.5,

"width":0.5,

"height":0.5,

"manufacture_year":0,

"vin":"string",

"vrc":"string",

"body_number":"string",

"dimension":0,

"truck_passport_number":"string",

"can_refrigerator":false,

"has_gen_set":false,

"truck_owner_name":"string",

"can_carry_heavy_container":false,

"can_carry_tall_container":false,

"verified":false,

"modification_restricted":false,

"scans":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"owner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"path":"string",

"name":"string",

"type":0

}

"origin":0

"document":{...},

"id":"string",

"old_id":"string",

"editor":"string",

"url":"string",

"old_url":"string",

"name":"string",

"is_signed":false,

"access":0

"additional_documents":[...],

{...}

"id":"string",

"is_counterparty_file":false,

"url":"string",

"name":"string",

"is_signed":false,

"document_type":0,

"access":0

}

"in_work_status_model":0,

"in_work":{...},

"deal_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"in_work_status":0,

"in_work_date":"1970-01-01T00:00:00.000Z",

"ati_id":"string",

"contact_id":0,

"tracker_phone":0.5

"deal_note":"string",

"deal_kind":0,

"points":[...]

{...}

"deal_point_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"ordinal_id":0,

"point_type":0,

"city_id":0,

"lat":0.5,

"lon":0.5,

"address":"string",

"participant_name":"string",

"region_id":0,

"contact_name":"string",

"organization_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"stock_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"stock":{...},

"stock_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"note":"string",

"contact_persons":[...],

{...}

"contact_person_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"email":"string"

}

"schedule_summary":"string",

"stock_type":0,

"timeslots_warehouse_id":0

"organization":{...}

"organization_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"contact_persons":[...]

{...}

"contact_person_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"email":"string"

}

]

}

]

}

{...}

load_copy:{...}

Копия груза

При создании заказа груз копируется, копия не отображается в поиске и её невозможно отредактировать

id: guid

Id копии груза

load_number: string

Сгенерированный номер груза

load_meta:{...}

Метаданные груза

load_meta_id: guid (nullable)

meta_data: string

Данные

}

auction_id: guid (nullable)

Id Торгов (аукциона)

updated_at: date-time

Дата последнего изменения груза

added_at: date-time

Дата добавления груза

archive_date: date-time (nullable)

Дата помещения груза в архив

При взятии груза, он попадает в архив

distance: int32

Расстояние для груза

При расчете учитываются дополнительные пункты разгрузки

distance_type: int32

Маршрут построен с проездом по МКАД или без МКАД

0 — без МКАД
1 — с МКАД

platon_roads_length: int32

Расстояние по Платону

toll_roads_length: int32

Расстояние по платным дорогам

travel_time: time-span

Время в пути

true_price: int32

Озвученная ставка

true_currency_id: int32

Id валюты озвученной ставки

parent_id: guid (nullable)

Id груза

is_unpublished: boolean

Груз не опубликован

firm_id: int32

ID фирмы, выставившей груз

contact_id1: int32

Контакт #1, указанный в грузе

contact_id2: int32 (nullable)

Контакт #2, указанный в грузе

note: string

Примечание к грузу

first_date: date-time

Дата, начиная с которой груз актуален

last_date: date-time

Дата, после которой груз не актуален

date_type: enum

[0, 1, 2, 3]

Готовность груза к перевозке

0 — Готов к отправке сегодня или завтра
1 — Готов к отправке между FirstDate и LastDate
2 — Готов к отправке постоянно
3 — Груза нет, запрос ставки

periodicity_id: enum

[0, 1, 100]

Периодичность загрузки

0 — Нет
1 — Ежедневно
100 — Только по рабочим дням

order_number: string

Номер груза/заказа

krugoreis: boolean

Кругорейс

zimnik: boolean

Зимники

ferries: boolean

Паромные переправы

loading:{...}

Точка загрузки

fias_id: guid

Id точки по базе ФИАС

city_id: int64

Id города
Значение из словаря городов ATI.SU

latitude: decimal (nullable)

Широта

longitude: decimal (nullable)

Долгота

street: string

Адрес

organization_id: guid (nullable)

Id из справочника организаций

address_id: guid (nullable)

Id адреса в организации

time_start: date-time (nullable)

Время "От"

time_end: date-time (nullable)

Время "До"

is_round_the_clock: boolean

Круглосуточно

large_cities: [int64]

Список Id ближайших крупных городов

large_cities_with_distance:[{...}]

Расстояния до ближайших крупных городов

city_id: int64

Id города
Значение из словаря городов ATI.SU

distance: double

Расстояние

}]

loading_cargos:[{...}]

cargo_id: int32

Id груза

name_id: int32

Наименование груза

packaging_type: int32 (nullable)

Упаковка

packaging_quantity: int32 (nullable)

weight: double (nullable)

volume: double (nullable)

Объем

sizes:{...}

Габариты

length: double (nullable)

Длина в метрах

width: double (nullable)

Ширина в метрах

height: double (nullable)

Высота в метрах

diameter: double (nullable)

Диаметр в метрах

length_highlight: boolean

Подсвечивать ли длину

width_highlight: boolean

Подсвечивать ли ширину

height_highlight: boolean

Подсвечивать ли высоту

}

packaging_type_name: string

}]

organization:{...}

organization_id: guid

firm_id: int32

ownership: int32

residency: enum (nullable)

[1, 2, 3, 10, 200]

inn: string

phone: string

extra_phone: int32 (nullable)

docs_address:{...}

postcode: string

city_id: int32 (nullable)

street_name: string

house_no: string

office_no: string

}

stocks:[{...}]

stock_id: guid

address: string

address_city_id: int32

address_latitude: double

address_longitude: double

note: string

work_schedules:[{...}]

stock_schedule_id: guid

day_of_week: enum

[0, 1, 2, 3, 4, 5, 6]

start_time: time-span

end_time: time-span

}]

breaks_schedules:[{...}]

stock_schedule_id: guid

day_of_week: enum

[0, 1, 2, 3, 4, 5, 6]

start_time: time-span

end_time: time-span

}]

contact_persons:[{...}]

contact_person_id: guid

phone: string

email: string

}]

schedule_summary: string

stock_type: enum

[1, 2, 3]

timeslots_binding:{...}

warehouse_id: int32

status: enum

[0, 1, 2, 3]

}

}]

contact_persons:[{...}]

contact_person_id: guid

phone: string

email: string

}]

ownership_name: string

}

extra_points:[{...}]

Дополнительные точки

route_point_id: guid

id: guid

load_id: guid

city_id: int64

Id города
Значение из словаря городов ATI.SU

point_type: enum

[1, 2, 3, 4, 5, 8]

Тип дополнительной точки маршрута груза

1 — Загрузка
2 — Разгрузка
3 — Таможня
4 — Ближайший крупный город к городу загрузки
5 — Ближайший крупный город к городу разгрузки
8 — Проехать через

ordinal_id: int32

Порядковый номер в маршруте

distance: int32

Расстояние

street: string

Адрес

latitude: decimal (nullable)

Широта

longitude: decimal (nullable)

Долгота

organization_id: guid (nullable)

Id из справочника организаций

address_id: guid (nullable)

Id адреса в организации

loading_date_start: date-time (nullable)

Дата начала загрузки

loading_date_end: date-time (nullable)

Дата конца загрузки

loading_time_start: time-span (nullable)

Время начала загрузки

loading_time_end: time-span (nullable)

Время конца загрузки

is_round_the_clock: boolean

Круглосуточно

city_name: string

loading_cargos:[{...}]

cargo_id: int32

Id груза

name_id: int32

Наименование груза

packaging_type: int32 (nullable)

Упаковка

packaging_quantity: int32 (nullable)

weight: double (nullable)

volume: double (nullable)

Объем

sizes:{...}

Габариты

length: double (nullable)

Длина в метрах

width: double (nullable)

Ширина в метрах

height: double (nullable)

Высота в метрах

diameter: double (nullable)

Диаметр в метрах

length_highlight: boolean

Подсвечивать ли длину

width_highlight: boolean

Подсвечивать ли ширину

height_highlight: boolean

Подсвечивать ли высоту

}

packaging_type_name: string

}]

unloading_cargos:[{...}]

cargo_id: int32

Id груза

weight: double (nullable)

Вес

volume: double (nullable)

Объём

packaging_quantity: int32 (nullable)

Выгружаемая часть упаковки

is_defined_by_ttn: boolean

Выгружаемая часть груза будет определена в ТТН

}]

organization:{...}

organization_id: guid

firm_id: int32

ownership: int32

residency: enum (nullable)

[1, 2, 3, 10, 200]

inn: string

phone: string

extra_phone: int32 (nullable)

docs_address:{...}

postcode: string

city_id: int32 (nullable)

street_name: string

house_no: string

office_no: string

}

stocks:[{...}]

stock_id: guid

address: string

address_city_id: int32

address_latitude: double

address_longitude: double

note: string

work_schedules:[{...}]

stock_schedule_id: guid

day_of_week: enum

[0, 1, 2, 3, 4, 5, 6]

start_time: time-span

end_time: time-span

}]

breaks_schedules:[{...}]

stock_schedule_id: guid

day_of_week: enum

[0, 1, 2, 3, 4, 5, 6]

start_time: time-span

end_time: time-span

}]

contact_persons:[{...}]

contact_person_id: guid

phone: string

email: string

}]

schedule_summary: string

stock_type: enum

[1, 2, 3]

timeslots_binding:{...}

warehouse_id: int32

status: enum

[0, 1, 2, 3]

}

}]

contact_persons:[{...}]

contact_person_id: guid

phone: string

email: string

}]

ownership_name: string

}

}]

unloading:{...}

Точка разгрузки

fias_id: guid

Id точки по базе ФИАС

city_id: int64

Id города
Значение из словаря городов ATI.SU

latitude: decimal (nullable)

Широта

longitude: decimal (nullable)

Долгота

street: string

Адрес

organization_id: guid (nullable)

Id из справочника организаций

address_id: guid (nullable)

Id адреса в организации

time_start: date-time (nullable)

Время "От"

time_end: date-time (nullable)

Время "До"

is_round_the_clock: boolean

Круглосуточно

large_cities: [int64]

Список Id ближайших крупных городов

large_cities_with_distance:[{...}]

Расстояния до ближайших крупных городов

city_id: int64

Id города
Значение из словаря городов ATI.SU

distance: double

Расстояние

}]

loading_cargos:[{...}]

cargo_id: int32

Id груза

name_id: int32

Наименование груза

packaging_type: int32 (nullable)

Упаковка

packaging_quantity: int32 (nullable)

weight: double (nullable)

volume: double (nullable)

Объем

sizes:{...}

Габариты

length: double (nullable)

Длина в метрах

width: double (nullable)

Ширина в метрах

height: double (nullable)

Высота в метрах

diameter: double (nullable)

Диаметр в метрах

length_highlight: boolean

Подсвечивать ли длину

width_highlight: boolean

Подсвечивать ли ширину

height_highlight: boolean

Подсвечивать ли высоту

}

packaging_type_name: string

}]

organization:{...}

organization_id: guid

firm_id: int32

ownership: int32

residency: enum (nullable)

[1, 2, 3, 10, 200]

inn: string

phone: string

extra_phone: int32 (nullable)

docs_address:{...}

postcode: string

city_id: int32 (nullable)

street_name: string

house_no: string

office_no: string

}

stocks:[{...}]

stock_id: guid

address: string

address_city_id: int32

address_latitude: double

address_longitude: double

note: string

work_schedules:[{...}]

stock_schedule_id: guid

day_of_week: enum

[0, 1, 2, 3, 4, 5, 6]

start_time: time-span

end_time: time-span

}]

breaks_schedules:[{...}]

stock_schedule_id: guid

day_of_week: enum

[0, 1, 2, 3, 4, 5, 6]

start_time: time-span

end_time: time-span

}]

contact_persons:[{...}]

contact_person_id: guid

phone: string

email: string

}]

schedule_summary: string

stock_type: enum

[1, 2, 3]

timeslots_binding:{...}

warehouse_id: int32

status: enum

[0, 1, 2, 3]

}

}]

contact_persons:[{...}]

contact_person_id: guid

phone: string

email: string

}]

ownership_name: string

}

cargo:{...}

Параметры груза

weight: double

Вес

volume: double

Объем

adr: int32

Модификатор опасности груза с 0 до 9

cargo_type_id: int32

Идентификатор наименования груза
Значение из словаря наименований грузов

cargo_type: string

Строковое наименование груза. Выводится если CargoTypeId не указан, либо равен 59

pack_type: int32

Тип упаковки(навалом, коробки, россыпью, запаллечен ... пирамида). Значение из словаря PackTypes

pallet_count: int32

Количество паллетов

belt_count: int32

Количество ремней

dogruz_type: enum

[1, 2, 3]

Параметр, отвечающий за способ перевозки груза

1 — Только отдельной машиной
2 — Догруз возможен
3 — Догруз

sbor_gruz: boolean

Сборный груз

size:{...}

Размеры груза

length: double (nullable)

Длина в метрах

width: double (nullable)

Ширина в метрах

height: double (nullable)

Высота в метрах

diameter: double (nullable)

Диаметр в метрах

length_highlight: boolean

Подсвечивать ли длину

width_highlight: boolean

Подсвечивать ли ширину

height_highlight: boolean

Подсвечивать ли высоту

}

transport:{...}

Параметры перевозки

car_type: int64

Битовая сумма кузовов

car_type_string: string

loading_type: int32

Битовая сумма типов загрузки

loading_logical_operator: string

Тип условия загрузки

OR
AND

unloading_type: int32

Битовая сумма типов разгрузки

unloading_logical_operator: string

Тип условия разгрузки

OR
AND

trucks_quantity: int32

Количество машин

temperature_from: int32 (nullable)

Температура перевозки - нижнее значение

temperature_to: int32 (nullable)

Температура перевозки - верхнее значение

stsepka: boolean

Сцепка

pnevmohod: boolean

Пневмоход

koniki: boolean

Коники

tir: boolean

TIR

cmr: boolean

CMR

t1: boolean

Т1

san_passport: boolean

Мед книжка

is_tracking: boolean

Запрос отслеживания через АТИ Водитель

required_capacity: double (nullable)

Требуемая грузоподъёмность в тоннах

}

boards:[{...}]

Площадки, на которых опубликован груз

board_id: string

Id площадки

Имя площадки

color: string

Цвет площадки

}]

unload_first_date: date-time (nullable)

Дата, начиная с которой можно разгрузить груз

unload_last_date: date-time (nullable)

Дата, до которой можно разгрузить груз

}

deal:{...}

Заказ

Основная информация о заказе

deal_id: guid

Id Заказа

load_copy_id: guid

Id связанной копии груза

load_id: guid

Id груза

taker_ati_id: string

Код фирмы, взявшей груз

taker_persistent_user_id: int32

Идентификатор пользователя, взявшего груз

taker_contact_id: int32

Id контакта, взявшего груз

cargo_owner_ati_id: string

Код фирмы опубликовавшей груз

cargo_owner_persistent_user_id: int32

Идентификатор пользователя, опубликовавшего груз

updated_at: date-time

Время изменения информации по Заказу

end_of_reservation: date-time (nullable)

Время до которого груз зарезервирован

auction_id: guid (nullable)

Id Торгов (аукциона)

status: enum

[0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, -11, -10, -9, -8, -7, -6, -4, -3, -2]

Статус Заказа

0 — Груз зарезервирован перевозчиком
1 — Перевозчик заполнил информацию о реквизитах/водителе/машине и грузовладелец не просмотрел заявку
2 — Перевозчик заполнил информацию о реквизитах/водителе/машине и грузовладелец просмотрел заявку
3 — Грузовладелец отправил документ-заявку перевозчику
4 — Заказ в исполнении (перевозчик дал согласие на документ-заявку)
5 — Заказ завершен и перенесен в архив
7 — Есть только приглашение на Заказ
8 — Заказа нет, но есть Торги, у которых есть возможные победители
9 — Заказ отклонен автоматически, так как после последней даты загрузки прошло уже более 7 дней
10 — Заказ завершен, ожидается оплата
11 — В Торгах лучшая ставка из других Торгов
-11 — Заказ удален
-10 — Резерв груза перевозчиком отменен
-9 — Заказ отклонен грузовладельцем в Торгах после истечения срока подачи документов (смена победителя)
-8 — Грузовладелец отменил Заказ в исполнении
-7 — Перевозчик отменил Заказ в исполнении
-6 — Заказ отклонен грузовладельцем после удаления Торгов
-4 — Заказ отклонен грузовладельцем в Торгах (смена победителя)
-3 — Заказ отклонен грузовладельцем
-2 — Заказ отозван перевозчиком

counterparty_status: enum

[0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, -11, -10, -9, -8, -7, -6, -4, -3, -2]

Статус Заказа у контрагента

0 — Груз зарезервирован перевозчиком
1 — Перевозчик заполнил информацию о реквизитах/водителе/машине и грузовладелец не просмотрел заявку
2 — Перевозчик заполнил информацию о реквизитах/водителе/машине и грузовладелец просмотрел заявку
3 — Грузовладелец отправил документ-заявку перевозчику
4 — Заказ в исполнении (перевозчик дал согласие на документ-заявку)
5 — Заказ завершен и перенесен в архив
7 — Есть только приглашение на Заказ
8 — Заказа нет, но есть Торги, у которых есть возможные победители
9 — Заказ отклонен автоматически, так как после последней даты загрузки прошло уже более 7 дней
10 — Заказ завершен, ожидается оплата
11 — В Торгах лучшая ставка из других Торгов
-11 — Заказ удален
-10 — Резерв груза перевозчиком отменен
-9 — Заказ отклонен грузовладельцем в Торгах после истечения срока подачи документов (смена победителя)
-8 — Грузовладелец отменил Заказ в исполнении
-7 — Перевозчик отменил Заказ в исполнении
-6 — Заказ отклонен грузовладельцем после удаления Торгов
-4 — Заказ отклонен грузовладельцем в Торгах (смена победителя)
-3 — Заказ отклонен грузовладельцем
-2 — Заказ отозван перевозчиком

payment:{...}

Параметры оплаты Заказа

rates:[{...}]

Список возможных ставок перевозки

rate: decimal

Сумма

rate_type: enum

[0, 1, 2, 3]

Тип оплаты

0 — Нет
1 — Любая
2 — С НДС
3 — Без НДС

currency: int32

Id валюты

active: boolean

Является ли ставка выбранной

}]

prepay_percent: int32

Процент предоплаты

prepay_percent_enabled: boolean

Есть ли предоплата

on_unloading: boolean

Оплата на выгрузке

in_fuel: boolean

Оплата топливом

pay_days_enabled: boolean

Есть ли срок оплаты

pay_days: int32

Срок оплаты

fixed_rate: boolean

Указана ли в грузе ставка

torg: boolean

Возможен ли торг

direct_contract: boolean

Прямой договор

money_type: int32 (nullable)

Способ оплаты

}

pay_docs:{...}

Информация об оплате заказа

documents_copies:{...}

Информация о копиях документов

checked: boolean

Документ получен

date: date-time (nullable)

Дата получения документов

}

documents_original:{...}

Информация о оригиналах документов

checked: boolean

Документ получен

date: date-time (nullable)

Дата получения документов

}

documents_original_track:{...}

Информация об отслеживании оригиналов документов

transport_company_id: int32

Id транспортной компании, осуществляющей доставку документов

tracking_url: string

Сссылка для отслеживания статуса отправления

tracking_number: string

Номер отправления

sending_date: date-time (nullable)

Дата отправки документов

}

payment:{...}

Информация о оплате

checked: boolean

Заказ оплачен

date: date-time (nullable)

Дата оплаты

}

files:[{...}]

Файлы Заказа

id: guid

Id файла

storage_file_id: string

Id файла в хранилище

access: enum

[0, 1, 2, 3]

Доступ к файлу

0 — только загрузивший файл
1 — обе стороны
2 — загрузивший файл и водитель
3 — доступен обеим сторонам и водителю

add_date: date-time

Время загрузки файла

deal_id: guid

Id связанного Заказа

is_counterparty_file: boolean

Файл контрагента

file_name: string

Имя файла

size: int32

Размер файла

link: string

Ссылка на файл

source_type: enum

[0, 1, 2, 3, 4, 5, 6, 7, 8]

Источник файла

0 — Загружен в заказ
1 — Скопирован из груза
2 — Скопирован из данных о водителе
3 — Скопироване из данных о грузовике
4 — Скопирован из данных о прицепе
5 — Скопирован из данных о полуприцепе
6 — Скопирован из данных о тягаче
7 — Загружен для Ати-водителя

source_file_type: enum

[0, 1, 2, 3, 4, 5, 8]

Тип загруженного файла

0 — Обычный файл
1 — Водительское удостоверение
2 — Паспорт водителя
3 — Техпаспорт ТС
4 — Пластик
5 — Фото ТС

file_type: enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17]

Тип файла

0 — Другой документ
1 — Товарно-транспортная накладная
2 — Товарная накладная
3 — Транспортная накладная
4 — Накладная
5 — Счет-фактура
6 — Счет на оплату
7 — Платежное поручение
8 — Акт выполненных работ
9 — Заявка
10 — Заявка (к договору)
11 — Заказ
12 — Договор
13 — Доп. соглашение (к договору)
14 — Доверенность
15 — Поручение экспедитору
16 — Информационное письмо
17 — Документ о происшествии с грузом/ТС

timeslots_warehouse_ids: [int32]

Список складов с Временными окнами с доступом к файлу

}]

document_templates:[{...}]

Информация о шаблонах документов в заказах

organization_address: string

Адрес организации

templates:[{...}]

Шаблоны документов

add_date: date-time

Время загрузки документа

access: enum

[0, 1]

Доступ к документу

0 — только загрузивший документ
1 — обе стороны

timeslots_warehouse_ids: [int32]

Список складов с Временными окнами с доступом к документу

deal_id: guid

Id связанного Заказа

deal_point_id: guid

Id точки в заказе, к которой привязан документ

owner_firm_id: int32

Id фирмы, загрузившей документ

cargoes_ids_hash: int32

Поле-хэш, рассчитывается на основе id грузов, выгружаемых в точке DealPointId. Если выгружаемые грузы не указаны - будет равно 0

contact_id: int32

Id контакта

file_name: string

Название документа

file_id: string

Id файла документа Можно скачать файл с помощью метода(https://ati.su/developers/api/filestorage/#get-v1.0-filestorage-files-%7bfile_id%7d-)

id: guid

Id документа

size: int32

Размер документа

link: string

Ссылка на документ (только для сайта)

}]

is_tracking: boolean

Запрос отслеживания через АТИ Водитель

should_show_rate_to_driver: boolean (nullable)

Показывать ли ставку водителю (для ОЗ)

started_at: date-time (nullable)

Дата взятия/резервирования груза

finished_at: date-time (nullable)

Дата завершения заказа

denial_reason: string

Причина отклонения заказа

Присутствует когда Status -2 или -3

requisite_id: guid (nullable)

Id реквизитов
см. taker_requisites, в новой версии API это поле перестанет существовать

deprecated

taker_requisites:{...}

Реквизиты перевозчика

requisite_id: guid

Id реквизитов
Более подробную информацию о реквизитах можно посмотреть здесь

requisite_firm_name: string

Название компании

signer_id: guid (nullable)

Id подписанта

own_ship_id: int32

Идентификатор формы собственности
Значение из словаря ОПФ АТИ

inn: string

ИНН

kpp: string (nullable)

КПП

requisite_type_id: int32

Тип реквизитов

}

signer_id: guid (nullable)

Id подписанта
см. taker_requisites, в новой версии API это поле перестанет существовать

deprecated

driver:{...}

Копия водителя

При взятии груза, водитель копируется, копию редактировать невозможно

driver_id: guid

Id копии водителя

parent_id: guid (nullable)

Идентификатор водителя из Справочника Водителей

first_name: string

Имя водителя

second_name: string

Фамилия водителя

patronymic: string

Отчество водителя

phone_number: string

Номер телефона

driver_license_number: string

Номер водительского удостоверения

passport_series: string

Серия паспорта

passport_number: string

Номер паспорта

passport_issued_by: string

Кем выдан

passport_when_issued: date-time

Когда выдан

registration: string

Прописка

is_attracted_driver: boolean

Флаг привлеченного водителя (со стороны)

last_deal_related_id: guid (nullable)

Id связанной сущности по Заказу

description: string

Краткое описание водителя

attracted_from: string

Фирма от которой привлечен водитель.

scans:[{...}]

Сканы паспорта / водительского удостоверения

id: guid

owner_id: guid

ID сущности, котрой принадлежит скан

path: string

Путь к файлу

Название

type: enum

[1, 2, 3, 4, 5, 6, 8]

Тип документа

1 — Скан водительского удостоверения
2 — Скан гражданского паспорта
3 — Скан ПТС
4 — Скан пластикового ПТС
5 — Фото ТС
8 — Договор о безвоздмездном пользовании

}]

origin: enum

[0, 1, 2]

Идентификатор источника информации о водителе

0 — Неизвестно откуда указан водитель
1 — Водитель указан на странице заказов у Заказа в исполнении
2 — Водитель указан в АТИ-Доках

date_of_birth: date-time (nullable)

Дата рождения

department_code_in_passport: string

Код подразделения

driver_inn: string

ИНН водителя

in_cargo_owner_black_list: boolean

Есть в Черном списке

black_list_reasons: [string]

Причины добавления в Черный список

}

truck:{...}

Копия транспортного средства

При взятии груза, транспортное средство копируется, копию редактировать невозможно

truck_id: guid

Id копии транспортного средства

parent_id: guid (nullable)

Id транспортного средства из Автопарка

last_deal_related_id: guid (nullable)

Id ТС, с которым было связано ТС во время выполнения последнего Заказа

type: enum

[1, 2, 4, 8]

Тип транспортного средства

1 — Грузовик
2 — Тягач
4 — Полуприцеп
8 — Прицеп

description: string

Описание транспортного средства

brand_id: int32 (nullable)

Марка

model: string

Модель

number: string

Номер

phone_number: string

Телефон

is_attracted_truck: boolean

Привлеченное ТС

ownership_type: enum

[0, 1, 2, 3, 4, 5]

Тип владения ТС

0 - Собственное
1 - Привлеченное
2 - Аренда
3 - Лизинг
4 - Совместная собственность (супругов)
5 - Безвозмездное пользование

car_type_id: int32

Тип Кузова

capacity: decimal (nullable)

Грузоподъемность

volume: decimal (nullable)

Объем

length: decimal (nullable)

Длина

width: decimal (nullable)

Ширина

height: decimal (nullable)

Высота

manufacture_year: int32 (nullable)

Год выпуска

vin: string

VIN

vrc: string

СТС

body_number: string

Номер кузова

dimension: enum (nullable)

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

Размерность контейнера

truck_passport_number: string

Номер ПТС

can_refrigerator: boolean (nullable)

Способность возить реф-контейнеры

has_gen_set: boolean (nullable)

Есть GenSet

truck_owner_name: string

Имя владельца по СТС

can_carry_heavy_container: boolean (nullable)

Способность перевозить тяжелые контейнеры

can_carry_tall_container: boolean (nullable)

Способность перевозить высокие контейнеры

verified: boolean

Проверено

modification_restricted: boolean

Запрещено редактирование и удаление ТС.

scans:[{...}]

Сканы ПТС

id: guid

owner_id: guid

ID сущности, котрой принадлежит скан

path: string

Путь к файлу

Название

type: enum

[1, 2, 3, 4, 5, 6, 8]

Тип документа

1 — Скан водительского удостоверения
2 — Скан гражданского паспорта
3 — Скан ПТС
4 — Скан пластикового ПТС
5 — Фото ТС
8 — Договор о безвоздмездном пользовании

}]

origin: enum

[0, 1, 2]

Источник создания Транспорта

0 — Неизвестно откуда указано ТС
1 — ТС указано на странице заказов у Заказа в исполнении
2 — ТС Указано в АТИ-доках

}

trailer:{...}

Копия прицепа

При взятии груза, прицеп копируется, копию редактировать невозможно

truck_id: guid

Id копии транспортного средства

parent_id: guid (nullable)

Id транспортного средства из Автопарка

last_deal_related_id: guid (nullable)

Id ТС, с которым было связано ТС во время выполнения последнего Заказа

type: enum

[1, 2, 4, 8]

Тип транспортного средства

1 — Грузовик
2 — Тягач
4 — Полуприцеп
8 — Прицеп

description: string

Описание транспортного средства

brand_id: int32 (nullable)

Марка

model: string

Модель

number: string

Номер

phone_number: string

Телефон

is_attracted_truck: boolean

Привлеченное ТС

ownership_type: enum

[0, 1, 2, 3, 4, 5]

Тип владения ТС

0 - Собственное
1 - Привлеченное
2 - Аренда
3 - Лизинг
4 - Совместная собственность (супругов)
5 - Безвозмездное пользование

car_type_id: int32

Тип Кузова

capacity: decimal (nullable)

Грузоподъемность

volume: decimal (nullable)

Объем

length: decimal (nullable)

Длина

width: decimal (nullable)

Ширина

height: decimal (nullable)

Высота

manufacture_year: int32 (nullable)

Год выпуска

vin: string

VIN

vrc: string

СТС

body_number: string

Номер кузова

dimension: enum (nullable)

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

Размерность контейнера

truck_passport_number: string

Номер ПТС

can_refrigerator: boolean (nullable)

Способность возить реф-контейнеры

has_gen_set: boolean (nullable)

Есть GenSet

truck_owner_name: string

Имя владельца по СТС

can_carry_heavy_container: boolean (nullable)

Способность перевозить тяжелые контейнеры

can_carry_tall_container: boolean (nullable)

Способность перевозить высокие контейнеры

verified: boolean

Проверено

modification_restricted: boolean

Запрещено редактирование и удаление ТС.

scans:[{...}]

Сканы ПТС

id: guid

owner_id: guid

ID сущности, котрой принадлежит скан

path: string

Путь к файлу

Название

type: enum

[1, 2, 3, 4, 5, 6, 8]

Тип документа

1 — Скан водительского удостоверения
2 — Скан гражданского паспорта
3 — Скан ПТС
4 — Скан пластикового ПТС
5 — Фото ТС
8 — Договор о безвоздмездном пользовании

}]

origin: enum

[0, 1, 2]

Источник создания Транспорта

0 — Неизвестно откуда указано ТС
1 — ТС указано на странице заказов у Заказа в исполнении
2 — ТС Указано в АТИ-доках

}

semi_trailer:{...}

Копия полуприцепа

При взятии груза, полуприцеп копируется, копию редактировать невозможно

truck_id: guid

Id копии транспортного средства

parent_id: guid (nullable)

Id транспортного средства из Автопарка

last_deal_related_id: guid (nullable)

Id ТС, с которым было связано ТС во время выполнения последнего Заказа

type: enum

[1, 2, 4, 8]

Тип транспортного средства

1 — Грузовик
2 — Тягач
4 — Полуприцеп
8 — Прицеп

description: string

Описание транспортного средства

brand_id: int32 (nullable)

Марка

model: string

Модель

number: string

Номер

phone_number: string

Телефон

is_attracted_truck: boolean

Привлеченное ТС

ownership_type: enum

[0, 1, 2, 3, 4, 5]

Тип владения ТС

0 - Собственное
1 - Привлеченное
2 - Аренда
3 - Лизинг
4 - Совместная собственность (супругов)
5 - Безвозмездное пользование

car_type_id: int32

Тип Кузова

capacity: decimal (nullable)

Грузоподъемность

volume: decimal (nullable)

Объем

length: decimal (nullable)

Длина

width: decimal (nullable)

Ширина

height: decimal (nullable)

Высота

manufacture_year: int32 (nullable)

Год выпуска

vin: string

VIN

vrc: string

СТС

body_number: string

Номер кузова

dimension: enum (nullable)

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

Размерность контейнера

truck_passport_number: string

Номер ПТС

can_refrigerator: boolean (nullable)

Способность возить реф-контейнеры

has_gen_set: boolean (nullable)

Есть GenSet

truck_owner_name: string

Имя владельца по СТС

can_carry_heavy_container: boolean (nullable)

Способность перевозить тяжелые контейнеры

can_carry_tall_container: boolean (nullable)

Способность перевозить высокие контейнеры

verified: boolean

Проверено

modification_restricted: boolean

Запрещено редактирование и удаление ТС.

scans:[{...}]

Сканы ПТС

id: guid

owner_id: guid

ID сущности, котрой принадлежит скан

path: string

Путь к файлу

Название

type: enum

[1, 2, 3, 4, 5, 6, 8]

Тип документа

1 — Скан водительского удостоверения
2 — Скан гражданского паспорта
3 — Скан ПТС
4 — Скан пластикового ПТС
5 — Фото ТС
8 — Договор о безвоздмездном пользовании

}]

origin: enum

[0, 1, 2]

Источник создания Транспорта

0 — Неизвестно откуда указано ТС
1 — ТС указано на странице заказов у Заказа в исполнении
2 — ТС Указано в АТИ-доках

}

document:{...}

Основной документ в АТИ-Доках

id: string

ID документа

old_id: string

ID старого документа

editor: string

Фирма, отредактировавшая документ

url: string

Адрес просмотра договора

old_url: string

Адрес просмотра старого договора

Имя документа

is_signed: boolean

Документ подписан перевозчиком

access: enum

[0, 1]

Доступ к документу

0 — Обе стороны
1 — Водитель

}

additional_documents:[{...}]

Дополнительные документы

id: string

Id документа

is_counterparty_file: boolean

Файл контрагента

url: string

Адрес документа

Имя документа

is_signed: boolean

Документ подписан перевозчиком

document_type: enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

Тип документа

0 — Нет
1 — Заказ
2 — Договор-заявка
3 — Поручение экспедитору
4 — Акт
5 — Счет
6 — Одностороннее расторжение
7 — Доверенность
8 — Табличный заказ
9 — Заявка к договору (табличный вид)

access: enum

[0, 1]

Доступ к документу

0 — Обе стороны
1 — Водитель

}]

in_work_status_model: enum

[0, 1, 2, 3]

Статусная модель перевозки

0 — Простая перевозка
1 — Первая миля
2 — Последняя миля
3 — Порожний контейнер

in_work:{...}

Статус перевозки заказа

deal_id: guid

Id Заказа

in_work_status: enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]

Статус перевозки

0 — Нет статуса
1 — Едет на загрузку
2 — Ожидает загрузку
3 — Загружается
4 — Загрузился, едет на выгрузку
5 — Ожидает выгрузку
6 — Выгружается
7 — Выгрузился
8 — Поломка
9 — ДТП
10 — Арест ТС
11 — Контейнер получен на погрузку
12 — Контейнер на погрузке
13 — Погрузка контейнера окончена
14 — Контейнер сдан с погрузки
15 — Контейнер получен на выгрузку
16 — Контейнер на выгрузке
17 — Выгрузка контейнера окончена
18 — Контейнер сдан с выгрузки
19 — Пустой контейнер получен
20 — Пустой контейнер сдан

in_work_date: date-time (nullable)

Дата выставления статуса

ati_id: string

Фирма, выставившая статус (перевозчик или грузовладелец)

contact_id: int32 (nullable)

Контакт, выставивший статус

tracker_phone: decimal (nullable)

Номер телефона трекера, откуда получен статус

}

deal_note: string

Предлагаемые правки к документу

deal_kind: enum

[0, 1, 2, 4, 8, 16, 32, 64]

Тип Заказа

0 — Заказ невозможен
1 — Взятие груза из поиска
2 — Заказ из Торгов
4 — Предложение груза
8 — Из перехвата машин
16 — Односторонний заказ
32 — Предложение груза из встречного предложения
64 — Предложение груза по контракту

points:[{...}]

Точки маршрута

deal_point_id: guid

Id точки заказа

ordinal_id: int32

Порядковый номер

point_type: enum

[1, 2, 3, 8]

Тип точки маршрута

1 — Загрузка
2 — Разгрузка

city_id: int32

Id города
Значение из словаря городов ATI.SU

lat: double (nullable)

Широта

lon: double (nullable)

Долгота

address: string

Адрес

participant_name: string

Название организации

region_id: int32

Id региона Значение из словаря регионов ATI.SU

contact_name: string

organization_id: guid (nullable)

stock_id: guid (nullable)

stock:{...}

stock_id: guid

address: string

address_city_id: int32

note: string

contact_persons:[{...}]

contact_person_id: guid

phone: string

email: string

}]

schedule_summary: string

stock_type: enum

[1, 2, 3]

timeslots_warehouse_id: int32 (nullable)

}

organization:{...}

organization_id: guid

phone: string

extra_phone: int32 (nullable)

contact_persons:[{...}]

contact_person_id: guid

phone: string

email: string

}]

}

}]

}

4XX Ошибка запроса. Подробнее про ошибки API

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

Пример

Модель

{...}

"reason":"string",

"error":"string"

}

{...}

Модель ошибки

reason: string

Причина ошибки

error: string

Ключ ошибки

}

Загрузка...

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

Загрузка...

Из нее вы можете получить ID перевозчика, взявшего груз.

Зная ID перевозчика, можно:

получить информацию о фирме - название фирмы, профиль деятельности, количество звезд, рекомендаций, претензий и т.д.:

Получение краткой информации по фирме (по идентификатору)

get

/v1.0/firms/summary/{atiId}

atiId

string

Идентификатор фирмы

CURL

Копировать

Пример ответа

Ответ

200 Success

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

Пример

Модель

{...}

"ati_id":"string",

"brand":"string",

"ownership":"string",

"full_name":"string",

"firm_name":"string",

"location":{...},

"city_id":0,

"region_id":0,

"country_id":0,

"city_size":0,

"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"attributes":0,

"city_name":"string",

"region_name":"string",

"country_name":"string",

"country_code_name":"string"

"address":"string",

"web_site":"string",

"position_in_city":0,

"position_in_country":0,

"name_eng":"string",

"firm_type":"string",

"firm_type_id_int":0,

"firm_type_id":"string",

"predicted_firm_type_id":0,

"info_reference":"string",

"passport_reference":"string",

"city":"string",

"score":0.5,

"bad_partner_mentions_count":0,

"claims_count":0,

"language":"string",

"recommendations_count":0,

"inn":"string",

"ogrn":"string",

"kpp":"string",

"okpo":"string",

"affiliated_firms":[...],

{...}

"firm_name":"string",

"inn":"string",

"tf_firm_color":"string",

"tf_has_signals":false

}

"negative_points_sum":0.5,

"tf_firm_color":"string",

"tf_account_color":"string",

"tf_has_signals":false,

"registration_date":"1970-01-01T00:00:00.000Z",

"contact_info_changed":"1970-01-01T00:00:00.000Z",

"deletion_date":"1970-01-01T00:00:00.000Z",

"last_month_active_days":0,

"firm_documents":[...],

{...}

"link":"string",

"description":"string",

"creation_date":"1970-01-01T00:00:00.000Z",

"name":"string",

"type_id":0

}

"verified_trucks":0

}

{...}

ati_id: string (nullable)

Идентификатор фирмы

brand: string (nullable)

Брэнд фирмы

ownership: string (nullable)

Организационно-правовая форма фирмы

full_name: string (nullable)

Полное имя фирмы: Брэнд (Название фирмы, ОПФ)

firm_name: string (nullable)

Название фирмы

location:{...}

Структура "Город"

city_id: int32

Идентификатор города

region_id: int32 (nullable)

Идентификатор региона, в котором находится город

country_id: int32 (nullable)

Идентификатор страны, в которой находится город

full_name: string (nullable)

Полное название города

read only

short_name: string (nullable)

Краткое название города

read only

is_regional_center: boolean

Является ли город региональным центром

read only

city_size: int32

Идентификатор размера города

fias_id: uuid (nullable)

Идентификатор города по ФИАС

attributes: enum

[0, 4]

city_name: string (nullable)

Название города

region_name: string (nullable)

Название региона, в котором находится город

country_name: string (nullable)

Название страны, в которой находится город

country_code_name: string (nullable)

Кодовое название страны, в которой находится город

}

address: string (nullable)

Адрес фирмы

web_site: string (nullable)

Сайт фирмы

position_in_city: int32 (nullable)

Место в рэйтинге по городу

position_in_country: int32 (nullable)

Место в рэйтинге по стране

name_eng: string (nullable)

Интернациональное название фирмы

firm_type: string (nullable)

Профиль деятельности фирмы

firm_type_id_int: int32

Идентификатор профиля деятельности

firm_type_id: string (nullable)

(Устаревшее) Идентификатор профиля деятельности строкой

predicted_firm_type_id: int32 (nullable)

Идентификатор предполагаемого профиля деятельности фирмы, основанный на её анализе

info_reference: string (nullable)

Ссылка на карточку фирмы

passport_reference: string (nullable)

Ссылка на паспорт фирмы

city: string (nullable)

Город, в котором расположена фирма

score: double

Количество звезд фирмы. Если число отрицательно, то это красные звезды

bad_partner_mentions_count: int32

Количество упоминаний на форуме недобросовестных партнеров

claims_count: int32

Количество претензий от фирм

language: string (nullable)

Язык фирмы

recommendations_count: int32

Количество рекомендаций от фирм

inn: string (nullable)

Инн

ogrn: string (nullable)

ОГРН

kpp: string (nullable)

Код причины постановки на учет фирмы

okpo: string (nullable)

Общероссийский классификатор предприятий и организаций

affiliated_firms:[{...}]

Связанные фирмы

firm_name: string (nullable)

Название

inn: string (nullable)

ИНН

tf_firm_color: string (nullable)

Цвет фирмы по системе "Светофор"

tf_has_signals: boolean

Есть факты в системе "Светофор"

}]

negative_points_sum: double

Сумма отрицательных баллов

tf_firm_color: string (nullable)

Цвет фирмы в светофоре

tf_account_color: string (nullable)

Цвет аккаунта в светофоре

tf_has_signals: boolean

Флаг о существовании любой информации о фирме в светофоре

registration_date: date-time

Дата регистрации на сайте, которая AddDate из firms.

contact_info_changed: date-time

Дата последних изменений в истории фирмы.

deletion_date: date-time (nullable)

Дата удаления фирмы.

last_month_active_days: int32

Число дней со входами на сайт за последние 30 дней.

firm_documents:[{...}]

Список структуры "Документ фирмы"

link: string (nullable)

Ссылка на документ.

description: string (nullable)

Автогенерируемое описание документа.

creation_date: date-time

Дата создания документа.

Имя документа.

type_id: int32

Идентификатор типа документа из коллекции !:LocalizedDictionaries.DocumentTemplates.

}]

verified_trucks: int32

Количеством зарегистрированных ТС

}

400 Bad Request

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

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

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

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

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

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

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

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

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

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

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

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

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

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

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

Загрузка...

получить реквизиты фирмы:

Метод получения реквизитов фирмы

get

/v1.0/firms/{atiId}/requisites

atiId

string

Код фирмы в ATI.SU

CURL

Копировать

Пример ответа

Ответ

200 Success

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

Пример

Модель

[...]

{...}

"requisite_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"ati_id":"string",

"requisite_type_id":0,

"requisite_name":"string",

"legal_name":"string",

"own_ship_id":0,

"fio":"string",

"inn":"string",

"ogrn":"string",

"phone":"string",

"fax":"string",

"email":"string",

"kpp":"string",

"rs":"string",

"ks":"string",

"bik":"string",

"bank":"string",

"codes":"string",

"is_read_only":false,

"okpo":"string",

"is_vat_payer":false,

"last_use_date":"1970-01-01T00:00:00.000Z",

"is_active":true,

"is_visible":true,

"legal_address":{...},

"address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"ati_id":"string",

"country_id":0,

"region_id":0,

"city_id":0,

"city_name":"string",

"post_index":"string",

"street_type_id":0,

"street_name":"string",

"house_no":"string",

"part_no":"string",

"litera":"string",

"office_no":"string",

"post_contact":"string",

"add_date":"1970-01-01T00:00:00.000Z",

"attributes":0,

"send_type_id":0,

"note":"string",

"formatted_text":"string",

"is_post_address":false,

"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"fias_level":0

"post_address":{...},

"address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"ati_id":"string",

"country_id":0,

"region_id":0,

"city_id":0,

"city_name":"string",

"post_index":"string",

"street_type_id":0,

"street_name":"string",

"house_no":"string",

"part_no":"string",

"litera":"string",

"office_no":"string",

"post_contact":"string",

"add_date":"1970-01-01T00:00:00.000Z",

"attributes":0,

"send_type_id":0,

"note":"string",

"formatted_text":"string",

"is_post_address":false,

"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"fias_level":0

"legal_address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"post_address_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"signees":[...],

{...}

"signee_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"requisite_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"full_name":"string",

"position":"string",

"act_upon":"string",

"is_default":false,

"deletion_date":"1970-01-01T00:00:00.000Z",

"full_name_and_position":"string"

}

"person_passport":{...}

"series":"string",

"number":"string",

"date_of_issue":"1970-01-01T00:00:00.000Z",

"department_code":"string",

"issued_by":"string",

"registration":"string",

"scan_files":[...]

{...}

"link":"string",

"id":"string",

"size":0,

"name":"string"

}

]

}

]

[{...}]

requisite_id: uuid

Идентификтаор реквизита

ati_id: string (nullable)

Код в ATI.SU фирмы

requisite_type_id: int32

Тип реквизита

requisite_name: string (nullable)

Название реквизита

legal_name: string (nullable)

Юридическое именование фирмы

own_ship_id: int32

Идентификатор формы собственности

fio: string (nullable)

ФИО владельца

inn: string (nullable)

ИНН

ogrn: string (nullable)

ОГРН, для реквизитов в валюте (USD и EUR) в этом поле храниться VAT

phone: string (nullable)

Телефон

fax: string (nullable)

Факс

email: string (nullable)

Электронный адрес

kpp: string (nullable)

КПП

rs: string (nullable)

Расчетный счет

ks: string (nullable)

КС

bik: string (nullable)

БИК

bank: string (nullable)

Наименование банка

codes: string (nullable)

Коды

is_read_only: boolean

Реквизиты только для чтения

okpo: string (nullable)

ОКПО

is_vat_payer: boolean

Плательщик НДС

last_use_date: date-time (nullable)

Дата последнего использования в системе

is_active: boolean

Активный реквизит

is_visible: boolean

Будет ли виден реквизит пользователю в будущем
Нужен для одноразовых реквизитов, например, при создании счета с оплатой по банковской карте (там создается реквизит из пары полей)

legal_address:{...}

Юридический адрес

address_id: uuid

Идентификатор адреса

ati_id: string (nullable)

Код в ATI.SU фирмы

country_id: int32 (nullable)

Идентификатор страны

region_id: int32 (nullable)

Идентификатор региона

city_id: int32 (nullable)

Идентификатор Города

city_name: string (nullable)

Название города

post_index: string (nullable)

Почтовый индекс

street_type_id: int32

Тип улицы

street_name: string (nullable)

Улица

house_no: string (nullable)

Номер дома

part_no: string (nullable)

Корпус дома

litera: string (nullable)

Литера

office_no: string (nullable)

Номер офиса

post_contact: string (nullable)

Получатель почты

add_date: date-time (nullable)

Дата добавления

attributes: int32

Аттрибуты

send_type_id: int32

note: string (nullable)

Примечание

formatted_text: string (nullable)

is_post_address: boolean

Является почтовым адресом

fias_id: uuid (nullable)

Идентификатор в ФИАС

fias_level: enum

[0, 1, 3, 4, 5, 6, 7, 90, 91]

}

post_address:{...}

Почтовый адрес

address_id: uuid

Идентификатор адреса

ati_id: string (nullable)

Код в ATI.SU фирмы

country_id: int32 (nullable)

Идентификатор страны

region_id: int32 (nullable)

Идентификатор региона

city_id: int32 (nullable)

Идентификатор Города

city_name: string (nullable)

Название города

post_index: string (nullable)

Почтовый индекс

street_type_id: int32

Тип улицы

street_name: string (nullable)

Улица

house_no: string (nullable)

Номер дома

part_no: string (nullable)

Корпус дома

litera: string (nullable)

Литера

office_no: string (nullable)

Номер офиса

post_contact: string (nullable)

Получатель почты

add_date: date-time (nullable)

Дата добавления

attributes: int32

Аттрибуты

send_type_id: int32

note: string (nullable)

Примечание

formatted_text: string (nullable)

is_post_address: boolean

Является почтовым адресом

fias_id: uuid (nullable)

Идентификатор в ФИАС

fias_level: enum

[0, 1, 3, 4, 5, 6, 7, 90, 91]

}

legal_address_id: uuid

Идентификатор юридического адреса в системе

post_address_id: uuid

Идентификатор почтового адреса в системе

signees:[{...}]

Список подписантов

signee_id: uuid

Идентификатор подписанта.

requisite_id: uuid

Идентификатор реквизита, которому принадлежит эта запись.

full_name: string (nullable)

ФИО (обязательно в родительном падеже).

position: string (nullable)

Должность (обязательно в родительном падеже).

act_upon: string (nullable)

На основании чего действует (обязательно в родительном падеже).

is_default: boolean

Выбирать по умолчанию.

deletion_date: date-time (nullable)

Дата удаления.

full_name_and_position: string (nullable)

Поле, объединяющее FullName и Position. Не является автовычисляемым (т.е. не является конкатенацией полей FullName и Position), создано для других нужд.

}]

person_passport:{...}

Паспорт физического лица

series: string (nullable)

Серия

number: string (nullable)

Номер

date_of_issue: date-time

Дата выдачи

department_code: string (nullable)

Код подразделения

issued_by: string (nullable)

Выдан

registration: string (nullable)

Адрес регистрации

scan_files:[{...}]

Файл со сканом паспорта

link: string (nullable)

Ccылка

id: string (nullable)

Идентификатор

size: int32

Размер

Название

}]

}

available_in_ati_docs: boolean

Доступно в АТИ Доках

read only

}]

400 Bad Request

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

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

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

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

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

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

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

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

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

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

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

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

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

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

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

Загрузка...

Данные позволят вам сформировать представление о фирме и понять, хотите ли вы доверить ей свой груз или нет.

Если по какой-то причине вас не устроит предложение перевозчика или сам перевозчик, то вы можете отклонить его заявку на перевозку груза.

Отклонение Заказа без документов

delete

/v1.2/orders/{dealId}

dealId

guid

Id заказа

                
                body

                        string
                      
                      "string"

                      Причина отклонения

CURL

Копировать

Пример ответа

Ответ

200 Успешное отклонение

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

4XX Ошибка запроса. Подробнее про ошибки API

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

Пример

Модель

{...}

"reason":"string",

"error":"string"

}

{...}

Модель ошибки

reason: string

Причина ошибки

error: string

Ключ ошибки

}

Загрузка...

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

Загрузка...

Если вас все устроит, вы сможете оформить с перевозчиком Заказ. Заказ может быть оформлен следующими способами:

С использованием сервиса “АТИ-Доки”. Документооборот будет вестись через ATI.SU. При этом Заказ на сайте ATI.SU будет переведен в исполнение только после того, как документ на перевозку будет одобрен второй стороной — перевозчиком. При необходимости документ может быть подписан с помощью электронной цифровой подписи.

Создание Заказа с документом через АТИ-Доки

post

/v1.2/orders/{dealId}/accept

dealId

guid

Id Заказа

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

body

object

Данные грузовладельца для Заказа

{...}

Данные грузовладельца для Заказа

template_id: string (nullable)

Id шаблона документа а АТИ Доках

document_type: string (nullable)

Тип документа ("заказ", "заказ (табличный вид)", "заявка (к договору)", "поручение экспедитору", "Заявка к договору (табличный вид)")

requisite_id: guid

Id реквизитов

signer_id: guid

Id подписанта

contract_number: string (nullable)

Номер договора произвольного формата не длинее 50 символов. Обязателен, если тип документа -- заявка или поручение экспедитору.

contract_start_date: date-time (nullable)

Дата начала договора. Обязателен, если тип документа -- заявка или поручение экспедитору.

point_ids:[{...}]

Список адресов загрузки/разгрузки с организациями для Заказа

deal_point_id: guid

Id адреса загрузки/разгрузки из Заказа

organization_id: guid

Id организации

contact_person_id: guid (nullable)

Id контакта адреса

address_id: guid (nullable)

Id адреса

}]

}

CURL

Копировать

Пример ответа

Ответ

200 Параметры ссылки для открытия Заказа в АТИ-Доках

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

Пример

Модель

{...}

"id":"string",

"url":"string",

"is_signed":false

}

{...}

Параметры ссылки для открытия Заказа в АТИ-Доках

id: string

Id документа

url: string

Url документа

is_signed: boolean

Подписан ли документ

}

4XX Ошибка запроса. Подробнее про ошибки API

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

Пример

Модель

{...}

"reason":"string",

"error":"string"

}

{...}

Модель ошибки

reason: string

Причина ошибки

error: string

Ключ ошибки

}

Загрузка...

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

Загрузка...

Создание Заказа с документом через загрузку файла

post

/v1.2/orders/{dealId}/accept_file

dealId

guid

Id Заказа

attachment

binary

contract_start_date

date-time

contract_number

string

document_type

string

requisite_id

guid

signer_id

guid

CURL

Копировать

Пример ответа

Ответ

200 Параметры ссылки для открытия Заказа

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

Пример

Модель

{...}

"id":"string",

"url":"string",

"is_signed":false

}

{...}

Параметры ссылки для открытия Заказа в АТИ-Доках

id: string

Id документа

url: string

Url документа

is_signed: boolean

Подписан ли документ

}

4XX Ошибка запроса. Подробнее про ошибки API

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

Пример

Модель

{...}

"reason":"string",

"error":"string"

}

{...}

Модель ошибки

reason: string

Причина ошибки

error: string

Ключ ошибки

}

Загрузка...

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

Загрузка...

Полная документация API АТИ-Доков.

Без использования АТИ-Доков. Как только вы оформите Заказ, он будет переведен в исполнение.

Создание Заказа без документов

post

/v1.2/orders/{dealId}/move_to_work

dealId

guid

ID Заказа

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

body

object

Параметры Заказа

{...}

in_work_status_model: enum

[0, 1, 2, 3]

Статусная модель перевозки

0 — Простая перевозка
1 — Первая миля
2 — Последняя миля
3 — Порожний контейнер

}

CURL

Копировать

Пример ответа

Ответ

200 Успешное создание Заказа

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

4XX Ошибка запроса. Подробнее про ошибки API

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

Пример

Модель

{...}

"reason":"string",

"error":"string"

}

{...}

Модель ошибки

reason: string

Причина ошибки

error: string

Ключ ошибки

}

Загрузка...

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

Загрузка...

Заказу, находящемуся в исполнении, могут быть присвоены различные статусы: водитель едет на загрузку, ожидает загрузку, загружается и т.д. Статусы можете менять как вы, так и перевозчик.

Смена cтатуса перевозки Заказа

post

/v1.2/orders/{dealId}/inwork

dealId

guid

Id Заказа

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

body

object

Cтатус перевозки Заказа и его параметры

{...}

in_work_status: enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]

Статус перевозки

0 — Нет статуса
1 — Едет на загрузку
2 — Ожидает загрузку
3 — Загружается
4 — Загрузился, едет на выгрузку
5 — Ожидает выгрузку
6 — Выгружается
7 — Выгрузился
8 — Поломка
9 — ДТП
10 — Арест ТС
11 — Контейнер получен на погрузку
12 — Контейнер на погрузке
13 — Погрузка контейнера окончена
14 — Контейнер сдан с погрузки
15 — Контейнер получен на выгрузку
16 — Контейнер на выгрузке
17 — Выгрузка контейнера окончена
18 — Контейнер сдан с выгрузки
19 — Пустой контейнер получен
20 — Пустой контейнер сдан

}

CURL

Копировать

Пример ответа

Ответ

200 Успешное изменение статуса

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

Пример

Модель

boolean

4XX Ошибка запроса. Подробнее про ошибки API

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

Пример

Модель

{...}

"reason":"string",

"error":"string"

}

{...}

Модель ошибки

reason: string

Причина ошибки

error: string

Ключ ошибки

}

Загрузка...

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

Загрузка...

После того, как Заказ будет выполнен, его можно будет завершить.

Завершение перевозки

put

/v1.2/orders/{dealId}/finish

dealId

guid

Id Заказа

waitPayment

boolean

При выставлении этого флага Заказ переносится на вкладку “ДО и Оплата”

CURL

Копировать

Пример ответа

Ответ

200 Успешное завершение

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

4XX Ошибка запроса. Подробнее про ошибки API

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

Пример

Модель

{...}

"reason":"string",

"error":"string"

}

{...}

Модель ошибки

reason: string

Причина ошибки

error: string

Ключ ошибки

}

Загрузка...

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

Загрузка...

Полная документация API Заказов.