{ "openapi": "3.0.0", "info": { "title": "usecases/carrier/finddeal", "version": "1.0.0" }, "servers": [ { "url": "/" }, { "url": "https://api.ati.su" } ], "security": [ { "BearerAuth": [] } ], "paths": { "/v2/boards/public/boards/create": { "post": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegratorBoardInfo" } } }, "description": "Данные о площадке", "x-nullable": false }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorModel" } } }, "description": "Ошибка валидации или другая", "x-nullable": false } }, "tags": [ "Площадки" ], "operationId": "BoardsForIntegrator_Create", "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegratorBodyCreateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegratorBodyCreateRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IntegratorBodyCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegratorBodyCreateRequest" } } }, "description": "Параметры площадки", "required": true }, "summary": "Создать площадку\n " } }, "/v2/boards/public/participants/invite": { "post": { "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "ID приглашения", "x-nullable": false }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorModel" } } }, "description": "Ошибка валидации", "x-nullable": false } }, "tags": [ "Участники" ], "operationId": "ParticipantsForIntegrator_InviteToBoard", "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateParticipantForIntegratorRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateParticipantForIntegratorRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateParticipantForIntegratorRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateParticipantForIntegratorRequest" } } }, "required": true }, "summary": "Пригласить участника ATI.SU на площадку (создание участника площадки с типом Invited)\n " } }, "/v1.0/loads/search/byboards": { "get": { "tags": [ "Грузы на площадках" ], "summary": "Проводит поиск грузов, которые размещены на указанных площадках. В результате присутствуют как ваши грузы, так и грузы других пользователей. ", "operationId": "LoadsSearch_GetAll", "parameters": [ { "name": "boardIds", "in": "query", "style": "form", "explode": true, "description": "Массив ID площадок", "schema": { "type": "array", "items": { "type": "string" } }, "x-position": 1 } ], "responses": { "200": { "description": "Массив грузов, которые опубликованы на выбранных площадках", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LoadView" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/api/loads/#loads-title-errors)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfFinalException" } } } } } } }, "/v1.0/loads/new/{loadId}/responses": { "put": { "tags": [ "Новая структура отзывов" ], "summary": "Добавление либо редактирование отзыва на чужой груз.", "operationId": "NewLoadResponses_UpsertResponse", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "ID груза", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "x-name": "response", "description": "Отзыв на груз", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadResponseModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Отзыв на груз", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewLoadResponseViewStandart" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/api/loads/#loads-title-errors)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfFinalException" } } } } } } }, "/v1.2/orders/invites/my": { "get": { "tags": [ "Персональные приглашения" ], "summary": "Получение списка приглашений", "operationId": "PersonalInvitations_Get2", "parameters": [ { "name": "role", "in": "query", "description": "Роль пользователя: `0` — Грузовладелец, `1` — Перевозчик", "schema": { "$ref": "#/components/schemas/OrderRole" }, "x-position": 1 } ], "responses": { "200": { "description": "Список приглашений на перевозку груза", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonalInvitationView3" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFinalException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/takeload/{loadId}": { "post": { "tags": [ "Заказы" ], "summary": "Взятие груза / Редактирование Заказа", "description": "Взятие груза возможно в том случае, если пользователь является победителем Торгов (аукциона), получил приглашение от грузовладельца или состоит на площадке, где опубликован груз.", "operationId": "Orders_TakeLoad", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Id груза", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "x-name": "loadTakeInfoIntegratorsDto", "description": "Параметры Заказа", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/LoadTakeInfoIntegratorsDto" } ] } } }, "x-position": 2 }, "responses": { "200": { "description": "Успешное взятие/редактирование", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderViewOfFullDealView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFinalException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/auction/{auctionId}": { "get": { "parameters": [ { "description": "Id Торгов (аукциона)", "in": "path", "name": "auctionId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Возвращать удалённые торги", "in": "query", "name": "withDeleted", "schema": { "default": true, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "accept_second_pay_type": true, "active_deal_id": "4300ad9e-c164-447d-a00c-1b0f16355c89", "auction_id": "edfa4cbc-868f-4ce7-89e2-8764df59151a", "auction_rates": [ { "added_at": "2023-04-24T11:31:51.9296722Z", "ati_id": "12345", "auction_rate_id": "fb6093ff-28e8-4c45-ac33-5c88e68b349f", "contact_id": 0, "loading_date": null, "rate_with_nds": 5500, "rate_without_nds": 6600, "source": 0, "state": 0 }, { "added_at": "2023-04-24T11:32:51.9296877Z", "ati_id": "33345", "auction_rate_id": "fdae4ca4-8c8b-44ac-9174-21614de4341f", "contact_id": 0, "loading_date": null, "rate_with_nds": 5000, "rate_without_nds": 6000, "source": 0, "state": 1 } ], "auction_restart_parameters": { "auction_finish_action": 1, "current_change_winner_count": 2, "current_restart_count": 1, "duration_after_restart": 30, "init_change_winner_count": 2, "init_restart_count": 1, "is_manually_restarted": false, "rate_increase": null, "rate_increase_option": null }, "auto_renew": true, "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "deleted": false, "docs_expired_date": "2023-04-24T14:36:51.9297113Z", "duration": 6, "end_date": "2023-04-24T11:36:51.9297297Z", "end_date_boundary": "2023-04-24T11:36:51.9297268Z", "finish_type": 0, "finished": true, "is_docs_expired": false, "load_id": "a2f03352-d1f2-4d76-bc65-94d5c2914847", "max_rate": 6000, "max_renew_time": 60, "nds": 20, "participants_count": 2, "raise_bid": true, "raise_bid_interval": 30, "renew_time": 20, "response_in_minutes": 0, "response_prohibited": false, "server_date": "2023-04-24T11:36:51.9302947Z", "start_date": "2023-04-24T11:30:51.9297089Z", "start_since_first_bet": false, "state": 0, "step": 500, "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:51.9297244Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfLoadOwner" } }, "text/json": { "examples": { "response": { "value": { "accept_second_pay_type": true, "active_deal_id": "4300ad9e-c164-447d-a00c-1b0f16355c89", "auction_id": "edfa4cbc-868f-4ce7-89e2-8764df59151a", "auction_rates": [ { "added_at": "2023-04-24T11:31:51.9296722Z", "ati_id": "12345", "auction_rate_id": "fb6093ff-28e8-4c45-ac33-5c88e68b349f", "contact_id": 0, "loading_date": null, "rate_with_nds": 5500, "rate_without_nds": 6600, "source": 0, "state": 0 }, { "added_at": "2023-04-24T11:32:51.9296877Z", "ati_id": "33345", "auction_rate_id": "fdae4ca4-8c8b-44ac-9174-21614de4341f", "contact_id": 0, "loading_date": null, "rate_with_nds": 5000, "rate_without_nds": 6000, "source": 0, "state": 1 } ], "auction_restart_parameters": { "auction_finish_action": 1, "current_change_winner_count": 2, "current_restart_count": 1, "duration_after_restart": 30, "init_change_winner_count": 2, "init_restart_count": 1, "is_manually_restarted": false, "rate_increase": null, "rate_increase_option": null }, "auto_renew": true, "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "deleted": false, "docs_expired_date": "2023-04-24T14:36:51.9297113Z", "duration": 6, "end_date": "2023-04-24T11:36:51.9297297Z", "end_date_boundary": "2023-04-24T11:36:51.9297268Z", "finish_type": 0, "finished": true, "is_docs_expired": false, "load_id": "a2f03352-d1f2-4d76-bc65-94d5c2914847", "max_rate": 6000, "max_renew_time": 60, "nds": 20, "participants_count": 2, "raise_bid": true, "raise_bid_interval": 30, "renew_time": 20, "response_in_minutes": 0, "response_prohibited": false, "server_date": "2023-04-24T11:36:51.9302947Z", "start_date": "2023-04-24T11:30:51.9297089Z", "start_since_first_bet": false, "state": 0, "step": 500, "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:51.9297244Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfLoadOwner" } }, "text/plain": { "examples": { "response": { "value": { "accept_second_pay_type": true, "active_deal_id": "4300ad9e-c164-447d-a00c-1b0f16355c89", "auction_id": "edfa4cbc-868f-4ce7-89e2-8764df59151a", "auction_rates": [ { "added_at": "2023-04-24T11:31:51.9296722Z", "ati_id": "12345", "auction_rate_id": "fb6093ff-28e8-4c45-ac33-5c88e68b349f", "contact_id": 0, "loading_date": null, "rate_with_nds": 5500, "rate_without_nds": 6600, "source": 0, "state": 0 }, { "added_at": "2023-04-24T11:32:51.9296877Z", "ati_id": "33345", "auction_rate_id": "fdae4ca4-8c8b-44ac-9174-21614de4341f", "contact_id": 0, "loading_date": null, "rate_with_nds": 5000, "rate_without_nds": 6000, "source": 0, "state": 1 } ], "auction_restart_parameters": { "auction_finish_action": 1, "current_change_winner_count": 2, "current_restart_count": 1, "duration_after_restart": 30, "init_change_winner_count": 2, "init_restart_count": 1, "is_manually_restarted": false, "rate_increase": null, "rate_increase_option": null }, "auto_renew": true, "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "deleted": false, "docs_expired_date": "2023-04-24T14:36:51.9297113Z", "duration": 6, "end_date": "2023-04-24T11:36:51.9297297Z", "end_date_boundary": "2023-04-24T11:36:51.9297268Z", "finish_type": 0, "finished": true, "is_docs_expired": false, "load_id": "a2f03352-d1f2-4d76-bc65-94d5c2914847", "max_rate": 6000, "max_renew_time": 60, "nds": 20, "participants_count": 2, "raise_bid": true, "raise_bid_interval": 30, "renew_time": 20, "response_in_minutes": 0, "response_prohibited": false, "server_date": "2023-04-24T11:36:51.9302947Z", "start_date": "2023-04-24T11:30:51.9297089Z", "start_since_first_bet": false, "state": 0, "step": 500, "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:51.9297244Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfLoadOwner" } } }, "description": "Торги (аукцион) для грузовладельца (код 200)" }, "201": { "content": { "application/json": { "examples": { "response": { "value": { "auction_id": "248de03c-c445-4cca-8858-4e9b495ce3d7", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "end_date": "2023-04-24T11:36:51.930351Z", "finished": false, "is_our_rate_best": true, "load_id": "dcbe9875-ebb8-4c06-bbb9-ab4093c5fe20", "next_rate_with_nds": 5500, "next_rate_without_nds": 6600, "our_rate": { "added_at": "2023-04-24T11:35:51.9303557Z", "auction_rate_id": "47c55885-1ca1-4d05-bc66-968d0e53f0ce", "contact_id": 1, "loading_date": null, "rate_with_nds": 4500, "rate_without_nds": 5400, "state": 0 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:51.9305017Z", "start_date": "2023-04-24T11:30:51.930351Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfTaker" } }, "text/json": { "examples": { "response": { "value": { "auction_id": "248de03c-c445-4cca-8858-4e9b495ce3d7", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "end_date": "2023-04-24T11:36:51.930351Z", "finished": false, "is_our_rate_best": true, "load_id": "dcbe9875-ebb8-4c06-bbb9-ab4093c5fe20", "next_rate_with_nds": 5500, "next_rate_without_nds": 6600, "our_rate": { "added_at": "2023-04-24T11:35:51.9303557Z", "auction_rate_id": "47c55885-1ca1-4d05-bc66-968d0e53f0ce", "contact_id": 1, "loading_date": null, "rate_with_nds": 4500, "rate_without_nds": 5400, "state": 0 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:51.9305017Z", "start_date": "2023-04-24T11:30:51.930351Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfTaker" } }, "text/plain": { "examples": { "response": { "value": { "auction_id": "248de03c-c445-4cca-8858-4e9b495ce3d7", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "end_date": "2023-04-24T11:36:51.930351Z", "finished": false, "is_our_rate_best": true, "load_id": "dcbe9875-ebb8-4c06-bbb9-ab4093c5fe20", "next_rate_with_nds": 5500, "next_rate_without_nds": 6600, "our_rate": { "added_at": "2023-04-24T11:35:51.9303557Z", "auction_rate_id": "47c55885-1ca1-4d05-bc66-968d0e53f0ce", "contact_id": 1, "loading_date": null, "rate_with_nds": 4500, "rate_without_nds": 5400, "state": 0 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:51.9305017Z", "start_date": "2023-04-24T11:30:51.930351Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfTaker" } } }, "description": "Торги (аукцион) для участника (код 200)" }, "202": { "content": { "application/json": { "examples": { "response": { "value": { "active_deal_id": "38bd5f61-d3e4-432f-be4c-6bcf0a5b7045", "auction_id": "fd831353-d13d-43a1-91d3-6ad06c84a8db", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "docs_expired_date": "2023-04-24T14:36:51.9305482Z", "end_date": "2023-04-24T11:36:51.93054Z", "finished": true, "is_docs_expired": false, "load_id": "f0f98614-3fa3-4a6f-87ed-953b0f500eeb", "our_rate": { "added_at": "2023-04-24T11:35:51.9305428Z", "auction_rate_id": "242bc0ad-56d9-49c1-93eb-7e93f53b139e", "contact_id": 1, "loading_date": null, "rate_with_nds": 6000, "rate_without_nds": 5000, "state": 1 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:51.9306908Z", "start_date": "2023-04-24T11:30:51.93054Z", "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:51.9305506Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfTakerWinner" } }, "text/json": { "examples": { "response": { "value": { "active_deal_id": "38bd5f61-d3e4-432f-be4c-6bcf0a5b7045", "auction_id": "fd831353-d13d-43a1-91d3-6ad06c84a8db", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "docs_expired_date": "2023-04-24T14:36:51.9305482Z", "end_date": "2023-04-24T11:36:51.93054Z", "finished": true, "is_docs_expired": false, "load_id": "f0f98614-3fa3-4a6f-87ed-953b0f500eeb", "our_rate": { "added_at": "2023-04-24T11:35:51.9305428Z", "auction_rate_id": "242bc0ad-56d9-49c1-93eb-7e93f53b139e", "contact_id": 1, "loading_date": null, "rate_with_nds": 6000, "rate_without_nds": 5000, "state": 1 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:51.9306908Z", "start_date": "2023-04-24T11:30:51.93054Z", "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:51.9305506Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfTakerWinner" } }, "text/plain": { "examples": { "response": { "value": { "active_deal_id": "38bd5f61-d3e4-432f-be4c-6bcf0a5b7045", "auction_id": "fd831353-d13d-43a1-91d3-6ad06c84a8db", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "docs_expired_date": "2023-04-24T14:36:51.9305482Z", "end_date": "2023-04-24T11:36:51.93054Z", "finished": true, "is_docs_expired": false, "load_id": "f0f98614-3fa3-4a6f-87ed-953b0f500eeb", "our_rate": { "added_at": "2023-04-24T11:35:51.9305428Z", "auction_rate_id": "242bc0ad-56d9-49c1-93eb-7e93f53b139e", "contact_id": 1, "loading_date": null, "rate_with_nds": 6000, "rate_without_nds": 5000, "state": 1 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:51.9306908Z", "start_date": "2023-04-24T11:30:51.93054Z", "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:51.9305506Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfTakerWinner" } } }, "description": "Торги (аукцион) для победителя (код 200)" }, "404": { "description": "Торги (аукцион) не найдены" } }, "tags": [ "Auctions" ], "summary": "Получение Торгов (аукциона) по Id" } }, "/v1.2/auction/bet": { "post": { "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "auction": { "auction_id": "8ef73743-fb35-4bdc-83a9-5904fa517ded", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "end_date": "2023-04-24T11:36:52.0301243Z", "finished": false, "is_our_rate_best": true, "load_id": "2f86f429-334a-4dae-be3f-624f92870829", "next_rate_with_nds": 5500, "next_rate_without_nds": 6600, "our_rate": { "added_at": "2023-04-24T11:35:52.0301298Z", "auction_rate_id": "d4aa20cc-500b-494d-b67e-77a9fe8826bf", "contact_id": 1, "loading_date": null, "rate_with_nds": 4500, "rate_without_nds": 5400, "state": 0 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:52.0302924Z", "start_date": "2023-04-24T11:30:52.0301216Z", "winner_criterion": 0 }, "auction_end_date": "2023-04-24T11:36:52.0300965Z", "result_status": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionRateStatusOfTaker" } }, "text/json": { "examples": { "response": { "value": { "auction": { "auction_id": "8ef73743-fb35-4bdc-83a9-5904fa517ded", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "end_date": "2023-04-24T11:36:52.0301243Z", "finished": false, "is_our_rate_best": true, "load_id": "2f86f429-334a-4dae-be3f-624f92870829", "next_rate_with_nds": 5500, "next_rate_without_nds": 6600, "our_rate": { "added_at": "2023-04-24T11:35:52.0301298Z", "auction_rate_id": "d4aa20cc-500b-494d-b67e-77a9fe8826bf", "contact_id": 1, "loading_date": null, "rate_with_nds": 4500, "rate_without_nds": 5400, "state": 0 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:52.0302924Z", "start_date": "2023-04-24T11:30:52.0301216Z", "winner_criterion": 0 }, "auction_end_date": "2023-04-24T11:36:52.0300965Z", "result_status": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionRateStatusOfTaker" } }, "text/plain": { "examples": { "response": { "value": { "auction": { "auction_id": "8ef73743-fb35-4bdc-83a9-5904fa517ded", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "end_date": "2023-04-24T11:36:52.0301243Z", "finished": false, "is_our_rate_best": true, "load_id": "2f86f429-334a-4dae-be3f-624f92870829", "next_rate_with_nds": 5500, "next_rate_without_nds": 6600, "our_rate": { "added_at": "2023-04-24T11:35:52.0301298Z", "auction_rate_id": "d4aa20cc-500b-494d-b67e-77a9fe8826bf", "contact_id": 1, "loading_date": null, "rate_with_nds": 4500, "rate_without_nds": 5400, "state": 0 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:52.0302924Z", "start_date": "2023-04-24T11:30:52.0301216Z", "winner_criterion": 0 }, "auction_end_date": "2023-04-24T11:36:52.0300965Z", "result_status": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionRateStatusOfTaker" } } }, "description": "Статус ставки" }, "403": { "description": "У вас нет доступа на сохранение ставки" }, "404": { "description": "Торги (аукцион) не найдены" } }, "tags": [ "Auctions" ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/AuctionRateOfTakerDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuctionRateOfTakerDto" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AuctionRateOfTakerDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuctionRateOfTakerDto" } } }, "description": "Объект ставки Торгов (аукциона)" }, "summary": "Выставление ставки в Торгах (аукционе)" } }, "/v1.2/orders/invites/{loadId}/{contactId}": { "delete": { "tags": [ "Персональные приглашения" ], "summary": "Отказ от приглашения", "operationId": "PersonalInvitations_Delete", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "ID груза", "schema": { "type": "string", "format": "guid" }, "x-position": 1 }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" }, "x-position": 2 } ], "responses": { "200": { "description": "Успешный отказ от приглашения" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFinalException" } ] } } } } }, "security": [ { "JWT": [] } ] } } }, "components": { "schemas": { "BoardExchangeDirection": { "description": "Направление обмена информацией на площадке (влияет на права доступа участников по умолчанию)\n \n* `exchange` — Обмен грузами/машинами\n* `input` — Грузы/машины для владельца площадки\n* `output` - Грузы/машины от владельца площадки\n ", "enum": [ "input", "output", "exchange" ], "type": "string", "x-enumNames": [ "Input", "Output", "Exchange" ] }, "BoardType": { "description": "Тип содержимого на площадке\n* `loads` - Площадка с грузами\n* `trucks` - Площадка с машинами (зарезервировано, в данный момент такая возможность ещё не доступна)\n ", "enum": [ "loads", "trucks" ], "type": "string", "x-enumNames": [ "Loads", "Trucks" ] }, "CreateParticipantForIntegratorRequest": { "properties": { "ati_id": { "description": "код участника в ATI.SU\n ", "type": "string" }, "board_id": { "description": "ID площадки\n ", "type": "string" }, "contact_id": { "description": "ID контакта\n ", "format": "int32", "type": "integer" } }, "required": [ "ati_id", "board_id" ], "type": "object" }, "ErrorModel": { "properties": { "error": { "description": "Код ошибки", "type": "string" }, "reason": { "description": "Текст ошибки", "type": "string" } }, "required": [ "error", "reason" ], "type": "object" }, "IntegratorBoardInfo": { "description": "Информация о площадке (api v2)\n ", "properties": { "all_departments_allowed": { "description": "Площадка доступна всем подразделениям компании. Такую площадку могут видеть все сотрудники, независимо от их подразделения\nПример: true\n ", "type": "boolean" }, "available_for_contact": { "description": "Площадка доступна для данного контакта\nПример: `true`\n ", "type": "boolean" }, "board_exchange_direction": { "allOf": [ { "$ref": "#/components/schemas/BoardExchangeDirection" } ], "description": "Направление обмена информацией на площадке (влияет на права доступа участников по умолчанию)\n* `exchange` — Обмен грузами/машинами\n* `input` — Грузы/машины для владельца площадки\n* `output` - Грузы/машины от владельца площадки\n " }, "board_type": { "allOf": [ { "$ref": "#/components/schemas/BoardType" } ], "description": "Тип площадки\n* `loads` - Площадка с грузами\n* `trucks` - Площадка с машинами (зарезервировано, в данный момент такая возможность ещё не доступна)\n " }, "color": { "description": "Цвет площадки\nПример: `\"#FF00FF\"`\n ", "type": "string" }, "created_on": { "description": "Время создания площадки (timestamp)\nПример: `1556201954901`\n ", "format": "date-time", "type": "string" }, "departments_ids": { "description": "Перечень подразделений компании, которым доступна площадка\nПример: `[100302, 100303]`\n ", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "id": { "description": "ID площадки (строка 24 символа)\nПример: `\"507f1f77bcf86cd799439011\"`\n ", "type": "string" }, "name": { "description": "Название площадки\nПример: `\"Образцово-показательная площадка\"`\n ", "type": "string" }, "owner_firm": { "description": "Код участника ATI.SU создавшего площадку\nПример: `1111111`\n ", "format": "int32", "type": "integer" }, "updated_on": { "description": "Последнее время изменения площадки (Timestamp)\nПример: `1556201954901`\n ", "format": "date-time", "type": "string" }, "view_only_own": { "description": "Участник может видеть только свои грузы/машины\nПример: `true`\n ", "type": "boolean" } }, "required": [ "id", "name", "color", "created_on", "view_only_own", "updated_on", "board_type", "board_exchange_direction", "owner_firm", "available_for_contact", "all_departments_allowed", "departments_ids" ], "type": "object" }, "IntegratorBodyCreateRequest": { "properties": { "all_departments_allowed": { "description": "Площадка доступна всем подразделениям компании. Такую площадку могут видеть все сотрудники, независимо от их подразделения\nЕсли передано true, то DepartmentsIds должен быть null или пустым\nПример: true\n ", "type": "boolean" }, "board_exchange_direction": { "allOf": [ { "$ref": "#/components/schemas/BoardExchangeDirection" } ], "description": "Направление обмена информацией на площадке (влияет на права доступа участников по умолчанию)\n* `exchange` — Обмен грузами/машинами\n* `input` — Грузы/машины для владельца площадки\n* `output` - Грузы/машины от владельца площадки\n " }, "board_type": { "allOf": [ { "$ref": "#/components/schemas/BoardType" } ], "description": "Тип площадки\n* `loads` - Площадка с грузами\n* `trucks` - Площадка с машинами (зарезервировано, в данный момент такая возможность ещё не доступна)\n " }, "color": { "description": "Цвет плашки площадки\nПример: `\"#FF00FF\"`\n ", "type": "string" }, "departments_ids": { "description": "Перечень подразделений компании, которым доступна площадка.\nВ случае, если передан не пустой перечень значение AllDepartmentsAllowed должно быть false.\nОтветственный контакт ResponsibleContactId должен состоять (принадлежать) хотя бы одному из указанных подразделений\nПример: `[100302, 100303]`\n ", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "description": { "description": "Описание площадки (можно использовать тэги \"b\", \"i\", \"span\", \"u\", \"ul\", \"li\", \"br\")\nПример: `\"Лучшая площадка из всех созданных\"`\n ", "type": "string" }, "name_for_users": { "description": "Публичное имя, видимое участникам площадки (до 50 символов)\nПример: `\"Приходите, покупайте\"`\n ", "type": "string" }, "private_name": { "description": "Имя, которое видит только владелец площадки (до 50 символов)\nПример: `\"Покупайте, приходите\"`\n ", "type": "string" }, "public": { "description": "Открытая площадка или закрытая. На открытую может подать заявку на вступление любой пользователь. На закрытую можно\nпопасть только по приглашению владельца.\nПример: `true`\n ", "type": "boolean" }, "responsible_contact_id": { "description": "ID контакта ответственного пользователя\nПример: `1`\n ", "format": "int32", "type": "integer" }, "rules": { "description": "Правила участия, которые требуется принять участникам при вступлении (можно использовать тэги \"b\", \"i\", \"span\", \"u\", \"ul\", \"li\", \"br\")\nПример: `\"Только красные машины\"`\n ", "type": "string" } }, "required": [ "name_for_users", "private_name", "description", "rules", "color", "board_exchange_direction", "board_type", "public", "all_departments_allowed", "departments_ids" ], "type": "object" }, "SingleErrorModel": { "allOf": [ { "$ref": "#/components/schemas/ErrorModel" }, { "properties": { "details": { "additionalProperties": {}, "description": "Детали ошибки при валидации запроса.\nПоле может отсутствовать в ответе, если для данного типа ошибки оно не предусмотрено", "type": "object" }, "errors_list": { "description": "Список ошибок.\nПоле может отсутствовать в ответе, если для данного типа ошибки оно не предусмотрено", "items": { "type": "string" }, "type": "array" } }, "required": [ "details", "errors_list" ], "type": "object" } ] }, "LoadResponseModel": { "type": "object", "additionalProperties": false, "properties": { "ResponseId": { "type": "string", "description": "Id отзыва\\\nТолько для чтения", "format": "guid" }, "LoadId": { "type": "string", "description": "Id груза, на который оставлен отзыв\\\nТолько для чтения", "format": "guid" }, "LoadNumber": { "type": "string", "description": "Номер груза\\\nТолько для чтения" }, "LoadFirmId": { "type": "integer", "description": "Id фирмы, которой принадлежит груз\\\nТолько для чтения", "format": "int32" }, "FirmId": { "type": "integer", "description": "Id фирмы, которая оставила отзыв\\\nТолько для чтения", "format": "int32" }, "ContactId": { "type": "integer", "description": "Контакт, который сделал встречное предложение", "format": "int32" }, "AddedAt": { "type": "string", "description": "Дата добавления отзыва\\\nТолько для чтения", "format": "date-time" }, "UpdatedAt": { "type": "string", "description": "Дата изменения отзыва\\\nТолько для чтения", "format": "date-time" }, "Price": { "type": "number", "description": "Предложенная ставка встречного предложения не б/нал. Параметр должен быть равен одной из ставок груза: RateSum, SumWithNDS или SumWithoutNDS, если у груза, которому выставляется встречное предложение, параметр FixedRate равен True И параметр Torg равен False.\tЗначение больше 0 и содержит не более 10 символов.", "format": "decimal" }, "CurrencyId": { "type": "integer", "description": "Валюта встречного предложения. Параметр должен быть равен валюте, указанной в грузе, если параметр FixedRate равен True и параметр Torg равен False\\\nЗначение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/cargoes/)", "format": "int32" }, "NdsPrice": { "type": "number", "description": "Предложенная ставка встречного предложения б/нал с НДС", "format": "decimal" }, "NdsCurrencyId": { "type": "integer", "description": "Валюта ставки встречного предложения б/нал с НДС.Параметр должен быть равен валюте, указанной в грузе, если параметр FixedRate равен True и параметр Torg равен False.\\\nЗначение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/cargoes/)", "format": "int32" }, "NotNdsPrice": { "type": "number", "description": "Предложенная ставка встречного предложения б/нал без НДС", "format": "decimal" }, "NotNdsCurrencyId": { "type": "integer", "description": "Валюта ставки встречного предложения б/нал без НДС. Параметр должен быть равен валюте, указанной в грузе, если параметр FixedRate равен True и параметр Torg равен False\\\nЗначение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/cargoes/)", "format": "int32" }, "Note": { "type": "string", "description": "Примечание к встречному предложению\\\nМаксимальная длина - 512 символов" }, "PayAttributes": { "type": "integer", "description": "Атрибуты оплаты, по умолчанию - 0.\nБитовая сумма следующих параметров:\n\n* `1` - возможна оплата наличными\n* `2` - возможна оплата по безналичному рассчету\n* `4` - блиц\n* `8` - оплата с НДС\n* `16` - возможна предоплата\n* `32` - оплата на выгрузке\n* `64` - включена ли оплата через некоторое количество банковских дней", "format": "int32" }, "PrepayPercent": { "type": "integer", "description": "Процент предоплаты\\\nДолжен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100", "format": "int32" }, "PayAfterMaxBankDays": { "type": "integer", "description": "Оплата через ... банковских дней\\\nДолжен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 64 - включена оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99", "format": "int32" }, "LoadingDate": { "type": "string", "description": "Дата, когда предложивший хочет перевезти ваш груз", "format": "date-time", "nullable": true }, "IsOutdated": { "type": "boolean", "description": "Определяет, просрочен ли отзыв. Когда груз редактируют, удаляют, обновляют, отзыв помечается просроченным.\\\nТолько для чтения." }, "IsLoadPublished": { "type": "boolean", "description": "Относится ли отзыв к публикующемуся грузу\\\nТолько для чтения" }, "IsNoLoad": { "type": "boolean", "description": "Параметр \"Груза нет\"" }, "AnnouncedCurrencyId": { "type": "integer", "description": "Валюта \"Озвученной ставки\"\\\nЗначение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/cargoes/)", "format": "int32" }, "AnnouncedRate": { "type": "integer", "description": "Озвученная ставка", "format": "int32" } } }, "PaymentSource": { "type": "integer", "description": "", "x-enumNames": [ "None", "CounterOffer", "Auction", "Load" ], "enum": [ 0, 1, 2, 3 ] }, "DocumentType": { "type": "integer", "description": "", "x-enumNames": [ "None", "Order", "Application", "ForwarderInstruction", "Act", "Invoice", "UnilateralDissolution" ], "enum": [ 0, 1, 2, 3, 4, 5, 6 ] }, "LoadMeta": { "type": "object", "additionalProperties": false, "properties": { "LoadMetaId": { "type": "string", "format": "guid", "nullable": true }, "MetaData": { "type": "string" } } }, "LoadPoint": { "type": "object", "additionalProperties": false, "properties": { "FiasId": { "type": "string", "format": "guid" }, "CityId": { "type": "integer", "format": "int32" }, "Latitude": { "type": "number", "format": "decimal", "nullable": true }, "Longitude": { "type": "number", "format": "decimal", "nullable": true }, "Street": { "type": "string", "default": "" }, "TimeStart": { "type": "string", "format": "date-time", "nullable": true }, "TimeEnd": { "type": "string", "format": "date-time", "nullable": true }, "StartTime": { "type": "string", "format": "date-time", "nullable": true }, "EndTime": { "type": "string", "format": "date-time", "nullable": true }, "IsRoundTheClock": { "type": "boolean" }, "LargeCities": { "type": "array", "description": "Список ID'ников ближайший крупных городов", "items": { "type": "integer", "format": "int32" } }, "LargeCitiesWithDistance": { "type": "array", "description": "Список ID'ников ближайший крупных городов c расстояниями до них", "items": { "$ref": "#/components/schemas/LargeCityWithDistance" } }, "LoadingCargos": { "type": "array", "items": { "$ref": "#/components/schemas/LoadingCargo" } } } }, "LargeCityWithDistance": { "type": "object", "additionalProperties": false, "properties": { "CityId": { "type": "integer", "format": "int32" }, "Distance": { "type": "number", "format": "double" } } }, "LoadingCargo": { "type": "object", "additionalProperties": false, "properties": { "CargoId": { "type": "integer", "description": "Id груза", "format": "int32" }, "NameId": { "type": "integer", "description": "Наименование груза", "format": "int32" }, "Name": { "type": "string" }, "PackagingType": { "type": "integer", "description": "Упаковка", "format": "int32", "nullable": true }, "PackagingQuantity": { "type": "integer", "format": "int32", "nullable": true }, "Weight": { "type": "number", "format": "double", "nullable": true }, "Volume": { "type": "number", "description": "Объем", "format": "double", "nullable": true }, "Sizes": { "description": "Габариты", "$ref": "#/components/schemas/LoadSize" } } }, "LoadSize": { "type": "object", "additionalProperties": false, "properties": { "Length": { "type": "number", "format": "double" }, "Width": { "type": "number", "format": "double" }, "Height": { "type": "number", "format": "double" }, "Diameter": { "type": "number", "format": "double" }, "LengthHighlight": { "type": "boolean" }, "WidthHighlight": { "type": "boolean" }, "HeightHighlight": { "type": "boolean" } } }, "LoadExtraPoint": { "type": "object", "additionalProperties": false, "properties": { "CityId": { "type": "integer", "description": "ID города", "format": "int32" }, "PointType": { "type": "integer", "description": "Тип точки, где 1 - загрузка, 2 - разгрузка, 3 - таможня, 8 - проехать через", "format": "int32" }, "Latitude": { "type": "number", "description": "Долгота", "format": "decimal", "nullable": true }, "Longitude": { "type": "number", "description": "Широта", "format": "decimal", "nullable": true }, "Street": { "type": "string", "description": "Улица" }, "OrdinalId": { "type": "integer", "description": "Порядковый номер", "format": "int32" }, "IsRoundTheClock": { "type": "boolean" }, "LoadingDateStart": { "type": "string", "format": "date-time", "nullable": true }, "LoadingDateEnd": { "type": "string", "format": "date-time", "nullable": true }, "LoadingTimeStart": { "type": "string", "format": "time-span", "nullable": true }, "LoadingTimeEnd": { "type": "string", "format": "time-span", "nullable": true }, "LoadingCargos": { "type": "array", "items": { "$ref": "#/components/schemas/LoadingCargo" } }, "UnloadingCargos": { "type": "array", "items": { "$ref": "#/components/schemas/UnloadingCargo" } } } }, "UnloadingCargo": { "type": "object", "additionalProperties": false, "properties": { "CargoId": { "type": "integer", "description": "Id груза", "format": "int32" }, "Weight": { "type": "number", "description": "Вес", "format": "double", "nullable": true }, "Volume": { "type": "number", "description": "Объём", "format": "double", "nullable": true }, "PackagingQuantity": { "type": "integer", "description": "Выгружаемая часть упаковки", "format": "int32", "nullable": true }, "IsDefinedByTtn": { "type": "boolean", "description": "Выгружаемая часть груза будет определена в ТТН" } } }, "LoadCargo": { "type": "object", "additionalProperties": false, "properties": { "Weight": { "type": "number", "description": "Вес", "format": "double" }, "Volume": { "type": "number", "description": "Объем", "format": "double" }, "ADR": { "type": "integer", "format": "int32" }, "CargoTypeId": { "type": "integer", "description": "ID наименования груза, может быть пустым", "format": "int32" }, "CargoType": { "type": "string", "description": "Строковое наименование груза. Выводится если ID не указан, либо равен 59", "default": "" }, "PackType": { "type": "integer", "description": "Тип упаковки(навалом, коробки, россыпью, запаллечен ... пирамида)", "format": "int32" }, "PalletCount": { "type": "integer", "format": "int32" }, "BeltCount": { "type": "integer", "format": "int32" }, "DogruzType": { "type": "integer", "format": "int32" }, "SborGruz": { "type": "boolean" }, "Size": { "$ref": "#/components/schemas/LoadSize" } } }, "LoadTransport": { "type": "object", "additionalProperties": false, "properties": { "CarType": { "type": "integer", "description": "Битовая сумма ID кузовов", "format": "int64" }, "LoadingType": { "type": "integer", "description": "битовая сумма ID типов загрузки. Брать из LoadType", "format": "int32" }, "LoadingLogicalOperator": { "type": "string", "description": "тип условия загрузки, or и and", "default": "OR" }, "UnloadingType": { "type": "integer", "description": "битовая сумма ID типов разгрузки. Брать из LoadType", "format": "int32" }, "UnloadingLogicalOperator": { "type": "string", "description": "тип условия разгрузки, or и and", "default": "OR" }, "TrucksQuantity": { "type": "integer", "description": "Количество машин", "format": "int32" }, "TemperatureFrom": { "type": "integer", "format": "int32", "nullable": true }, "TemperatureTo": { "type": "integer", "format": "int32", "nullable": true }, "Stsepka": { "type": "boolean" }, "Pnevmohod": { "type": "boolean" }, "Koniki": { "type": "boolean" }, "TIR": { "type": "boolean" }, "CMR": { "type": "boolean" }, "T1": { "type": "boolean" }, "SanPassport": { "type": "boolean" }, "IsTracking": { "type": "boolean", "description": "Трекинг через АТИ Водитель" } } }, "DealState": { "type": "integer", "description": "", "x-enumNames": [ "Reserve", "Taken", "TakenViewed", "DocumentSentByCargoOwner", "DocumentApprovedByTrucker", "Finished", "LoadRemovedFromCompleted", "PersonalDealInvite", "AuctionWithPossibleWinner", "DenialInAuctionByDocExpired", "CancelInWorkByCargoOwner", "CancelInWorkByTrucker", "DenialBecauseDeleteAuction", "DenialByCargoOwnerWithDocument", "DenialInAuction", "DenialByCargoOwner", "DenialByTrucker", "DenialByTruckerWithDocument" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, -9, -8, -7, -6, -5, -4, -3, -2, -1 ] }, "DealKinds": { "type": "integer", "description": "Тип сделки:\n \n* `0` - ничего нельзя\n* `1` - обычная\n* `2` - с аукционом\n* `4` - персональная\n* `8` - перехват машин", "x-enumFlags": true, "x-enumNames": [ "None", "OrdinaryDeal", "AuctionDeal", "PersonalDeal", "TruckInterDeal" ], "enum": [ 0, 1, 2, 4, 8 ] }, "AuctionState": { "type": "integer", "description": "Статус аукциона\n\n* `-100` - Не удалось определить состояние аукциона\n* `-14` - Аукцион отменен руками грузовладельца\n* `-13` - Аукцион удален, т.к. расторгнут заказ\n* `-12` - Аукцион без ставок завершен\n* `-11` - Аукцион удален автоматически\n* `-10` - Аукцион удален т.к. сделка завершена\n* `-9` - Аукцион удален\n* `-8` - При включенном копировании грузов: ожидается действие от экспедитора в случае, когда заказ с победителем отменен, других участников нет\n* `-7` - При включенном копировании грузов:ожидается действие с торгами от экспедитора в случае, когда заказ с победителем отменен и есть потенциальный победитель\n* `-6` - При включенном копировании грузов: торги завершены, экспедитор не является победителем\n* `-5` - Одна ставка лучшая по цене, другая по дате\n* `-4` - Закончился, но победитель вовремя не взял груз и при этом есть еще возможные победители\n* `-3` - Закончился, но победитель вовремя не взял груз и при этом он единственный возможный победитель\n* `-2` - Закончился, ждем когда победитель возьмет груз\n* `-1` - Закончился, ставок нет\n* `0` - Идет, ставок нет\n* `1` - Идет (уже есть валидные ставки)", "x-enumNames": [ "OnAndNoRates", "OnAndHasRates", "UnknownState", "DeclinedByOwner", "DeletedByDeclinedOrder", "DeletedWithoutRates", "DeletedByAutoDecline", "DeletedByDealFinished", "Deleted", "FinishedWithoutOtherBetsAndNeedChooseAction", "FinishedWithOtherBetsAndNeedChooseAction", "FinishedWithWinnerFromOtherAuction", "FinishedWithIncomparableRates", "FinishedAndNoDocsButHasOtherPossibleWinners", "FinishedAndNoDocsFromSingleWinner", "FinishedAndAwaitingDocs", "FinishedAndNoRates" ], "enum": [ 0, 1, -100, -14, -13, -12, -11, -10, -9, -8, -7, -6, -5, -4, -3, -2, -1 ] }, "AuctionPaymentType": { "type": "integer", "description": "Тип оплаты:\n\n* `1` = Наличка\n* `22` - Любая\n* `23` = На карту\n* `24` - С НДС\n* `25` - Без ДНС\n* Остальные зарезервированы", "x-enumNames": [ "Cash", "Any", "OnCard", "CashlessWithNds", "CashlessWithoutNds" ], "enum": [ 1, 22, 23, 24, 25 ] }, "FirmStatus": { "type": "integer", "description": "Тип звезд фирмы\n \n* `0`: Серый\n* `1`: Красный\n* `2`: Желтый\n* `3`: Зеленый\n* `4`: Партнер АТИ\n* `5`: Сотрудник АТИ\n* `6`: Гос. органы\n* `7`: ОДКС", "x-enumNames": [ "Gray", "Green", "Yellow", "Red", "AtiPartner", "AtiEmployee", "GosOrgan", "Odks" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ] }, "AuctionRateState": { "type": "integer", "description": "Статус ставки\n \n* `1`: Победная ставка в аукционе\n* `0`: Обычная ставка по аукциону (участник аукциона)\n* `-2`: Участник аукциона отменил ставку\n* `-3`: Бывший победитель, который не прислал документы\n* `-4`: Победитель отказался от участия\n* `-5`: Грузовладелец отменил безоговорочную сделку\n* `-6`: Победитель отменил безоговорочную сделку\n* `-7`: Победитель отклонил документ\n* `-8`: Грузовладелец отклонил документ", "x-enumNames": [ "Undecided", "Winner", "CargoOwnerDeclineDocument", "WinnerDeclineDocument", "WinnerRefuseDeal", "CargoOwnerRefuseDeal", "WinnerRefused", "ExWinner", "Refused", "Loser" ], "enum": [ 0, 1, -8, -7, -6, -5, -4, -3, -2, -1 ] }, "AuctionFinishType": { "type": "integer", "description": "Тип окончания аукциона\n\n* `0` - По времени\n* `1` - По минимальной ставке\n* `2` - Досрочное", "x-enumNames": [ "Normal", "ByMinimalRate", "Force" ], "enum": [ 0, 1, 2 ] }, "BoardView": { "type": "object", "additionalProperties": false, "properties": { "Color": { "type": "string" }, "Id": { "type": "string" }, "Name": { "type": "string" }, "OriginalName": { "type": "string" } } }, "AuctionFinishAction": { "type": "integer", "description": "Действие после того, как все попытки перезапуска и выбора нового победителя торгов исчерпаны:\n\n* `1` - Опубликовать груз со ставкой. В грузе должна быть указана ставка (SumWithNDS, SumWithoutNDS, RateSum)\n* `2` - Опубликовать с запросом ставки, возможные типы оплаты будут взяты из поля AcceptPaymentTypes в грузе\n* `3` - Перенести груз в архив", "x-enumNames": [ "PublishLoad", "PublishLoadWithRateRequest", "DeleteLoad" ], "enum": [ 1, 2, 3 ] }, "WinnerCriteria": { "type": "integer", "description": "Критерий победы в аукционе\n\n* `0` - Выбор победителя происходит автоматически по лучшей ставке\n* `1` - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную", "x-enumNames": [ "Rate", "RateAndLoadingDate" ], "enum": [ 0, 1 ] }, "ArchiveReason": { "type": "string", "description": "", "x-enumNames": [ "Unknown", "System", "Manual", "Complaints", "UnwantedContent", "DeleteCsvLoad", "MergeLoadsAfterEdit", "ContactDoesNotHaveAccessToVirtualPayments", "VerticesLoadDelete", "StealthStatisticError", "CheckDuplicateComplaints", "DeleteContact", "DeleteFirm", "CleanOldLoadsJob" ], "enum": [ "Unknown", "System", "Manual", "Complaints", "UnwantedContent", "DeleteCsvLoad", "MergeLoadsAfterEdit", "ContactDoesNotHaveAccessToVirtualPayments", "VerticesLoadDelete", "StealthStatisticError", "CheckDuplicateComplaints", "DeleteContact", "DeleteFirm", "CleanOldLoadsJob" ] }, "LoadAccessDeniedReason": { "type": "integer", "description": "Причины отказа в доступе:\n \n* `0` - Вы имеете доступ к работе с грузом\n* `1` - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ\n* `2` - Груз зарезервирован/взят, операции с грузом запрещены\n* `3` - Превышен лимит актуальных грузов\n* `4` - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав\n* `5` - У вашего контакта недостаточно прав для работы с данным грузом\n* `6` - Груз имеет завершенные Торги, операции с грузом запрещены\n* `7` - Сервис сделок временно недоступен\n* `8` - Нельзя изменять или удалять груз из сквозных торгов\n* `9` - У вашего контакта недостаточно прав для создания грузов\n* `10` - У вашего контакта недостаточно прав для работы с виртуальными кошельками\n* `11` - У вашего контакта недостаточно прав для работы с грузами на Общей площадке\n* `12` - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках\n* `13` - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе\n* `14` - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз\n* `15` - Ваш контакт должен быть указан первым в грузе", "x-enumNames": [ "None", "FirmDoesNotHaveAccess", "LoadReserved", "ActualLoadsLimitExceeded", "LoginAsCommonUser", "ContactDoesNotHaveAccessToCurrentLoad", "LoadHasAuctionFinished", "DealsServiceUnavailable", "PassThroughCopy", "ContactDoesNotHaveAccessToLoadCreation", "ContactDoesNotHaveAccessToVirtualPayments", "ContactCantWorkWithCommonBoards", "ContactCantWorkWithPersonalBoards", "ContactDoesntHaveAccessToAllBoards", "ContactDoesntHaveAccessToLoadDepartment", "ContactMustBeSelectedFirst" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ] }, "CounterOfferSource": { "type": "integer", "description": "Обозначение откуда было добавлено встречное предложение.\n\n* `0` - Неизвестный источник\n* `1` - Мобильное приложение\n* `2` - Интегратор\n* `3` - Перехват грузов интегратором\n* `4` - Страница поиска грузов\n* `5` - Перехват машин\n* `6` - Сквозное встречное предложение, добавлено автоматически", "x-enumNames": [ "Site", "Mobile", "Integrator", "CarrierInterception", "Search", "TruckInterception", "PassThrough" ], "enum": [ 0, 1, 2, 3, 4, 5, 6 ] }, "FinalExceptionModelOfFinalException": { "type": "object", "description": "Модель ошибки", "additionalProperties": false, "properties": { "Reason": { "type": "string", "description": "Причина ошибки" }, "Error": { "type": "string", "description": "Ключ ошибки" } } }, "LoadView": { "allOf": [ { "$ref": "#/components/schemas/BaseLoadView" }, { "type": "object", "additionalProperties": false, "properties": { "ArchiveDate": { "type": "string", "description": "Дата и время переноса в архив", "format": "date-time", "nullable": true }, "ArchiveReason": { "description": "Причина переноса в архив", "nullable": true, "$ref": "#/components/schemas/ArchiveReason" }, "TruePrice": { "type": "integer", "description": "Озвученная ставка", "format": "int32" }, "TrueCurrencyId": { "type": "integer", "description": "ID валюты озвученной ставки", "format": "int32" }, "ResponseCount": { "type": "integer", "description": "Количество отзывов о грузе (без встречных предложений)", "format": "int32" }, "OfferCount": { "type": "integer", "description": "Количество встречных предложений (остальные отзывы не учитываются)", "format": "int32" }, "CanBeDeleted": { "type": "boolean", "description": "Есть ли доступ на удаление груза." }, "HasPermissionsToLoad": { "type": "boolean", "description": "Есть ли доступ на работу с грузом (без учета прав)." }, "CanBeEdited": { "type": "boolean", "description": "Есть ли доступ на редактирование груза." }, "CanBeRenewed": { "type": "boolean", "description": "Есть ли доступ на обновление груза." }, "CanBeRestored": { "type": "boolean", "description": "Есть ли доступ на восстановление груза" }, "EditRestriction": { "description": "Причины отказа в доступе на редактирование груза:\n \n* `0` - Вы имеете доступ к работе с грузом\n* `1` - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ\n* `2` - Груз зарезервирован/взят, операции с грузом запрещены\n* `3` - Превышен лимит актуальных грузов\n* `4` - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав\n* `5` - У вашего контакта недостаточно прав для работы с данным грузом\n* `6` - Груз имеет завершенные Торги, операции с грузом запрещены\n* `7` - Сервис сделок временно недоступен\n* `8` - Нельзя изменять или удалять груз из сквозных торгов\n* `9` - У вашего контакта недостаточно прав для создания грузов\n* `10` - У вашего контакта недостаточно прав для работы с виртуальными кошельками\n* `11` - У вашего контакта недостаточно прав для работы с грузами на Общей площадке\n* `12` - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках\n* `13` - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе\n* `14` - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз\n* `15` - Ваш контакт должен быть указан первым в грузе", "$ref": "#/components/schemas/LoadAccessDeniedReason" }, "DeleteRestriction": { "description": "Причины отказа в доступе на удаление контакта:\n \n* `0` - Вы имеете доступ к работе с грузом\n* `1` - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ\n* `2` - Груз зарезервирован/взят, операции с грузом запрещены\n* `3` - Превышен лимит актуальных грузов\n* `4` - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав\n* `5` - У вашего контакта недостаточно прав для работы с данным грузом\n* `6` - Груз имеет завершенные Торги, операции с грузом запрещены\n* `7` - Сервис сделок временно недоступен\n* `8` - Нельзя изменять или удалять груз из сквозных торгов\n* `9` - У вашего контакта недостаточно прав для создания грузов\n* `10` - У вашего контакта недостаточно прав для работы с виртуальными кошельками\n* `11` - У вашего контакта недостаточно прав для работы с грузами на Общей площадке\n* `12` - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках\n* `13` - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе\n* `14` - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз\n* `15` - Ваш контакт должен быть указан первым в грузе", "$ref": "#/components/schemas/LoadAccessDeniedReason" }, "RestoreRestriction": { "description": "Причины отказа в доступе на восстановление груза:\n \n* `0` - Вы имеете доступ к работе с грузом\n* `1` - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ\n* `2` - Груз зарезервирован/взят, операции с грузом запрещены\n* `3` - Превышен лимит актуальных грузов\n* `4` - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав\n* `5` - У вашего контакта недостаточно прав для работы с данным грузом\n* `6` - Груз имеет завершенные Торги, операции с грузом запрещены\n* `7` - Сервис сделок временно недоступен\n* `8` - Нельзя изменять или удалять груз из сквозных торгов\n* `9` - У вашего контакта недостаточно прав для создания грузов\n* `10` - У вашего контакта недостаточно прав для работы с виртуальными кошельками\n* `11` - У вашего контакта недостаточно прав для работы с грузами на Общей площадке\n* `12` - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках\n* `13` - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе\n* `14` - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз\n* `15` - Ваш контакт должен быть указан первым в грузе", "$ref": "#/components/schemas/LoadAccessDeniedReason" }, "RenewRestriction": { "type": "string", "description": "Причина отказа в доступе на обновление груза." }, "Id": { "type": "string", "description": "Идентификатор груза", "format": "guid" }, "LoadNumber": { "type": "string", "description": "Номер груза" }, "RefreshedAt": { "type": "string", "description": "Дата последнего обновления груза в формате UTC (поднятие груза в поисковой выдаче)", "format": "date-time" }, "UpdatedAt": { "type": "string", "description": "Дата последнего изменения груза в формате UTC", "format": "date-time" }, "AddedAt": { "type": "string", "description": "Время добавления груза в формате UTC", "format": "date-time" }, "Distance": { "type": "integer", "description": "Расстояние по дорогам в км", "format": "int32" }, "PlatonRoadsLength": { "type": "integer", "description": "Протяженность дорог в км, в построенном пути за которые взимается плата по системе Платон", "format": "int32" }, "TollRoadsLength": { "type": "integer", "description": "Протяженность платных дорог в построенном пути в км", "format": "int32" }, "TravelTime": { "type": "string", "description": "Время в пути\n ", "format": "time-span" }, "Zimnik": { "type": "boolean", "description": "Параметр, который определяет, включен ли зимник для перевозки груза" }, "Ferries": { "type": "boolean", "description": "Параметр, который определяет, учитывать ли паромные переправы для перевозки груза" }, "FirmId": { "type": "string", "description": "Идентификатор фирмы" }, "AuctionId": { "type": "string", "description": "Id аукциона", "format": "guid", "nullable": true }, "PriorityView": { "description": "Приоритетный показ", "$ref": "#/components/schemas/LoadPriorityViewView" }, "Deal": { "$ref": "#/components/schemas/DealItemView" }, "Boards": { "type": "array", "description": "Список площадок", "items": { "$ref": "#/components/schemas/LoadBoardView" } } } } ] }, "LoadPriorityViewView": { "allOf": [ { "$ref": "#/components/schemas/BaseLoadPriorityViewView" }, { "type": "object", "additionalProperties": false, "properties": { "MoneySpentPerDay": { "type": "number", "description": "Количество денег, потраченное на заявку за день. Только для чтения ", "format": "decimal" }, "MoneySpentPerOrder": { "type": "number", "description": "Количество денег, потраченное на заявку в целом. Только для чтения ", "format": "decimal" } } } ] }, "BaseLoadPriorityViewView": { "type": "object", "additionalProperties": false, "required": [ "ViewRate" ], "properties": { "DailyLimit": { "type": "number", "description": "Суточный лимит списания по услуге\n \n* Должен иметь длину не более 5 символов\n* Не более 2 символов после запятой\n* Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)\n* Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0", "format": "decimal" }, "IsForPayedOnly": { "type": "boolean", "description": "Показывать приоритетный показ только платным пользователям" }, "OrderLimit": { "type": "number", "description": "Лимит на заявку\n \n* Должен иметь длину не более 5 символов\n* Не более 2 символов после запятой\n* Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)\n* Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0", "format": "decimal" }, "ViewRate": { "type": "number", "description": "Ставка за просмотр\n \n* Минимальное значение 0,6\n* Не более 2 символов после запятой\n* Должен иметь длину не более 5 символов", "format": "decimal" } } }, "DealItemView": { "allOf": [ { "$ref": "#/components/schemas/BaseDealItemView" }, { "type": "object", "additionalProperties": false, "properties": { "Auction": { "description": "Параметры аукциона", "$ref": "#/components/schemas/AuctionView" } } } ] }, "AuctionView": { "allOf": [ { "$ref": "#/components/schemas/BaseAuctionView" }, { "type": "object", "additionalProperties": false, "properties": { "AuctionId": { "type": "string", "description": "Id аукциона", "format": "guid" }, "LoadId": { "type": "string", "description": "Id груза, для которого активен аукцион", "format": "guid" }, "ActiveDealId": { "type": "string", "description": "Id сделки, привязанной к аукциону", "format": "guid", "nullable": true }, "State": { "description": "Статус аукциона\n\n* `-100` - Не удалось определить состояние аукциона\n* `-14` - Аукцион отменен руками грузовладельца\n* `-13` - Аукцион удален, т.к. расторгнут заказ\n* `-12` - Аукцион без ставок завершен\n* `-11` - Аукцион удален автоматически\n* `-10` - Аукцион удален т.к. сделка завершена\n* `-9` - Аукцион удален\n* `-8` - При включенном копировании грузов: ожидается действие от экспедитора в случае, когда заказ с победителем отменен, других участников нет\n* `-7` - При включенном копировании грузов:ожидается действие с торгами от экспедитора в случае, когда заказ с победителем отменен и есть потенциальный победитель\n* `-6` - При включенном копировании грузов: торги завершены, экспедитор не является победителем\n* `-5` - Одна ставка лучшая по цене, другая по дате\n* `-4` - Закончился, но победитель вовремя не взял груз и при этом есть еще возможные победители\n* `-3` - Закончился, но победитель вовремя не взял груз и при этом он единственный возможный победитель\n* `-2` - Закончился, ждем когда победитель возьмет груз\n* `-1` - Закончился, ставок нет\n* `0` - Идет, ставок нет\n* `1` - Идет (уже есть валидные ставки)", "$ref": "#/components/schemas/AuctionState" }, "Finished": { "type": "boolean", "description": "Завершен ли аукцион" }, "WinDate": { "type": "string", "description": "Время выигрыша ставки (когда для определенной ставки в AuctionRates установлен State = Winner)", "format": "date-time", "nullable": true }, "AuctionRates": { "type": "array", "description": "Список ставок по аукциону", "items": { "$ref": "#/components/schemas/AuctionRateView" } } } } ] }, "AuctionRateView": { "type": "object", "additionalProperties": false, "properties": { "AuctionRateId": { "type": "string", "description": "ID ставки", "format": "guid" }, "AddedAt": { "type": "string", "description": "Когда сделана ставка", "format": "date-time" }, "RateFirm": { "description": "Фирма, оставившая заявку", "$ref": "#/components/schemas/FirmStarsInfoView" }, "Rate": { "type": "number", "description": "Ставка на груз, которую поставил пользователь", "format": "decimal" }, "State": { "$ref": "#/components/schemas/AuctionRateState" }, "LoadingDate": { "type": "string", "description": "Ближайшая возможная для перевозчика дата загрузки\\\nИспользуется только в аукционах с критерием победы по ставке и дате загрузки", "format": "date-time", "nullable": true }, "FirmId": { "type": "integer", "description": "Код фирмы, сделавшей ставку", "format": "int32" }, "ContactId": { "type": "integer", "description": "Контакт, сделавший ставку", "format": "int32" } } }, "FirmStarsInfoView": { "type": "object", "additionalProperties": false, "properties": { "Score": { "type": "number", "description": "\"Звезды\" фирмы", "format": "double" }, "Status": { "$ref": "#/components/schemas/FirmStatus" }, "Name": { "type": "string", "description": "Имя фирмы" }, "ContactName": { "type": "string", "description": "Имя контакта" }, "AtiId": { "type": "string", "description": "Идентификатор фирмы в АТИ" } } }, "BaseAuctionView": { "type": "object", "additionalProperties": false, "required": [ "StartRate", "Currency", "Step", "PaymentType", "TimeToProvideDocuments" ], "properties": { "StartRate": { "type": "number", "description": "Начальная ставка аукциона\\\nПараметр должен принимать значение от 1 до 9999999999 (включительно) и содержать не более 10 символов.\t", "format": "decimal" }, "Currency": { "type": "integer", "description": "Валюта аукциона\\\nЗначение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/cargoes/)", "format": "int32" }, "Step": { "type": "number", "description": "Минимальное изменение ставки по аукциону\\\nПараметр должен принимать значение от 1 до 9999999999 (включительно), содержать не более 10 символов и не должен превышать половину начальной ставки startRate.", "format": "decimal" }, "PaymentType": { "description": "Тип оплаты\n \n* `22`: любой\n* `1`: наличные\n* `23`: по карте\n* `24`: безнал с НДС\n* `25`: безнал без НДС", "$ref": "#/components/schemas/AuctionPaymentType" }, "AcceptSecondPayType": { "type": "boolean", "description": "Принимать ставки без НДС. Параметр можно указать, если начальная ставка указана с НДС (PaymentType=24)" }, "StartDate": { "type": "string", "description": "Время начала аукциона. Должно быть позже времени начала публикации груза на площадке. По умолчанию устанавливается текущая дата UTC.\t", "format": "date-time" }, "EndDate": { "type": "string", "description": "Время окончания аукциона. Необязательное поле, если есть значение в поле Duration", "format": "date-time", "nullable": true }, "EndDateBoundary": { "type": "string", "description": "Время окончания аукциона \"завершить не позже\". Если указанное время, меньше значения Duration - аукцион заканчивается по времени \"завершить не позже\", если нет автопродления. Время устанавливается в формате UTC.\t", "format": "date-time", "nullable": true }, "Nds": { "type": "number", "description": "% НДС, от 1 до 99. Если выбрана опция \"Принимать ставки без НДС\", этот параметр определяет величину процента НДС.\t", "format": "decimal", "nullable": true }, "TimeToProvideDocuments": { "type": "number", "description": "Время на отправку заявки перевозчиком (в часах). Время на отправку заявки перевозчику должно быть не больше 24 часов, и не должно превышать 4 символов в длину.\t", "format": "decimal" }, "AutoRenew": { "type": "boolean", "description": "Нужно ли продление аукциона, если была ставка в последние 5 минут до окончания" }, "RenewTime": { "type": "integer", "description": "Время, на которое надо сдвигать окончание аукциона при включенном AutoRenew", "format": "int32", "nullable": true }, "MaxRenewTime": { "type": "integer", "description": "Максимально допустимое время, на которое можно сдвинуть окончание аукциона при включенном AutoRenew\\\nУказывать, если raiseBid = true. Параметр должен принимать значение от 1 до 999999 (включительно) и содержать не более 6 символов.", "format": "int32", "nullable": true }, "RaiseBid": { "type": "boolean", "description": "Повысить ставку на Шаг, если нет предложений" }, "MaxRate": { "type": "number", "description": "Максимально допустимая ставка по аукциону\\\nУказывать, если raiseBid = true. Параметр должен принимать значение от 1 до 999999 (включительно) и содержать не более 6 символов.", "format": "decimal", "nullable": true }, "RaiseBidInterval": { "type": "integer", "description": "Период увеличения ставки при отсутствии предложений\\\nПри RaiseBid = true должно принимать значение не меньше 1 минуты и не больше 24 часов.", "format": "int32", "nullable": true }, "ResponseInMinutes": { "type": "integer", "description": "Указывает, через какой промежуток времени с момента публикации аукциона принимать встречные предложения:\n \n* `1` - сразу\n* `15, 30, 60, 120, 180` - время в минутах\n* `null` - не принимать\n \nЕсли AcceptCounterOffersOnlyBeforeFirstBet = true, то встречные предложения будут приниматься только до 1-й ставки", "format": "int32", "nullable": true }, "Duration": { "type": "integer", "description": "Длительность аукциона в минутах: 30, 60, 120, 180, 240, 360, 720, 1440, 2880, 4320, 5760, 7200\\\nЗначение не может быть больше времени актуальности груза LastDate", "format": "int32" }, "StartSinceFirstBet": { "type": "boolean", "description": "Флаг, определяющий, что обратный отсчет до окончания аукциона начинается только после первой ставки." }, "AuctionRestartParameters": { "description": "Параметры перезапуска аукциона", "$ref": "#/components/schemas/AuctionRestartParametersView" }, "AcceptCounterOffersOnlyBeforeFirstBet": { "type": "boolean", "description": "Можно принимать встречные предложения только до первой ставки?" }, "WinnerCriterion": { "description": "Критерий выбора победителя торгов\n\n* `0` - Выбор победителя происходит автоматически по лучшей ставке\n* `1` - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную.", "$ref": "#/components/schemas/WinnerCriteria" } } }, "AuctionRestartParametersView": { "type": "object", "additionalProperties": false, "properties": { "AuctionFinishAction": { "$ref": "#/components/schemas/AuctionFinishAction" }, "InitRestartCount": { "type": "integer", "description": "Количество перезапусков Торгов, от 0 до 3 включительно.\\\nЕсли параметр не передать, по умолчанию 0", "format": "int32" }, "InitChangeWinnerCount": { "type": "integer", "description": "Сколько раз выбирать следующего победителя с лучшей ставкой, если предыдущий отказался, от 0 до 3 включительно\\\nЕсли параметр не передать, по умолчанию 0", "format": "int32" }, "DurationAfterRestart": { "type": "integer", "description": "Длительность торгов в минутах после перезапуска\\\nНеобязательное поле, если его не передавать, то торги будут перезапущены с изначальной длительностью (поле Duration в структуре Аукцион). Однако если в структуре Аукцион заполнено поле EndDateBoundary и поле InitRestartCount имеет значение больше 0, то DurationAfterRestart становится обязательным", "format": "int32", "nullable": true } } }, "BaseDealItemView": { "type": "object", "additionalProperties": false, "properties": { "Auction": { "description": "Параметры аукциона", "$ref": "#/components/schemas/BaseAuctionView" } } }, "LoadBoardView": { "allOf": [ { "$ref": "#/components/schemas/BaseLoadBoardView" }, { "type": "object", "additionalProperties": false, "properties": { "IsPublished": { "type": "boolean", "description": "Показывает, что груз уже опубликован на странице" }, "IsCommonBoard": { "type": "boolean", "description": "Показывает является ли площадка Общей" } } } ] }, "BaseLoadBoardView": { "type": "object", "additionalProperties": false, "properties": { "BoardId": { "type": "string", "description": "ID площадки\t" }, "PublicationTime": { "type": "string", "description": "Время публикации на площадке\\\nУчитывается, если `PublicationOption` равно `6`", "format": "date-time", "nullable": true }, "IsReservationEnabled": { "type": "boolean", "description": "Показывает разрешено ли бронирование грузов на Общей площадке\\\nУчитывается только для Общей площадки, только при включенном Stealth" }, "PublicationOption": { "type": "integer", "description": "Параметры публикации груза:\n \n* `0` - сразу\n* `1` - через 15 минут\n* `2` - через 30 минут\n* `3` - через час\n* `4` - через 3 часа\n* `5` - через 6 часов\n* `6` - указать точное время", "format": "int32" } } }, "BaseLoadView": { "type": "object", "additionalProperties": false, "required": [ "ContactId1", "Loading", "Unloading", "Cargo", "Transport", "Payment" ], "properties": { "LoadMeta": { "description": "Метаданные для интеграторов", "$ref": "#/components/schemas/LoadMetaView" }, "ContactId1": { "type": "integer", "description": "Идентификатор первого выбранного контакта.\\\nСписок всех контактов и их идентификаторы можно получить с помощью [API для работы с фирмами](https://ati.su/developers/api/firms/)\\\nКонтакт должен быть виден для остальных участников АТИ", "format": "int32" }, "ContactId2": { "type": "integer", "description": "Идентификатор второго выбранного контакта, если не выбрано, то null\\\nКонтакт должен быть виден для остальных участников АТИ", "format": "int32", "nullable": true }, "Note": { "type": "string", "description": "Примечание к грузу\\\nОграничение по длине: 1000 символов\t", "default": "" }, "FirstDate": { "type": "string", "description": "Дата, начиная с которой груз актуален, в формате UTC\\\nМинимальное значение равно текущей дате\\\nПри значении параметра DateType равным 0, допустимое значение поля - текущая дата\\\nПри значении параметра DateType равным 1, допустимое значение поля - от текущей даты до 60 дней вперед\\\nПри значении параметра DateType равным 2, допустимое значение поля - текущая дата\\\nПри значении параметра DateType равным 3, FirstDate должен принимать значение текущей даты или отсутствовать", "format": "date-time" }, "LastDate": { "type": "string", "description": "Дата, после которой груз не актуален, в формате UTC\\\nМинимальное значение равно значению параметра FirstDate\\\nПри значении параметра DateType равным 0, допустимое значение поля - от текущей даты до 1 дня вперед\\\nПри значении параметра DateType равным 1, допустимое значение поля - от даты в параметре FirstDate до 9 дней вперед\\\nПри значении параметра DateType равным 2, данное поле вычисляется автоматически по формуле FirstDate + 2 месяца, передаваемое значение игнорируется\\\nПри значении параметра DateType равным 3, LastDate автоматически устанавливается на значение + 2 дня от текущей даты, передаваемое значение игнорируется", "format": "date-time" }, "DateType": { "type": "integer", "description": "Выбор типа готовности груза к перевозке\n\n* `0` - Готов к загрузке\n* `1` - с Х по У\n* `2` - постоянно\n* `3` - груза нет, запрос ставки", "format": "int32" }, "PeriodicityId": { "type": "integer", "description": "Периодичность загрузки\\\nЕсли параметр DateType не равен 2, PeriodicityId равен 0.\\\nИначе PeriodicityId может принимать следующие значения:\n \n* `1` - ежедневно\n* `100` - по рабочим дням", "format": "int32" }, "OrderNumber": { "type": "string", "description": "Номер заказа\\\nОграничение по длине: 250 символов", "default": "" }, "Krugoreis": { "type": "boolean", "description": "Параметр, который определяет, включен ли кругорейс для перевозки груза" }, "Loading": { "description": "Загрузка", "$ref": "#/components/schemas/LoadPointView" }, "ExtraPoints": { "type": "array", "description": "Список дополнительных пунктов маршрута\\\nМаксимальное количество - 15 штук", "items": { "$ref": "#/components/schemas/LoadExtraPointView" } }, "Unloading": { "description": "Разгрузка", "$ref": "#/components/schemas/LoadPointView" }, "Cargo": { "description": "Информация о грузе", "$ref": "#/components/schemas/LoadCargoView" }, "Transport": { "description": "Параметры транспорта", "$ref": "#/components/schemas/LoadTransportView" }, "Payment": { "description": "Оплата", "$ref": "#/components/schemas/LoadPaymentView" }, "InviteSettings": { "description": "Настройки автоприглашений", "$ref": "#/components/schemas/LoadInviteSettingsView" }, "PriorityView": { "description": "Приоритетный показ", "$ref": "#/components/schemas/BaseLoadPriorityViewView" }, "Stealth": { "description": "Настройки показа груза", "$ref": "#/components/schemas/LoadStealthView" }, "LoadFiles": { "type": "array", "description": "Файлы к грузу\\\nПеред добавлением груза с файлом, файл предварительно необходимо загрузить в АТИ-Доки (см. [API для хранения файлов](https://ati.su/developers/api/filestorage/))", "items": { "$ref": "#/components/schemas/LoadFileView" } }, "Deal": { "$ref": "#/components/schemas/BaseDealItemView" }, "Boards": { "type": "array", "description": "Список площадок", "items": { "$ref": "#/components/schemas/BaseLoadBoardView" } }, "UnloadFirstDate": { "type": "string", "description": "Дата начала разгрузки, в формате UTC.\\\nМожет иметь значение `null`.\\\nМинимальное значение равно текущей дате.\\\nПри значении параметра DateType равным `3`, UnloadFirstDate принимает значение `null`", "format": "date-time", "nullable": true }, "UnloadLastDate": { "type": "string", "description": "Дата окончания разгрузки, в формате UTC.\nМожет иметь значение `null`.\\\nЕсли нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate.\\\nПри значении параметра DateType равным `3`, UnloadFirstDate принимает значение `null`", "format": "date-time", "nullable": true } } }, "LoadMetaView": { "type": "object", "additionalProperties": false, "properties": { "LoadMetaId": { "type": "string", "description": "Идентификатор метаданных", "format": "guid", "nullable": true }, "MetaData": { "type": "string", "description": "Метаданные\\\nМаксимальная длина 1024 символа" } } }, "LoadPointView": { "type": "object", "additionalProperties": false, "required": [ "CityId" ], "properties": { "CityId": { "type": "integer", "description": "Идентификатор города загрузки/разгрузки\\\nЗначение из [словаря городов АТИ](https://ati.su/developers/api/dictionaries/geo/) ", "format": "int32" }, "Latitude": { "type": "number", "description": "Широта города загрузки/разгрузки\\\nПараметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:\n \n1. указан город Москва;\n2. указан город Санкт-Петербург;\n3. города загрузки и разгрузки совпадают.\n\nЕсли параметр Longitude задан, то необходимо указать и этот параметр.\\\nДопустимое значение от -90 до 90.", "format": "decimal", "nullable": true }, "Longitude": { "type": "number", "description": "Долгота города загрузки/разгрузки\\\nПараметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:\n \n1. указан город Москва;\n2. указан город Санкт-Петербург;\n3. города загрузки и разгрузки совпадают.\n\nЕсли параметр Latitude задан, то необходимо указать и этот параметр.\\\nДопустимое значение от -90 до 90.", "format": "decimal", "nullable": true }, "Street": { "type": "string", "description": "Улица или район города загрузки/разгрузки\\\nПараметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longtittude и Lattitude равны null) и выполняется хотя бы одно из трех условий:\n \n1. указан город Москва;\n2. указан город Санкт-Петербург;\n3. города загрузки и разгрузки совпадают.\n\nМаксимальная длина 100 символов.", "default": "" }, "TimeStart": { "type": "string", "description": "Время начала загрузки/разгрузки\\\nНе указывается при значении параметра DateType равным 3.\\\nНе указывается при значении IsRoundTheClock: true", "format": "date-time", "nullable": true }, "TimeEnd": { "type": "string", "description": "Время завершения загрузки/разгрузки\\\nНе указывается при значении параметра DateType равным 3.\\\nНе указывается при значении IsRoundTheClock: true", "format": "date-time", "nullable": true }, "IsRoundTheClock": { "type": "boolean", "description": "Определяет выбрано ли значение Круглосуточно\\\nПо умолчанию - false\\\nНе указывается при значении параметра DateType равным 3." }, "LargeCities": { "type": "array", "description": "Массив идентификаторов ближайших крупных городов\\\nЗначение из [словаря городов АТИ](https://ati.su/developers/api/dictionaries/geo/)\\\nМаксимальное количество - 10 штук", "items": { "type": "integer", "format": "int32" } }, "LoadingCargos": { "type": "array", "items": { "$ref": "#/components/schemas/LoadingCargoView" } } } }, "LoadingCargoView": { "type": "object", "additionalProperties": false, "properties": { "CargoId": { "type": "integer", "description": "Id груза", "format": "int32" }, "NameId": { "type": "integer", "description": "Наименование груза", "format": "int32" }, "Name": { "type": "string" }, "PackagingType": { "type": "integer", "description": "Упаковка", "format": "int32", "nullable": true }, "PackagingQuantity": { "type": "integer", "format": "int32", "nullable": true }, "Weight": { "type": "number", "format": "double", "nullable": true }, "Volume": { "type": "number", "description": "Объем", "format": "double", "nullable": true }, "Sizes": { "description": "Габариты", "$ref": "#/components/schemas/LoadSize" } } }, "LoadExtraPointView": { "type": "object", "additionalProperties": false, "required": [ "CityId", "PointType" ], "properties": { "CityId": { "type": "integer", "description": "Идентификатор города\\\nЗначение из [словаря городов АТИ](https://ati.su/developers/api/dictionaries/geo/) ", "format": "int32" }, "PointType": { "type": "integer", "description": "Тип точки:\n\n* `1` - загрузка\n* `2` - разгрузка\n* `3` - таможня\n* `8` - проехать через", "format": "int32" }, "Latitude": { "type": "number", "description": "Долгота", "format": "decimal", "nullable": true }, "Longitude": { "type": "number", "description": "Широта", "format": "decimal", "nullable": true }, "Street": { "type": "string", "description": "Улица или район" }, "OrdinalId": { "type": "integer", "description": "Порядковый номер", "format": "int32" }, "IsRoundTheClock": { "type": "boolean", "description": "Загрузка/разгрузка круглосуточно" }, "LoadingDateStart": { "type": "string", "description": "Дата начала периода загрузки/разгрузки", "format": "date-time", "nullable": true }, "LoadingDateEnd": { "type": "string", "description": "Дата окончания периода загрузки/разгрузки", "format": "date-time", "nullable": true }, "LoadingTimeStart": { "type": "string", "description": "Время начала загрузки/разгрузки", "format": "time-span", "nullable": true }, "LoadingTimeEnd": { "type": "string", "description": "Время окончания загрузки/разгрузки", "format": "time-span", "nullable": true }, "LoadingCargos": { "type": "array", "items": { "$ref": "#/components/schemas/LoadingCargoView" } }, "UnloadingCargos": { "type": "array", "items": { "$ref": "#/components/schemas/UnloadingCargoView" } } } }, "UnloadingCargoView": { "type": "object", "additionalProperties": false, "properties": { "CargoId": { "type": "integer", "description": "Id груза", "format": "int32" }, "Weight": { "type": "number", "description": "Вес", "format": "double", "nullable": true }, "Volume": { "type": "number", "description": "Объём", "format": "double", "nullable": true }, "PackagingQuantity": { "type": "integer", "description": "Выгружаемая часть упаковки", "format": "int32", "nullable": true }, "IsDefinedByTtn": { "type": "boolean", "description": "Выгружаемая часть груза будет определена в ТТН" } } }, "LoadCargoView": { "type": "object", "additionalProperties": false, "required": [ "CargoTypeId", "DogruzType" ], "properties": { "Weight": { "type": "number", "description": "Вес груза в тоннах\\\nОбязательный параметр, если не задан параметр Volume.", "format": "double" }, "Volume": { "type": "number", "description": "Объем груза в кубических метрах\\\nОбязательный параметр, если не задан параметр Weight. Максимальная длина - 4 символа\t", "format": "double" }, "ADR": { "type": "integer", "description": "Параметр, определяющий степень опасности груза\\\nДопустимое значение от 0 до 9. По умолчанию - 0\t", "format": "int32" }, "CargoTypeId": { "type": "integer", "description": "Идентификатор наименования груза\\\nЗначение из [Словаря наименований грузов](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-cargoTypes)", "format": "int32" }, "CargoType": { "type": "string", "description": "Строковое наименование груза.\\\nОбязательный параметр, если значение параметра CargoTypeId равно `59`.\\\nМаксимальная длина названия - 50 символов.\\\nЭтот параметр должен быть пустым, если параметр `CargoTypeId` отличен от `59`.\\\nВ этом поле запрещено указывать контактную информацию", "default": "" }, "PackType": { "type": "integer", "description": "Идентификатор наименования упаковки (навалом, коробки, россыпью...)\\\nЗначение из [Словаря наименований грузов](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-packTypes)", "format": "int32" }, "PalletCount": { "type": "integer", "description": "Количество упаковок для груза\\\nДопустимое значение от 0 до 9999. По умолчанию - 0\t", "format": "int32" }, "BeltCount": { "type": "integer", "description": "Количество ремней для груза\\\nДопустимое значение от 0 до 9999. По умолчанию - 0", "format": "int32" }, "DogruzType": { "type": "integer", "description": "Вариант перевозки:\n\n* `1` - только отдельной машиной\n* `2` - отдельной или догрузом", "format": "int32" }, "SborGruz": { "type": "boolean", "description": "Определяет, является ли груз сборным" }, "Size": { "description": "Параметры размера груза", "$ref": "#/components/schemas/LoadSizeView" } } }, "LoadSizeView": { "type": "object", "additionalProperties": false, "properties": { "Length": { "type": "number", "description": "Длина груза в метрах\\\nДопустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0", "format": "double" }, "Width": { "type": "number", "description": "Ширина груза в метрах\\\nДопустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0", "format": "double" }, "Height": { "type": "number", "description": "Высота груза в метрах\\\nДопустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0", "format": "double" }, "Diameter": { "type": "number", "description": "Диаметр груза в метрах\\\nДопустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0", "format": "double" }, "LengthHighlight": { "type": "boolean", "description": "Выделение красным цветом длины груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)" }, "WidthHighlight": { "type": "boolean", "description": "Выделение красным цветом ширины груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)" }, "HeightHighlight": { "type": "boolean", "description": "Выделение красным цветом высоты груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)" } } }, "LoadTransportView": { "type": "object", "additionalProperties": false, "required": [ "CarType" ], "properties": { "CarType": { "type": "integer", "description": "Битовая сумма ID кузовов\\\nЗначение из [словаря кузовов АТИ](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-carTypes)", "format": "int64" }, "LoadingType": { "type": "integer", "description": "Битовая сумма ID типов загрузки\\\nЗначение из [словаря вариантов загрузки АТИ](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-loadingTypes)", "format": "int32" }, "LoadingLogicalOperator": { "type": "string", "description": "Тип условия загрузки:\n\n* `OR` - необходимо, чтобы присутствовал один из способов загрузки\n* `AND` - необходимо, чтобы присутствовали все выбранные типы загрузки", "default": "OR" }, "UnloadingType": { "type": "integer", "description": "Битовая сумма ID типов разгрузки.\\\nЗначение из [словаря вариантов разагрузки АТИ](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-loadingTypes)", "format": "int32" }, "UnloadingLogicalOperator": { "type": "string", "description": "Тип условия разгрузки:\n\n* `OR` - необходимо, чтобы присутствовал один из способов разгрузки\n* `AND` - необходимо, чтобы присутствовали все выбранные типы разгрузки", "default": "OR" }, "TrucksQuantity": { "type": "integer", "description": "Количество машин\\\nДопустимое значение от 1 до 99. По умолчанию - 1", "format": "int32" }, "TemperatureFrom": { "type": "integer", "description": "Минимальная температура для груза, если выбран тип кузова \"Рефрижератор\", \"Рефрижератор с перегородкой\", \"Рефрижератор-мультирежимный\"\\\nДопустимое значение от -99 до 999\t", "format": "int32", "nullable": true }, "TemperatureTo": { "type": "integer", "description": "Максимальная температура для груза, если выбран тип кузова \"Рефрижератор\", \"Рефрижератор с перегородкой\", \"Рефрижератор-мультирежимный\"\\\nДопустимое значение от -99 до 999\t", "format": "int32", "nullable": true }, "Stsepka": { "type": "boolean", "description": "Определяет, нужна ли сцепка для груза" }, "Pnevmohod": { "type": "boolean", "description": "Определяет, нужен ли пневмоход для груза" }, "Koniki": { "type": "boolean", "description": "Определяет, нужны ли коники для груза" }, "TIR": { "type": "boolean", "description": "Документы на транспорт, необходимые для провоза этого груза: документы TIR" }, "CMR": { "type": "boolean", "description": "Документы на транспорт, необходимые для провоза этого груза: документы CMR" }, "T1": { "type": "boolean", "description": "Документы на транспорт, необходимые для провоза этого груза: документы T1" }, "SanPassport": { "type": "boolean", "description": "Документы на транспорт, необходимые для провоза этого груза: медкнижка" }, "IsTracking": { "type": "boolean", "description": "Трекинг через АТИ Водитель" } } }, "LoadPaymentView": { "type": "object", "additionalProperties": false, "properties": { "CurrencyId": { "type": "integer", "description": "Идентификатор валюты\\\nПо умолчанию - 1. Должен принимать значение 0, если параметр FixedRate равен false\\\nЗначение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/cargoes/)", "format": "int32" }, "MoneyType": { "type": "integer", "description": "Идентификатор варианта оплаты\\\nПо умолчанию - `22`. Должен принимать значение `22`, если параметр `FixedRate` равен `false`\\\nЗначение из [словаря вариантов оплаты АТИ](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-moneyTypes)", "format": "int32" }, "RateSum": { "type": "number", "description": "Ставка для груза\\\nОбязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или SumWithoutNDS. Максимальная длина 6 символов. Если ввести более двух цифр после запятой, будет произведено округление. Если параметр MoneyType равен 22 и RateSum > 0, тогда поля SumWithNDS и SumWithoutNDS должны быть пустыми или принимать значение 0\t", "format": "decimal" }, "SumWithNDS": { "type": "number", "description": "Ставка б/нал с НДС\\\nОбязательный параметр, если параметр FixedRate равен true и не заданы параметры RateSum или SumWithoutNDS. Максимальная длина 6 символов. Если ввести более двух цифр после запятой, будет произведено округление. Если параметр FixedRate равен false, то параметр SumWithNDS должен отсутствовать или быть равным 0\t", "format": "decimal" }, "SumWithoutNDS": { "type": "number", "description": "Ставка б/нал без НДС\\\nОбязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или RateSum. Максимальная длина 6 символов. Если ввести более двух цифр после запятой, будет произведено округление. Если параметр FixedRate равен false, то параметр SumWithoutNDS должен отсутствовать или быть равным 0\t", "format": "decimal" }, "PrepayPercent": { "type": "integer", "description": "Процент предоплаты\\\nДопустимое значение от 0 до 100. Должен отсутствовать или принимать значение 0, если параметр PrepayPercentEnabled равен false\t", "format": "int32" }, "PrepayPercentEnabled": { "type": "boolean", "description": "Есть ли предоплата" }, "PayDays": { "type": "integer", "description": "Через сколько банковских дней оплата\\\nДопустимое значение от 0 до 99. Должен отсутствовать или принимать значение 0, если параметр PayDaysEnabled равен false\t", "format": "int32" }, "PayDaysEnabled": { "type": "boolean", "description": "Параметр, что включен флажок \"через банк. дней\"\\\nПо умолчанию - false. Не может быть установлен в true, если параметр OnUnloading тоже установлен в true" }, "FixedRate": { "type": "boolean", "description": "true, если ставка задана, false если запрос ставки\\\nПо умолчанию - true. При значении параметра DateType равным 3, должен иметь значение false. Если указано значение True, значение хотя бы одного из полей RateSum, SumWithNDS, SumWithoutNDS должно быть больше или равно 1\t" }, "Torg": { "type": "boolean", "description": "Возможен ли торг\\\nПо умолчанию - false. Не учитывается, если параметр FixedRate равен false\t" }, "DirectContract": { "type": "boolean", "description": "Прямой договор" }, "InFuel": { "type": "boolean", "description": "Предоплата топливом" }, "OnUnloading": { "type": "boolean", "description": "Оплата на выгрузке" }, "HideResponses": { "type": "boolean", "description": "Скрыть встречные предложения" }, "AcceptPaymentTypes": { "type": "integer", "description": "Позволяет указать форму оплаты при выборе параметра \"Запрос ставки\":\n \n* `1` - наличные\n* `2` - б/нал с НДС\n* `3` - нал и б/нал с НДС\n* `4` - б/нал без НДС\n* `5` - нал и б/нал без НДС\n* `6` - б/нал с НДС и без НДС\n* `7` - нал и б/нал с НДС и без НДС\n* `0` - указана фикс. ставка", "format": "int32" } } }, "LoadInviteSettingsView": { "type": "object", "additionalProperties": false, "properties": { "InviteDelayInSeconds": { "type": "integer", "description": "Время в секундах сбора встречных предложений,\nпо истечение которого будет создано приглашение\nпо лучшему из них", "format": "int32" }, "InviteDurationInSeconds": { "type": "integer", "description": "Время в секундах действия приглашения", "format": "int32" } } }, "LoadStealthView": { "type": "object", "additionalProperties": false, "properties": { "ListIdToHide": { "type": "string", "description": "Режим стэлс, ID списка для которого данный груз показываться не будет\\\nПолучить ID списка можно с помощью [API списков фирмы](https://ati.su/developers/api/catalogs/firm-lists/)", "format": "guid", "nullable": true }, "FirmRegDateToHide": { "type": "string", "description": "Режим стэлс, Для фирм с датой регистрации меньше данной груз показываться не будет", "format": "date-time", "nullable": true }, "ScoreToHide": { "type": "number", "description": "Режим стэлс, минимальное количество баллов фирмы. Для фирм с меньшим количество баллов груз показываться не будет", "format": "double", "nullable": true } } }, "LoadFileView": { "type": "object", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Идентификатор файла, возвращается при загрузке файла в АТИ-Доки", "format": "guid" }, "FileType": { "type": "integer", "description": "Тип загруженного файла:\n\n* `1` - документ", "format": "int32" }, "Attributes": { "type": "integer", "description": "Битовый набор опции файла\n \n* `0` - Значение по умолчанию. Данный файл доступен по ссылке\n* `1` - Данный файл доступен только владельцу груза", "format": "int32" }, "Name": { "type": "string", "description": "Имя файла\\\nДля имени файла разрешено использовать следующие символы: цифры, заглавные и строчные буквы латинского и кириллического алфавита, дефис, точка, пробел.\nДлинна: до 100 символов. Имя файла присваивается при загрузке в АТИ-Доки" }, "Link": { "type": "string", "description": "Ссылка, по которой можно скачать файл, возвращается при загрузке файла в АТИ-Доки" }, "Size": { "type": "integer", "description": "Размер файла\\\nИнформационное поле, на текущий момент не используется", "format": "int32" } } }, "NewLoadResponseViewStandart": { "type": "object", "additionalProperties": false, "properties": { "ResponseId": { "type": "string", "description": "Id отзыва", "format": "guid" }, "LoadId": { "type": "string", "description": "Id груза, на который оставлен отзыв", "format": "guid" }, "LoadNumber": { "type": "string", "description": "Номер груза" }, "LoadFirmId": { "type": "integer", "description": "Id фирмы, которой принадлежит груз", "format": "int32" }, "FirmId": { "type": "integer", "description": "Id фирмы, которая оставила отзыв", "format": "int32" }, "FirmName": { "type": "string", "description": "Название фирмы" }, "ContactId": { "type": "integer", "description": "Контакт, который сделал встречное предложение", "format": "int32" }, "AddedAt": { "type": "string", "description": "Дата добавления отзыва", "format": "date-time" }, "UpdatedAt": { "type": "string", "description": "Дата изменения отзыва", "format": "date-time" }, "Price": { "type": "number", "description": "Предложенная цена встречного предложения", "format": "decimal" }, "CurrencyId": { "type": "integer", "description": "Валюта встречного предложения\\\nЗначение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/cargoes/)", "format": "int32" }, "NdsPrice": { "type": "number", "description": "Предложенная цена встречного предложения с ндс", "format": "decimal" }, "NdsCurrencyId": { "type": "integer", "description": "Валюта ставки встречного предложения б/нал с НДС.Параметр должен быть равен валюте, указанной в грузе, если параметр FixedRate равен True и параметр Torg равен False.\\\nЗначение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/cargoes/)", "format": "int32" }, "NotNdsPrice": { "type": "number", "description": "Предложенная цена встречного предложения без ндс", "format": "decimal" }, "NotNdsCurrencyId": { "type": "integer", "description": "Валюта встречного предложения без ндс", "format": "int32" }, "CounterOfferSource": { "description": "Обозначение откуда было добавлено встречное предложение\n\n* `0` - Неизвестный источник\n* `1` - Мобильное приложение\n* `2` - Интегратор\n* `3` - Перехват грузов интегратором\n* `4` - Страница поиска грузов\n* `5` - Перехват машин\n* `6` - Сквозное встречное предложение, добавлено автоматически", "$ref": "#/components/schemas/CounterOfferSource" }, "Note": { "type": "string", "description": "Примечание к встречному предложению\\\nМаксимальная длина - 512 символов" }, "PayAttributes": { "type": "integer", "description": "Атрибуты оплаты, по умолчанию - 0.\nБитовая сумма следующих параметров:\n\n* `1` - возможна оплата наличными\n* `2` - возможна оплата по безналичному рассчету\n* `4` - блиц\n* `8` - оплата с НДС\n* `16` - возможна предоплата\n* `32` - оплата на выгрузке\n* `64` - включена ли оплата через некоторое количество банковских дней", "format": "int32" }, "PrepayPercent": { "type": "integer", "description": "Процент предоплаты\\\nДолжен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100", "format": "int32" }, "PayAfterMaxBankDays": { "type": "integer", "description": "Оплата через ... банковских дней\\\nДолжен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 64 - включена оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99", "format": "int32" }, "LoadingDate": { "type": "string", "description": "Дата, когда предложивший хочет перевезти ваш груз", "format": "date-time", "nullable": true }, "IsOutdated": { "type": "boolean", "description": "Определяет, просрочен ли отзыв. Когда груз редактируют, удаляют, обновляют, отзыв помечается просроченным.\\\nТолько для чтения." }, "IsLoadPublished": { "type": "boolean", "description": "Относится ли отзыв к публикующемуся грузу" }, "IsNoLoad": { "type": "boolean", "description": "Параметр \"Груза нет\"" }, "AnnouncedCurrencyId": { "type": "integer", "description": "Валюта \"Озвученной ставки\"\\\nЗначение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/cargoes/)", "format": "int32" }, "AnnouncedRate": { "type": "integer", "description": "Озвученная ставка", "format": "int32" }, "FirmInfo": { "description": "Информация о фирме, оставившей отзыв на груз\t", "$ref": "#/components/schemas/LoadResponseFirminfo" } } }, "LoadResponseFirminfo": { "type": "object", "additionalProperties": false, "properties": { "TotalScore": { "type": "number", "description": "Сумма очков фирмы (количество звезд)", "format": "double" }, "Status": { "$ref": "#/components/schemas/FirmStatus" }, "FullFirmName": { "type": "string", "description": "Полное название фирмы" }, "Contact": { "description": "Информация о контакте фирмы, оставившем отзыв на груз", "$ref": "#/components/schemas/LoadResponseContactInfo" }, "Inn": { "type": "string", "description": "ИНН" } } }, "LoadResponseContactInfo": { "type": "object", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Id контакта в фирме", "format": "int32" }, "Name": { "type": "string", "description": "Имя контакта" }, "Telephone": { "type": "string", "description": "Телефон" }, "Email": { "type": "string", "description": "Электронная почта" }, "Icq": { "type": "string", "description": "Аккаунт ICQ" }, "Mobile": { "type": "string", "description": "Телефон(мобильный)" }, "MobileOperator": { "type": "string", "description": "Мобильный оператор" }, "SkypeName": { "type": "string", "description": "Аккаунт Skype" }, "CityId": { "type": "integer", "description": "Id города\\\nЗначение из [словаря городов АТИ](https://ati.su/developers/api/dictionaries/geo/) ", "format": "int32", "nullable": true }, "Location": { "description": "Информация о местоположении фирмы", "$ref": "#/components/schemas/FirmServiceCity" } } }, "FirmServiceCity": { "type": "object", "additionalProperties": false, "properties": { "CityId": { "type": "integer", "description": "Id города\\\nЗначение из [словаря городов АТИ](https://ati.su/developers/api/dictionaries/geo/) ", "format": "int32" }, "RegionId": { "type": "integer", "description": "Id региона\\\nЗначение из [словаря регионов АТИ](https://ati.su/developers/api/dictionaries/geo/) ", "format": "int32", "nullable": true }, "CountryId": { "type": "integer", "description": "Id страны\\\nЗначение из [словаря стран АТИ](https://ati.su/developers/api/dictionaries/geo/) ", "format": "int32", "nullable": true }, "FullName": { "type": "string", "description": "Составное название состоящее из названий города, региона и страны разделенные через запятую" }, "ShortName": { "type": "string", "description": "Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)" }, "IsRegionalCenter": { "type": "boolean", "description": "Является ли город региональным центром" }, "CitySize": { "type": "integer", "description": "Размер города по числу жителей\n \n* `1`: до 10.000\n* `2`: от 10.000 до 50.000;\n* `3`: от 50.000 до 100.000;\n* `4`: от 100.000 до 500.000;\n* `5`: от 500.000 до 1.000.000; \n* `6`: свыше 1.000.000.", "format": "int32" }, "FiasId": { "type": "string", "description": "Id в базе ФИАС", "format": "guid", "nullable": true }, "CityName": { "type": "string", "description": "Название города" }, "RegionName": { "type": "string", "description": "Название региона" }, "CountryName": { "type": "string", "description": "Название страны" }, "CountryCodeName": { "type": "string", "description": "Буквенный код страны" } } }, "DateType": { "type": "integer", "description": "Готовность груза к перевозке\n \n* `0` — Готов к отправке сегодня или завтра\n* `1` — Готов к отправке между FirstDate и LastDate\n* `2` — Готов к отправке постоянно\n* `3` — Груза нет, запрос ставки", "x-enumNames": [ "ReadyToLoading", "BetweenTwoDates", "AlwaysReady", "MissingLoad" ], "enum": [ 0, 1, 2, 3 ] }, "Periodicity": { "type": "integer", "description": "Периодичность загрузки\n \n* `0` — Нет\n* `1` — Ежедневно\n* `100` — Только по рабочим дням", "x-enumNames": [ "None", "EveryDay", "OnlyWorkingDays" ], "enum": [ 0, 1, 100 ] }, "Organization": { "type": "object", "additionalProperties": false, "properties": { "organization_id": { "type": "string", "format": "guid" }, "firm_id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "ownership": { "type": "integer", "format": "int32" }, "residency": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Residency" } ] }, "inn": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "extra_phone": { "type": "integer", "format": "int32", "nullable": true }, "docs_address": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganizationDocsAddress" } ] }, "stocks": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/Stock" } }, "contact_persons": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/ContactPerson" } }, "ownership_name": { "type": "string", "nullable": true } } }, "Residency": { "type": "integer", "description": "Резидентство\n \n* `1` — Россия\n* `2` — Украина\n* `3` — Беларусь\n* `10` — Казахстан\n* `200` — Международное (другое)", "x-enumNames": [ "Russia", "Ukraine", "Belarus", "Kazakhstan", "International" ], "enum": [ 1, 2, 3, 10, 200 ] }, "OrganizationDocsAddress": { "type": "object", "additionalProperties": false, "properties": { "postcode": { "type": "string", "nullable": true }, "city_id": { "type": "integer", "format": "int32", "nullable": true }, "street_name": { "type": "string", "nullable": true }, "house_no": { "type": "string", "nullable": true }, "office_no": { "type": "string", "nullable": true } } }, "Stock": { "type": "object", "additionalProperties": false, "properties": { "stock_id": { "type": "string", "format": "guid" }, "address": { "type": "string", "nullable": true }, "address_city_id": { "type": "integer", "format": "int32" }, "address_latitude": { "type": "number", "format": "double" }, "address_longitude": { "type": "number", "format": "double" }, "note": { "type": "string", "nullable": true }, "work_schedules": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/StockSchedule" } }, "breaks_schedules": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/StockSchedule" } }, "contact_persons": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/ContactPerson" } }, "schedule_summary": { "type": "string", "nullable": true }, "stock_type": { "$ref": "#/components/schemas/StockType" }, "timeslots_binding": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimeslotsBinding" } ] } } }, "StockSchedule": { "type": "object", "additionalProperties": false, "properties": { "stock_schedule_id": { "type": "string", "format": "guid" }, "day_of_week": { "$ref": "#/components/schemas/DayOfWeek" }, "start_time": { "type": "string", "format": "duration" }, "end_time": { "type": "string", "format": "duration" } } }, "DayOfWeek": { "type": "integer", "description": "", "x-enumNames": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "enum": [ 0, 1, 2, 3, 4, 5, 6 ] }, "ContactPerson": { "type": "object", "additionalProperties": false, "properties": { "contact_person_id": { "type": "string", "format": "guid" }, "name": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } } }, "StockType": { "type": "integer", "description": "", "x-enumNames": [ "Stock", "Office", "Store" ], "enum": [ 1, 2, 3 ] }, "TimeslotsBinding": { "type": "object", "additionalProperties": false, "properties": { "warehouse_id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/TimeslotsBindingStatus" } } }, "TimeslotsBindingStatus": { "type": "integer", "description": "", "x-enumNames": [ "AwaitReaction", "Accepted", "Revoked", "Rejected" ], "enum": [ 0, 1, 2, 3 ] }, "LoadExtraPointType": { "type": "integer", "description": "Тип дополнительной точки маршрута груза\n \n* `1` — Загрузка\n* `2` — Разгрузка\n* `3` — Таможня\n* `4` — Ближайший крупный город к городу загрузки\n* `5` — Ближайший крупный город к городу разгрузки\n* `8` — Проехать через", "x-enumNames": [ "LoadingExtraPoint", "UnloadingExtraPoint", "CustomExtraPoint", "LoadingLargeCity", "UnloadingLargeCity", "DriverThrough" ], "enum": [ 1, 2, 3, 4, 5, 8 ] }, "RateType": { "type": "integer", "description": "Тип оплаты\n \n* `0` — Нет\n* `1` — Любая\n* `2` — С НДС\n* `3` — Без НДС", "x-enumNames": [ "None", "Common", "Nds", "WithoutNds" ], "enum": [ 0, 1, 2, 3 ] }, "DealDocumentAccess": { "type": "integer", "description": "Доступ к документу\n \n* `0` — Обе стороны\n* `1` — Водитель", "x-enumFlags": true, "x-enumNames": [ "SharedWithCounterparty", "SharedWithAtiTrucker" ], "enum": [ 0, 1 ] }, "InWorkStatusModel": { "type": "integer", "description": "Статусная модель перевозки\n \n* `0` — Простая перевозка\n* `1` — Первая миля\n* `2` — Последняя миля\n* `3` — Порожний контейнер", "x-enumNames": [ "Default", "FirstMile", "LastMile", "EmptyContainer" ], "enum": [ 0, 1, 2, 3 ] }, "DealFileAccess": { "type": "integer", "description": "Доступ к файлу\n \n* `0` — только загрузивший файл\n* `1` — обе стороны\n* `2` — загрузивший файл и водитель\n* `3` — доступен обеим сторонам и водителю", "x-enumFlags": true, "x-enumNames": [ "OnlyYou", "SharedWithCounterparty", "SharedWithAtiTrucker", "SharedWithAtiTruckerAndCounterparty" ], "enum": [ 0, 1, 2, 3 ] }, "DealFileSourceTypes": { "type": "integer", "description": "Источник файла\n \n* `0` — Загружен в заказ\n* `1` — Скопирован из груза\n* `2` — Скопирован из данных о водителе\n* `3` — Скопироване из данных о грузовике\n* `4` — Скопирован из данных о прицепе\n* `5` — Скопирован из данных о полуприцепе\n* `6` — Скопирован из данных о тягаче\n* `7` — Загружен для Ати-водителя\n* `8` — Загружен из приложения АТИ-водитель\n* `9` — Загружен из Gallifrey (Временные окна)", "x-enumNames": [ "SimpleLoader", "Load", "Driver", "Truck", "Trailer", "SemiTrailer", "Tractor", "AtiTruckerPopupLoader", "FromAtiDriver", "FromGallifrey" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ] }, "DealFileSourceFileTypes": { "type": "integer", "description": "Тип загруженного файла\n \n* `0` — Обычный файл\n* `1` — Скан водительского удостоверения\n* `2` — Скан гражданского паспорта водителя\n* `3` — Скан ПТС\n* `4` — Скан пластикового ПТС\n* `5` — Фото ТС\n* `8` - Скан договора о безвоздмездном пользовании", "x-enumNames": [ "None", "DriverLicense", "DriverPassport", "TruckTechPassport", "TruckPlasticTechPassport", "TruckPhoto", "FreeUse" ], "enum": [ 0, 1, 2, 3, 4, 5, 8 ] }, "DealFileType": { "type": "integer", "description": "Тип файла\n \n* `0` — Другой документ\n* `1` — Товарно-транспортная накладная\n* `2` — Товарная накладная\n* `3` — Транспортная накладная\n* `4` — Накладная\n* `5` — Счет-фактура\n* `6` — Счет на оплату\n* `7` — Платежное поручение\n* `8` — Акт выполненных работ\n* `9` — Заявка\n* `10` — Заявка к договору\n* `11` — Заказ\n* `12` — Договор\n* `13` — Доп. соглашение к договору\n* `14` — Доверенность\n* `15` — Поручение экспедитору\n* `16` — Информационное письмо\n* `17` — Документ о происшествии с грузом/ТС", "x-enumNames": [ "OtherDoc", "ConsignmentNote", "PackingList", "WayBill", "WayBillGeneral", "Invoice", "InvoiceForPayment", "PaymentOrder", "CertificateOfCompletion", "Request", "RequestForOrder", "Order", "Contract", "SupplementaryAgreement", "Dealership", "Assignment", "InfoLetter", "AccidentAct" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17 ] }, "DealPointTypes": { "type": "integer", "description": "Тип точки маршрута\n \n* `1` — Загрузка\n* `2` — Разгрузка\n* `3` — Таможня\n* `8` — Ехать через", "x-enumNames": [ "Loading", "Unloading", "Customs", "GoThrough" ], "enum": [ 1, 2, 3, 8 ] }, "InWorkStatus": { "type": "integer", "description": "Статус перевозки\n \n* `0` — Нет статуса\n* `1` — Едет на загрузку\n* `2` — Ожидает загрузку\n* `3` — Загружается\n* `4` — Загрузился, едет на выгрузку\n* `5` — Ожидает выгрузку\n* `6` — Выгружается\n* `7` — Выгрузился\n* `8` — Поломка\n* `9` — ДТП\n* `10` — Арест ТС\n* `11` — Контейнер получен на погрузку\n* `12` — Контейнер на погрузке\n* `13` — Погрузка контейнера окончена\n* `14` — Контейнер сдан с погрузки\n* `15` — Контейнер получен на выгрузку\n* `16` — Контейнер на выгрузке\n* `17` — Выгрузка контейнера окончена\n* `18` — Контейнер сдан с выгрузки\n* `19` — Пустой контейнер получен\n* `20` — Пустой контейнер сдан\n* `100` — Заказ завершён", "x-enumNames": [ "None", "GoToLoading", "ReadyToLoad", "Loading", "Loaded", "ReadyToUnload", "Unloading", "Unloaded", "Breakdown", "Accident", "Arrested", "ContainerReceivedToLoading", "ContainerOnLoading", "ContainerFinishedLoading", "ContainerSentFromLoading", "ContainerReceivedToUnloading", "ContainerOnUnloading", "ContainerFinishedUnloading", "ContainerSentFromUnloading", "EmptyContainerReceived", "EmptyContainerSent", "CompletedByDriver" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 100 ] }, "OrderRole": { "type": "integer", "description": "Роль\n\n* `0` — Грузовладелец\n* `1` — Перевозчик", "x-enumNames": [ "CargoOwner", "Carrier" ], "enum": [ 0, 1 ] }, "Scan": { "type": "object", "description": "Скан документа ТС или водителя", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "ID ", "format": "guid" }, "owner_id": { "type": "string", "description": "ID сущности, котрой принадлежит скан", "format": "guid", "nullable": true }, "name": { "type": "string", "description": "Название", "nullable": true }, "file_id": { "type": "string", "description": "ID файла", "nullable": true }, "type": { "description": "Тип документа\n \n* `1` — Скан водительского удостоверения\n* `2` — Скан гражданского паспорта\n* `3` — Скан ПТС\n* `4` — Скан пластикового ПТС\n* `5` — Фото ТС\n* `8` — Договор о безвоздмездном пользовании", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AutoparkDocumentType" } ] } } }, "AutoparkDocumentType": { "type": "integer", "description": "Тип документа сущности каталогов\n \n* `1` — Скан водительского удостоверения\n* `2` — Скан гражданского паспорта\n* `3` — Скан ПТС\n* `4` — Скан пластикового ПТС\n* `6` — Скан договора аренды\n* `5` — Фото ТС\n* `8` — Договор о безвоздмездном пользовании", "x-enumNames": [ "DriverLicense", "Passport", "TechPassport", "PlasticTechPassport", "TruckPhoto", "RentContract", "FreeUse" ], "enum": [ 1, 2, 3, 4, 5, 6, 8 ] }, "DriverOrigin": { "type": "integer", "description": "Идентификатор источника информации о водителе\n \n* `0` — Неизвестно откуда указан водитель\n* `1` — Водитель указан на странице заказов у Заказа в исполнении\n* `2` — Водитель указан в АТИ-Доках", "x-enumNames": [ "Unknown", "OrdersUiFromDealInProgress", "AtiDocs" ], "enum": [ 0, 1, 2 ] }, "TruckType": { "type": "integer", "description": "Тип транспортного средства\n \n* `1` — Грузовик\n* `2` — Тягач\n* `4` — Полуприцеп\n* `8` — Прицеп", "x-enumNames": [ "Truck", "Tractor", "Semitrailer", "Trailer" ], "enum": [ 1, 2, 4, 8 ] }, "TruckOwnershipType": { "type": "integer", "description": "Тип владения ТС\n \n* `0` - Собственное\n* `1` - Привлеченное\n* `2` - Аренда\n* `3` - Лизинг\n* `4` - Совместная собственность (супругов)\n* `5` - Безвозмездное пользование", "x-enumNames": [ "Own", "Attracted", "Rent", "Leasing", "JointOwnershipSpouses", "FreeUse" ], "enum": [ 0, 1, 2, 3, 4, 5 ] }, "TruckOrigin": { "type": "integer", "description": "Источник создания Транспорта\n \n* `0` — Неизвестно откуда указано ТС\n* `1` — ТС указано на странице заказов у Заказа в исполнении\n* `2` — ТС Указано в АТИ-доках", "x-enumNames": [ "Unknown", "OrdersUiFromDealInProgress", "ATIDocs" ], "enum": [ 0, 1, 2 ] }, "DealDocumentTemplateAccess": { "type": "integer", "description": "Доступ к файлу\n \n* `0` — только загрузивший файл\n* `1` — обе стороны", "x-enumFlags": true, "x-enumNames": [ "OnlyYou", "SharedWithCounterparty" ], "enum": [ 0, 1 ] }, "DocumentStatusInfoView": { "type": "object", "additionalProperties": false, "properties": { "checked": { "type": "boolean", "description": "Документ получен" }, "date": { "type": "string", "description": "Дата получения документов", "format": "date-time", "nullable": true } } }, "DocumentTrackingInfoView": { "type": "object", "additionalProperties": false, "properties": { "transport_company_id": { "type": "integer", "description": "Id транспортной компании, осуществляющей доставку документов", "format": "int32" }, "tracking_url": { "type": "string", "description": "Сссылка для отслеживания статуса отправления", "nullable": true }, "tracking_number": { "type": "string", "description": "Номер отправления", "nullable": true }, "sending_date": { "type": "string", "description": "Дата отправки документов", "format": "date-time", "nullable": true } } }, "PaymentStatusView": { "type": "object", "additionalProperties": false, "properties": { "checked": { "type": "boolean", "description": "Заказ оплачен" }, "date": { "type": "string", "description": "Дата оплаты", "format": "date-time", "nullable": true } } }, "CustomerView": { "type": "object", "additionalProperties": false, "properties": { "ati_id": { "type": "string", "description": "ID заказчика в ATI. Если заказчик является внешним контрагентом, то будет равняться ID из справочника \"Контрагенты не из АТИ\"", "nullable": true }, "source": { "description": "Источник информации о заказчике\n\n* `1` - Справочник \"Контрагенты не из АТИ\"\n* `2` - Глобальный поиск\n* `3` - Справочник \"Ваши реквизиты\"", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CustomerSource" } ] }, "name": { "type": "string", "description": "Имя заказчика", "nullable": true }, "ownership_id": { "type": "integer", "description": "ID типа фирмы (ИП/ООО/др.)", "format": "int32", "nullable": true }, "inn": { "type": "string", "description": "ИНН\n ", "nullable": true }, "ogrn": { "type": "string", "description": "ОГРН\n ", "nullable": true }, "requisite": { "description": "Реквизиты", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/RequisiteView2" } ] }, "gen_director": { "description": "Генеральный директор", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/GenDirectorView" } ] }, "contact": { "description": "Контакты\n ", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ContactView2" } ] }, "address": { "type": "array", "description": "Адрес", "nullable": true, "items": { "$ref": "#/components/schemas/AddressView" } }, "claims_count": { "type": "integer", "description": "Количество претензий", "format": "int32", "nullable": true }, "recommendation_count": { "type": "integer", "description": "Количество рекомендаций", "format": "int32", "nullable": true }, "bad_partner_firms_count": { "type": "integer", "description": "Количество фирм, которые написали о данной фирме на форуме Недобросовестных партнеров", "format": "int32", "nullable": true } } }, "CustomerSource": { "type": "integer", "description": "Источник информации о заказчике\n\n* `1` - Справочник \"Контрагенты не из АТИ\"\n* `2` - Глобальный поиск\n* `3` - Справочник \"Ваши реквизиты\"", "x-enumNames": [ "Contractors", "GlobalSearch", "BillingRequisites" ], "enum": [ 1, 2, 3 ] }, "RequisiteView2": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "Наименование реквизитов", "nullable": true }, "bank": { "type": "string", "description": "Наименование банка", "nullable": true }, "ks": { "type": "string", "description": "Корреспондентский счёт", "nullable": true }, "registration_number": { "type": "string", "description": "Регистрационный номер", "nullable": true }, "rs": { "type": "string", "description": "Расчётный счёт", "nullable": true }, "bik": { "type": "string", "description": "БИК", "nullable": true } } }, "GenDirectorView": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "Имя", "nullable": true }, "surname": { "type": "string", "description": "Фамилия", "nullable": true }, "patronymic": { "type": "string", "description": "Отчество", "nullable": true }, "number_phone": { "type": "string", "description": "Номер телефона", "nullable": true } } }, "ContactView2": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "Имя контакта", "nullable": true }, "surname": { "type": "string", "description": "Фамилия", "nullable": true }, "patronymic": { "type": "string", "description": "Отчество", "nullable": true }, "number_phone": { "type": "string", "description": "Номер мобильного телефона", "nullable": true }, "phone": { "type": "string", "description": "Номер городского телефона", "nullable": true }, "messenger_phone": { "type": "string", "description": "Дополнительный телефон", "nullable": true }, "fax": { "type": "string", "description": "Факс", "nullable": true }, "was_modified": { "type": "boolean", "description": "Флаг редактирования контакта", "nullable": true }, "selected_number": { "description": "Выбранный номер телефона", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectedNumberView" } ] }, "is_confirmed": { "type": "boolean", "description": "Признак подтверждения контакта", "nullable": true } } }, "SelectedNumberView": { "type": "object", "additionalProperties": false, "properties": { "value": { "type": "string", "description": "Телефонный номер", "nullable": true }, "country_code": { "type": "string", "description": "Строковый двузначный код страны выбранного телефонного номера", "nullable": true } } }, "AddressView": { "type": "object", "additionalProperties": false, "properties": { "is_legal": { "type": "boolean", "description": "True - Юридический адрес\nFalse - Фактический адрес" }, "post_index": { "type": "string", "description": "Почтовый индекс", "nullable": true }, "city_id": { "type": "integer", "description": "ID Города", "format": "int32", "nullable": true }, "street_name": { "type": "string", "description": "Название улицы", "nullable": true }, "house": { "type": "string", "description": "Номер дома", "nullable": true }, "entrance": { "type": "string", "description": "Вход", "nullable": true }, "litera": { "type": "string", "description": "Литера/корпус", "nullable": true }, "office_no": { "type": "string", "description": "Номер офиса", "nullable": true }, "recipient_full_name": { "type": "string", "description": "ФИО Получателя", "nullable": true }, "comment": { "type": "string", "description": "Комментарий", "nullable": true }, "region_id": { "type": "integer", "description": "ID региона", "format": "int32", "nullable": true } } }, "LoadCopyView": { "type": "object", "description": "Копия груза\n\n*При взятии груз копируется, копия не отображается в поиске и её невозможно отредактировать*", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "Id копии груза ", "format": "guid" }, "load_number": { "type": "string", "description": "Сгенерированный номер груза" }, "load_meta": { "$ref": "#/components/schemas/LoadMeta" }, "auction_id": { "type": "string", "description": "Id Торгов (аукциона)", "format": "guid", "nullable": true }, "updated_at": { "type": "string", "description": "Дата последнего изменения груза", "format": "date-time" }, "added_at": { "type": "string", "description": "Дата добавления груза", "format": "date-time" }, "archive_date": { "type": "string", "description": "Дата помещения груза в архив\n\n*При взятии груза, он попадает в архив*", "format": "date-time", "nullable": true }, "distance": { "type": "integer", "description": "Расстояние для груза\n \n*При расчете учитываются дополнительные пункты разгрузки*", "format": "int32" }, "distance_type": { "type": "integer", "description": "Маршрут построен с проездом по МКАД или без МКАД\n \n* `0` — без МКАД\n* `1` — с МКАД", "format": "int32" }, "platon_roads_length": { "type": "integer", "description": "Расстояние по Платону", "format": "int32" }, "toll_roads_length": { "type": "integer", "description": "Расстояние по платным дорогам", "format": "int32" }, "travel_time": { "type": "string", "description": "Время в пути", "format": "duration" }, "true_price": { "type": "integer", "description": "Озвученная ставка", "format": "int32" }, "true_currency_id": { "type": "integer", "description": "Id валюты озвученной ставки", "format": "int32" }, "parent_id": { "type": "string", "description": "Id груза", "format": "guid", "nullable": true }, "is_unpublished": { "type": "boolean", "description": "Груз не опубликован" }, "firm_id": { "type": "integer", "description": "ID фирмы, выставившей груз", "format": "int32" }, "contact_id1": { "type": "integer", "description": "Контакт #1, указанный в грузе", "format": "int32" }, "contact_id2": { "type": "integer", "description": "Контакт #2, указанный в грузе", "format": "int32", "nullable": true }, "note": { "type": "string", "description": "Примечание к грузу" }, "first_date": { "type": "string", "description": "Дата, начиная с которой груз актуален", "format": "date-time" }, "last_date": { "type": "string", "description": "Дата, после которой груз не актуален", "format": "date-time" }, "date_type": { "$ref": "#/components/schemas/DateType" }, "periodicity_id": { "$ref": "#/components/schemas/Periodicity" }, "order_number": { "type": "string", "description": "Номер груза/заказа" }, "krugoreis": { "type": "boolean", "description": "Кругорейс" }, "zimnik": { "type": "boolean", "description": "Зимники" }, "ferries": { "type": "boolean", "description": "Паромные переправы" }, "loading": { "description": "Точка загрузки", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/LoadPointView" } ] }, "extra_points": { "type": "array", "description": "Дополнительные точки ", "nullable": true, "items": { "$ref": "#/components/schemas/LoadExtraPointView2" } }, "unloading": { "description": "Точка разгрузки", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/LoadPointView" } ] }, "cargo": { "description": "Параметры груза", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/LoadCargoView" } ] }, "transport": { "description": "Параметры перевозки", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/LoadTransportView2" } ] }, "boards": { "type": "array", "description": "Площадки, на которых опубликован груз", "nullable": true, "items": { "$ref": "#/components/schemas/BoardView" } }, "unload_first_date": { "type": "string", "description": "Дата, начиная с которой можно разгрузить груз", "format": "date-time", "nullable": true }, "unload_last_date": { "type": "string", "description": "Дата, до которой можно разгрузить груз", "format": "date-time", "nullable": true } } }, "LoadExtraPointView2": { "type": "object", "additionalProperties": false, "properties": { "route_point_id": { "type": "string", "format": "guid" }, "id": { "type": "string", "format": "guid" }, "city_id": { "type": "integer", "description": "Id города\\\nЗначение из [словаря городов АТИ](https://ati.su/developers/api/dictionaries/geo/) ", "format": "int32" }, "point_type": { "$ref": "#/components/schemas/LoadExtraPointType" }, "ordinal_id": { "type": "integer", "description": "Порядковый номер в маршруте", "format": "int32" }, "distance": { "type": "integer", "description": "Расстояние", "format": "int32" }, "street": { "type": "string", "description": "Адрес", "nullable": true }, "latitude": { "type": "number", "description": "Широта", "format": "decimal", "nullable": true }, "longitude": { "type": "number", "description": "Долгота", "format": "decimal", "nullable": true }, "organization_id": { "type": "string", "description": "Id из справочника организаций", "format": "guid", "nullable": true }, "address_id": { "type": "string", "description": "Id адреса в организации", "format": "guid", "nullable": true }, "loading_date_start": { "type": "string", "description": "Дата начала загрузки", "format": "date-time", "nullable": true }, "loading_date_end": { "type": "string", "description": "Дата конца загрузки", "format": "date-time", "nullable": true }, "loading_time_start": { "type": "string", "description": "Время начала загрузки", "format": "duration", "nullable": true }, "loading_time_end": { "type": "string", "description": "Время конца загрузки", "format": "duration", "nullable": true }, "is_round_the_clock": { "type": "boolean", "description": "Круглосуточно" }, "city_name": { "type": "string", "nullable": true }, "loading_cargos": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/LoadingCargo" } }, "unloading_cargos": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/UnloadingCargo" } }, "organization": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organization" } ] } } }, "LoadTransportView2": { "type": "object", "description": "Параметры перевозки", "additionalProperties": false, "properties": { "car_type": { "type": "integer", "description": "Битовая сумма кузовов", "format": "int64" }, "car_type_string": { "type": "string", "nullable": true }, "loading_type": { "type": "integer", "description": "Битовая сумма типов загрузки", "format": "int32" }, "loading_logical_operator": { "type": "string", "description": "Тип условия загрузки\n\n* `OR`\n* `AND`", "nullable": true }, "unloading_type": { "type": "integer", "description": "Битовая сумма типов разгрузки", "format": "int32" }, "unloading_logical_operator": { "type": "string", "description": "Тип условия разгрузки\n \n* `OR`\n* `AND`", "nullable": true }, "trucks_quantity": { "type": "integer", "description": "Количество машин", "format": "int32" }, "temperature_from": { "type": "integer", "description": "Температура перевозки - нижнее значение", "format": "int32", "nullable": true }, "temperature_to": { "type": "integer", "description": "Температура перевозки - верхнее значение", "format": "int32", "nullable": true }, "truck_attribs": { "type": "integer", "description": "Настройки для машины, используются только в RMQ (Stsepka, Pnevmohod, Koniki)", "format": "int32", "nullable": true }, "stsepka": { "type": "boolean", "description": "Сцепка" }, "pnevmohod": { "type": "boolean", "description": "Пневмоход" }, "koniki": { "type": "boolean", "description": "Коники" }, "tir": { "type": "boolean", "description": "TIR" }, "cmr": { "type": "boolean", "description": "CMR" }, "t1": { "type": "boolean", "description": "Т1" }, "san_passport": { "type": "boolean", "description": "Мед книжка" }, "sanitation_logbook": { "type": "boolean", "description": "Сан. книжка" }, "is_tracking": { "type": "boolean", "description": "Запрос отслеживания через АТИ Водитель" }, "required_capacity": { "type": "number", "description": "Требуемая грузоподъёмность в тоннах", "format": "decimal", "nullable": true } } }, "FullDealView": { "allOf": [ { "$ref": "#/components/schemas/DealView3" }, { "type": "object", "description": "Заказ\n \n*Основная информация о Заказе*", "additionalProperties": false, "properties": { "started_at": { "type": "string", "description": "Дата взятия/резервирования груза", "format": "date-time", "nullable": true }, "finished_at": { "type": "string", "description": "Дата завершения заказа", "format": "date-time", "nullable": true }, "denial_reason": { "type": "string", "description": "Причина отклонения заказа\n \n*Присутствует когда Status `-2` или `-3`*" }, "requisite_id": { "type": "string", "description": "Id реквизитов\\\nсм. taker_requisites, в новой версии API это поле перестанет существовать", "format": "guid", "deprecated": true, "nullable": true }, "taker_requisites": { "description": "Реквизиты перевозчика", "oneOf": [ { "$ref": "#/components/schemas/RequisiteView3" } ] }, "signer_id": { "type": "string", "description": "Id подписанта\\\nсм. taker_requisites, в новой версии API это поле перестанет существовать", "format": "guid", "deprecated": true, "nullable": true }, "driver": { "description": "Копия водителя\n \n*При взятии груза, водитель копируется, копию редактировать невозможно*", "oneOf": [ { "$ref": "#/components/schemas/DriverView2" } ] }, "truck": { "description": "Копия транспортного средства\n \n*При взятии груза, транспортное средство копируется, копию редактировать невозможно*", "oneOf": [ { "$ref": "#/components/schemas/TruckView2" } ] }, "trailer": { "description": "Копия прицепа\n \n*При взятии груза, прицеп копируется, копию редактировать невозможно*", "oneOf": [ { "$ref": "#/components/schemas/TruckView2" } ] }, "semi_trailer": { "description": "Копия полуприцепа\n \n*При взятии груза, полуприцеп копируется, копию редактировать невозможно*", "oneOf": [ { "$ref": "#/components/schemas/TruckView2" } ] }, "document": { "description": "Основной документ в АТИ-Доках", "oneOf": [ { "$ref": "#/components/schemas/DocumentView" } ] }, "additional_documents": { "type": "array", "description": "Дополнительные документы", "items": { "$ref": "#/components/schemas/AdditionalDocumentView" } }, "in_work_status_model": { "description": "Статусная модель перевозки\n \n* `0` — Простая перевозка\n* `1` — Первая миля\n* `2` — Последняя миля\n* `3` — Порожний контейнер", "oneOf": [ { "$ref": "#/components/schemas/InWorkStatusModel" } ] }, "in_work": { "description": "Статус перевозки заказа", "oneOf": [ { "$ref": "#/components/schemas/DealInWorkView3" } ] }, "deal_note": { "type": "string", "description": "Предлагаемые правки к документу" }, "deal_kind": { "$ref": "#/components/schemas/DealKinds" }, "points": { "type": "array", "description": "Точки маршрута", "items": { "$ref": "#/components/schemas/DealPointView3" } } } } ] }, "RequisiteView3": { "type": "object", "additionalProperties": false, "properties": { "requisite_id": { "type": "string", "description": "Id реквизитов\\\nБолее подробную информацию о реквизитах можно посмотреть [здесь](https://ati.su/developers/api/firms/#firms-requisites)", "format": "guid", "nullable": true }, "requisite_firm_name": { "type": "string", "description": "Название компании" }, "signer_id": { "type": "string", "description": "Id подписанта", "format": "guid", "nullable": true }, "own_ship_id": { "type": "integer", "description": "Идентификатор формы собственности\\\nЗначение из [словаря ОПФ АТИ](https://ati.su/developers/api/dictionaries/firms/#get-v1.0-dictionaries-ownerships/) ", "format": "int32" }, "inn": { "type": "string", "description": "ИНН" }, "kpp": { "type": "string", "description": "КПП", "nullable": true }, "requisite_type_id": { "type": "integer", "description": "Тип реквизитов", "format": "int32", "nullable": true } } }, "DriverView2": { "type": "object", "additionalProperties": false, "properties": { "driver_id": { "type": "string", "description": "Id копии водителя", "format": "guid" }, "parent_id": { "type": "string", "description": "Идентификатор водителя из [Справочника Водителей](/api/catalogs/#водители)", "format": "guid", "nullable": true }, "first_name": { "type": "string", "description": "Имя водителя" }, "second_name": { "type": "string", "description": "Фамилия водителя" }, "patronymic": { "type": "string", "description": "Отчество водителя" }, "phone_number": { "type": "string", "description": "Номер телефона" }, "driver_license_number": { "type": "string", "description": "Номер водительского удостоверения" }, "passport_series": { "type": "string", "description": "Серия паспорта" }, "passport_number": { "type": "string", "description": "Номер паспорта" }, "passport_issued_by": { "type": "string", "description": "Кем выдан" }, "passport_when_issued": { "type": "string", "description": "Когда выдан", "format": "date-time" }, "registration": { "type": "string", "description": "Прописка" }, "is_attracted_driver": { "type": "boolean", "description": "Флаг привлеченного водителя (со стороны)" }, "last_deal_related_id": { "type": "string", "description": "Id связанной сущности по Заказу", "format": "guid", "nullable": true }, "description": { "type": "string", "description": "Краткое описание водителя" }, "attracted_from": { "type": "string", "description": "Фирма от которой привлечен водитель." }, "scans": { "type": "array", "description": "Сканы паспорта / водительского удостоверения", "items": { "$ref": "#/components/schemas/Scan" } }, "origin": { "description": "Идентификатор источника информации о водителе\n \n* `0` — Неизвестно откуда указан водитель\n* `1` — Водитель указан на странице заказов у Заказа в исполнении\n* `2` — Водитель указан в АТИ-Доках", "oneOf": [ { "$ref": "#/components/schemas/DriverOrigin" } ] }, "date_of_birth": { "type": "string", "description": "Дата рождения", "format": "date-time", "nullable": true }, "department_code_in_passport": { "type": "string", "description": "Код подразделения" }, "driver_inn": { "type": "string", "description": "ИНН водителя" }, "in_cargo_owner_black_list": { "type": "boolean", "description": "Есть в Черном списке" }, "external_id": { "type": "string", "description": "Внешний идентификатор" }, "black_list_reasons": { "type": "array", "description": "Причины добавления в Черный список", "items": { "type": "string" } } } }, "TruckView2": { "type": "object", "description": "Транспортное средство", "additionalProperties": false, "properties": { "truck_id": { "type": "string", "description": "Id копии транспортного средства", "format": "guid" }, "parent_id": { "type": "string", "description": "Id транспортного средства из [Автопарка](/api/catalogs/#автопарк)", "format": "guid", "nullable": true }, "last_deal_related_id": { "type": "string", "description": "Id ТС, с которым было связано ТС во время выполнения последнего Заказа", "format": "guid", "nullable": true }, "type": { "description": "Тип транспортного средства\n \n* `1` — Грузовик\n* `2` — Тягач\n* `4` — Полуприцеп\n* `8` — Прицеп", "oneOf": [ { "$ref": "#/components/schemas/TruckType" } ] }, "description": { "type": "string", "description": "Описание транспортного средства" }, "brand_id": { "type": "integer", "description": "Марка", "format": "int32", "nullable": true }, "model": { "type": "string", "description": "Модель" }, "number": { "type": "string", "description": "Номер" }, "phone_number": { "type": "string", "description": "Телефон" }, "is_attracted_truck": { "type": "boolean", "description": "Привлеченное ТС" }, "ownership_type": { "description": "Тип владения ТС\n \n* `0` - Собственное\n* `1` - Привлеченное\n* `2` - Аренда\n* `3` - Лизинг\n* `4` - Совместная собственность (супругов)\n* `5` - Безвозмездное пользование", "oneOf": [ { "$ref": "#/components/schemas/TruckOwnershipType" } ] }, "car_type_id": { "type": "integer", "description": "Тип Кузова", "format": "int32" }, "capacity": { "type": "number", "description": "Грузоподъемность", "format": "decimal", "nullable": true }, "volume": { "type": "number", "description": "Объем", "format": "decimal", "nullable": true }, "length": { "type": "number", "description": "Длина", "format": "decimal", "nullable": true }, "width": { "type": "number", "description": "Ширина", "format": "decimal", "nullable": true }, "height": { "type": "number", "description": "Высота", "format": "decimal", "nullable": true }, "manufacture_year": { "type": "integer", "description": "Год выпуска", "format": "int32", "nullable": true }, "vin": { "type": "string", "description": "VIN" }, "vrc": { "type": "string", "description": "СТС" }, "body_number": { "type": "string", "description": "Номер кузова" }, "dimension": { "type": "integer", "description": "Размерность контейнера", "format": "int32", "nullable": true }, "truck_passport_number": { "type": "string", "description": "Номер ПТС" }, "can_refrigerator": { "type": "boolean", "description": "Способность возить реф-контейнеры", "nullable": true }, "has_gen_set": { "type": "boolean", "description": "Есть GenSet", "nullable": true }, "truck_owner_name": { "type": "string", "description": "Имя владельца по СТС" }, "can_carry_heavy_container": { "type": "boolean", "description": "Способность перевозить тяжелые контейнеры\n ", "nullable": true }, "can_carry_tall_container": { "type": "boolean", "description": "Способность перевозить высокие контейнеры", "nullable": true }, "external_id": { "type": "string", "description": "Внешний идентификатор" }, "verified": { "type": "boolean", "description": "Проверено" }, "modification_restricted": { "type": "boolean", "description": "Запрещено редактирование и удаление ТС." }, "scans": { "type": "array", "description": "Сканы ПТС", "items": { "$ref": "#/components/schemas/Scan" } }, "origin": { "description": "Источник создания Транспорта\n \n* `0` — Неизвестно откуда указано ТС\n* `1` — ТС указано на странице заказов у Заказа в исполнении\n* `2` — ТС Указано в АТИ-доках", "oneOf": [ { "$ref": "#/components/schemas/TruckOrigin" } ] } } }, "DocumentView": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "ID документа" }, "old_id": { "type": "string", "description": "ID старого документа" }, "editor": { "type": "string", "description": "Фирма, отредактировавшая документ" }, "url": { "type": "string", "description": "Адрес просмотра договора" }, "old_url": { "type": "string", "description": "Адрес просмотра старого договора" }, "name": { "type": "string", "description": "Имя документа" }, "is_signed": { "type": "boolean", "description": "Документ подписан перевозчиком" }, "access": { "description": "Доступ к документу\n \n* `0` — Обе стороны\n* `1` — Водитель", "oneOf": [ { "$ref": "#/components/schemas/DealDocumentAccess" } ] } } }, "AdditionalDocumentView": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "Id документа" }, "is_counterparty_file": { "type": "boolean", "description": "Файл контрагента" }, "url": { "type": "string", "description": "Адрес документа" }, "name": { "type": "string", "description": "Имя документа" }, "is_signed": { "type": "boolean", "description": "Документ подписан перевозчиком" }, "document_type": { "description": "Тип документа\n \n* `0` — Нет\n* `1` — Заказ\n* `2` — Договор-заявка\n* `3` — Поручение экспедитору\n* `4` — Акт\n* `5` — Счет\n* `6` — Одностороннее расторжение\n* `7` — Доверенность\n* `8` — Табличный заказ\n* `9` — Заявка к договору (табличный вид)", "oneOf": [ { "$ref": "#/components/schemas/DocumentType" } ] }, "access": { "description": "Доступ к документу\n \n* `0` — Обе стороны\n* `1` — Водитель", "oneOf": [ { "$ref": "#/components/schemas/DealDocumentAccess" } ] } } }, "DealInWorkView3": { "type": "object", "additionalProperties": false, "properties": { "deal_id": { "type": "string", "description": "Id Заказа", "format": "guid" }, "in_work_status": { "description": "Статус перевозки\n \n* `0` — Нет статуса\n* `1` — Едет на загрузку\n* `2` — Ожидает загрузку\n* `3` — Загружается\n* `4` — Загрузился, едет на выгрузку\n* `5` — Ожидает выгрузку\n* `6` — Выгружается\n* `7` — Выгрузился\n* `8` — Поломка\n* `9` — ДТП\n* `10` — Арест ТС\n* `11` — Контейнер получен на погрузку\n* `12` — Контейнер на погрузке\n* `13` — Погрузка контейнера окончена\n* `14` — Контейнер сдан с погрузки\n* `15` — Контейнер получен на выгрузку\n* `16` — Контейнер на выгрузке\n* `17` — Выгрузка контейнера окончена\n* `18` — Контейнер сдан с выгрузки\n* `19` — Пустой контейнер получен\n* `20` — Пустой контейнер сдан", "oneOf": [ { "$ref": "#/components/schemas/InWorkStatus" } ] }, "in_work_date": { "type": "string", "description": "Дата выставления статуса", "format": "date-time", "nullable": true }, "ati_id": { "type": "string", "description": "Фирма, выставившая статус (перевозчик или грузовладелец)", "nullable": true }, "contact_id": { "type": "integer", "description": "Контакт, выставивший статус", "format": "int32", "nullable": true }, "tracker_phone": { "type": "number", "description": "Номер телефона трекера, откуда получен статус", "format": "decimal", "nullable": true } } }, "DealPointView3": { "type": "object", "description": "Точка маршрута заказа", "additionalProperties": false, "properties": { "deal_point_id": { "type": "string", "description": "Id точки заказа", "format": "guid" }, "ordinal_id": { "type": "integer", "description": "Порядковый номер", "format": "int32" }, "point_type": { "description": "Тип точки маршрута\n \n* `1` — Загрузка\n* `2` — Разгрузка", "oneOf": [ { "$ref": "#/components/schemas/DealPointTypes" } ] }, "city_id": { "type": "integer", "description": "Id города\\\nЗначение из [словаря городов АТИ](https://ati.su/developers/api/dictionaries/geo/) ", "format": "int32" }, "lat": { "type": "number", "description": "Широта", "format": "double", "nullable": true }, "lon": { "type": "number", "description": "Долгота", "format": "double", "nullable": true }, "address": { "type": "string", "description": "Адрес", "nullable": true }, "participant_name": { "type": "string", "description": "Название организации", "nullable": true }, "region_id": { "type": "integer", "description": "Id региона\nЗначение из [словаря регионов АТИ](https://ati.su/developers/api/dictionaries/geo/) ", "format": "int32" }, "contact_name": { "type": "string", "nullable": true }, "organization_id": { "type": "string", "format": "guid", "nullable": true }, "stock_id": { "type": "string", "format": "guid", "nullable": true }, "stock": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PointStockDocView2" } ] }, "organization": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganizationView2" } ] } } }, "PointStockDocView2": { "type": "object", "additionalProperties": false, "properties": { "stock_id": { "type": "string", "format": "guid" }, "address": { "type": "string", "nullable": true }, "address_city_id": { "type": "integer", "format": "int32", "nullable": true }, "note": { "type": "string", "nullable": true }, "contact_persons": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPersonView2" } }, "schedule_summary": { "type": "string", "nullable": true }, "stock_type": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/StockType" } ] }, "timeslots_warehouse_id": { "type": "integer", "format": "int32", "nullable": true } } }, "ContactPersonView2": { "type": "object", "additionalProperties": false, "properties": { "contact_person_id": { "type": "string", "format": "guid" }, "name": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" } } }, "OrganizationView2": { "type": "object", "additionalProperties": false, "properties": { "organization_id": { "type": "string", "format": "guid" }, "name": { "type": "string" }, "phone": { "type": "string" }, "contact_persons": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPersonView2" } } } }, "DealView3": { "type": "object", "description": "Заказ\n \n*Основная информация о Заказе*", "additionalProperties": false, "properties": { "deal_id": { "type": "string", "description": "Id Заказа", "format": "guid" }, "load_copy_id": { "type": "string", "description": "Id связанной копии груза", "format": "guid" }, "load_id": { "type": "string", "description": "Id груза", "format": "guid" }, "taker_ati_id": { "type": "string", "description": "Код фирмы, взявшей груз" }, "taker_persistent_user_id": { "type": "integer", "description": "Идентификатор пользователя, взявшего груз", "format": "int32" }, "taker_contact_id": { "type": "integer", "description": "Id контакта, взявшего груз", "format": "int32" }, "cargo_owner_ati_id": { "type": "string", "description": "Код фирмы опубликовавшей груз" }, "cargo_owner_persistent_user_id": { "type": "integer", "description": "Идентификатор пользователя, опубликовавшего груз", "format": "int32" }, "updated_at": { "type": "string", "description": "Время изменения информации по Заказу", "format": "date-time" }, "end_of_reservation": { "type": "string", "description": "Время до которого груз зарезервирован", "format": "date-time", "nullable": true }, "auction_id": { "type": "string", "description": "Id Торгов (аукциона)", "format": "guid", "nullable": true }, "status": { "description": "Статус Заказа\n\n* `0` — Груз зарезервирован перевозчиком\n* `1` — Перевозчик заполнил информацию о реквизитах/водителе/машине и грузовладелец не просмотрел заявку\n* `2` — Перевозчик заполнил информацию о реквизитах/водителе/машине и грузовладелец просмотрел заявку\n* `3` — Грузовладелец отправил документ-заявку перевозчику\n* `4` — Заказ в исполнении (перевозчик дал согласие на документ-заявку)\n* `5` — Заказ завершен и перенесен в архив\n* `7` — Есть только приглашение на Заказ\n* `8` — Заказа нет, но есть Торги, у которых есть возможные победители\n* `9` — Заказ отклонен автоматически, так как после последней даты загрузки прошло уже более 7 дней\n* `10` — Заказ завершен, ожидается оплата\n* `11` — В Торгах лучшая ставка из других Торгов\n* `-11` — Заказ удален\n* `-10` — Резерв груза перевозчиком отменен\n* `-9` — Заказ отклонен грузовладельцем в Торгах после истечения срока подачи документов (смена победителя)\n* `-8` — Грузовладелец отменил Заказ в исполнении\n* `-7` — Перевозчик отменил Заказ в исполнении\n* `-6` — Заказ отклонен грузовладельцем после удаления Торгов\n* `-4` — Заказ отклонен грузовладельцем в Торгах (смена победителя)\n* `-3` — Заказ отклонен грузовладельцем\n* `-2` — Заказ отозван перевозчиком", "oneOf": [ { "$ref": "#/components/schemas/DealState" } ] }, "counterparty_status": { "description": "Статус Заказа у контрагента\n\n* `0` — Груз зарезервирован перевозчиком\n* `1` — Перевозчик заполнил информацию о реквизитах/водителе/машине и грузовладелец не просмотрел заявку\n* `2` — Перевозчик заполнил информацию о реквизитах/водителе/машине и грузовладелец просмотрел заявку\n* `3` — Грузовладелец отправил документ-заявку перевозчику\n* `4` — Заказ в исполнении (перевозчик дал согласие на документ-заявку)\n* `5` — Заказ завершен и перенесен в архив\n* `7` — Есть только приглашение на Заказ\n* `8` — Заказа нет, но есть Торги, у которых есть возможные победители\n* `9` — Заказ отклонен автоматически, так как после последней даты загрузки прошло уже более 7 дней\n* `10` — Заказ завершен, ожидается оплата\n* `11` — В Торгах лучшая ставка из других Торгов\n* `-11` — Заказ удален\n* `-10` — Резерв груза перевозчиком отменен\n* `-9` — Заказ отклонен грузовладельцем в Торгах после истечения срока подачи документов (смена победителя)\n* `-8` — Грузовладелец отменил Заказ в исполнении\n* `-7` — Перевозчик отменил Заказ в исполнении\n* `-6` — Заказ отклонен грузовладельцем после удаления Торгов\n* `-4` — Заказ отклонен грузовладельцем в Торгах (смена победителя)\n* `-3` — Заказ отклонен грузовладельцем\n* `-2` — Заказ отозван перевозчиком", "oneOf": [ { "$ref": "#/components/schemas/DealState" } ] }, "payment": { "description": "Параметры оплаты Заказа", "oneOf": [ { "$ref": "#/components/schemas/DealPaymentView3" } ] }, "pay_docs": { "description": "Информация об оплате заказа", "oneOf": [ { "$ref": "#/components/schemas/PayDocsView2" } ] }, "files": { "type": "array", "description": "Файлы Заказа", "items": { "$ref": "#/components/schemas/DealFileView2" } }, "document_templates": { "type": "array", "description": "Информация о шаблонах документов в заказах", "items": { "$ref": "#/components/schemas/DealDocumentTemplatesView" } }, "customer": { "description": "Информация о заказчике", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CustomerView" } ] }, "is_tracking": { "type": "boolean", "description": "Запрос отслеживания через АТИ Водитель" }, "should_show_rate_to_driver": { "type": "boolean", "description": "Показывать ли ставку водителю (для ОЗ)", "nullable": true } } }, "DealPaymentView3": { "type": "object", "additionalProperties": false, "properties": { "rates": { "type": "array", "description": "Список возможных ставок перевозки", "items": { "$ref": "#/components/schemas/RateView2" } }, "prepay_percent": { "type": "integer", "description": "Процент предоплаты", "format": "int32" }, "prepay_percent_enabled": { "type": "boolean", "description": "Есть ли предоплата" }, "on_unloading": { "type": "boolean", "description": "Оплата на выгрузке" }, "in_fuel": { "type": "boolean", "description": "Оплата топливом" }, "pay_days_enabled": { "type": "boolean", "description": "Есть ли срок оплаты" }, "pay_days": { "type": "integer", "description": "Срок оплаты", "format": "int32" }, "fixed_rate": { "type": "boolean", "description": "Указана ли в грузе ставка" }, "torg": { "type": "boolean", "description": "Возможен ли торг" }, "direct_contract": { "type": "boolean", "description": "Прямой договор" }, "money_type": { "type": "integer", "description": "Способ оплаты", "format": "int32", "nullable": true } } }, "RateView2": { "type": "object", "additionalProperties": false, "properties": { "rate": { "type": "number", "description": "Сумма", "format": "decimal", "nullable": true }, "rate_type": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/RateType" } ] }, "currency": { "type": "integer", "description": "Id валюты", "format": "int32", "nullable": true }, "active": { "type": "boolean", "description": "Является ли ставка выбранной" } } }, "PayDocsView2": { "type": "object", "additionalProperties": false, "properties": { "documents_copies": { "description": "Информация о копиях документов", "oneOf": [ { "$ref": "#/components/schemas/DocumentStatusInfoView" } ] }, "documents_original": { "description": "Информация о оригиналах документов", "oneOf": [ { "$ref": "#/components/schemas/DocumentStatusInfoView" } ] }, "documents_original_track": { "description": "Информация об отслеживании оригиналов документов", "oneOf": [ { "$ref": "#/components/schemas/DocumentTrackingInfoView" } ] }, "payment": { "description": "Информация об оплате", "oneOf": [ { "$ref": "#/components/schemas/PaymentStatusView" } ] } } }, "DealFileView2": { "type": "object", "description": "Файлы заказа", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "Id файла", "format": "guid", "nullable": true }, "storage_file_id": { "type": "string", "description": "Id файла в хранилище", "nullable": true }, "access": { "description": "Доступ к файлу\n \n* `0` — только загрузивший файл\n* `1` — обе стороны\n* `2` — загрузивший файл и водитель\n* `3` — доступен обеим сторонам и водителю", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DealFileAccess" } ] }, "add_date": { "type": "string", "description": "Время загрузки файла", "format": "date-time", "nullable": true }, "deal_id": { "type": "string", "description": "Id связанного Заказа", "format": "guid" }, "is_counterparty_file": { "type": "boolean", "description": "Файл контрагента" }, "file_name": { "type": "string", "description": "Имя файла", "nullable": true }, "size": { "type": "integer", "description": "Размер файла", "format": "int32" }, "link": { "type": "string", "description": "Ссылка на файл", "nullable": true }, "file_id": { "type": "string", "description": "ID файла", "nullable": true }, "source_type": { "description": "Источник файла\n \n* `0` — Загружен в заказ\n* `1` — Скопирован из груза\n* `2` — Скопирован из данных о водителе\n* `3` — Скопироване из данных о грузовике\n* `4` — Скопирован из данных о прицепе\n* `5` — Скопирован из данных о полуприцепе\n* `6` — Скопирован из данных о тягаче\n* `7` — Загружен для Ати-водителя", "oneOf": [ { "$ref": "#/components/schemas/DealFileSourceTypes" } ] }, "source_file_type": { "description": "Тип загруженного файла\n \n* `0` — Обычный файл\n* `1` — Водительское удостоверение\n* `2` — Паспорт водителя\n* `3` — Техпаспорт ТС\n* `4` — Пластик\n* `5` — Фото ТС", "oneOf": [ { "$ref": "#/components/schemas/DealFileSourceFileTypes" } ] }, "file_type": { "description": "Тип файла\n \n* `0` — Другой документ\n* `1` — Товарно-транспортная накладная\n* `2` — Товарная накладная\n* `3` — Транспортная накладная\n* `4` — Накладная\n* `5` — Счет-фактура\n* `6` — Счет на оплату\n* `7` — Платежное поручение\n* `8` — Акт выполненных работ\n* `9` — Заявка\n* `10` — Заявка (к договору)\n* `11` — Заказ\n* `12` — Договор\n* `13` — Доп. соглашение (к договору)\n* `14` — Доверенность\n* `15` — Поручение экспедитору\n* `16` — Информационное письмо\n* `17` — Документ о происшествии с грузом/ТС", "oneOf": [ { "$ref": "#/components/schemas/DealFileType" } ] }, "timeslots_warehouse_ids": { "type": "array", "description": "Список складов с Временными окнами с доступом к файлу", "nullable": true, "items": { "type": "integer", "format": "int32" } } } }, "DealDocumentTemplatesView": { "type": "object", "additionalProperties": false, "properties": { "organization_address": { "type": "string", "description": "Адрес организации" }, "templates": { "type": "array", "description": "Шаблоны документов", "items": { "$ref": "#/components/schemas/DocumentTemplateView2" } } } }, "DocumentTemplateView2": { "type": "object", "additionalProperties": false, "properties": { "add_date": { "type": "string", "description": "Время загрузки документа", "format": "date-time", "nullable": true }, "access": { "description": "Доступ к документу\n \n* `0` — только загрузивший документ\n* `1` — обе стороны", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DealDocumentTemplateAccess" } ] }, "timeslots_warehouse_ids": { "type": "array", "description": "Список складов с Временными окнами с доступом к документу", "nullable": true, "items": { "type": "integer", "format": "int32" } }, "deal_id": { "type": "string", "description": "Id связанного Заказа", "format": "guid", "nullable": true }, "deal_point_id": { "type": "string", "description": "Id точки в заказе, к которой привязан документ", "format": "guid", "nullable": true }, "owner_firm_id": { "type": "integer", "description": "Id фирмы, загрузившей документ", "format": "int32", "nullable": true }, "cargoes_ids_hash": { "type": "integer", "description": "Поле-хэш, рассчитывается на основе id грузов, выгружаемых в точке DealPointId. Если выгружаемые грузы не указаны - будет равно 0", "format": "int32", "nullable": true }, "contact_id": { "type": "integer", "description": "Id контакта", "format": "int32", "nullable": true }, "file_name": { "type": "string", "description": "Название документа", "nullable": true }, "file_id": { "type": "string", "description": "Id файла документа", "nullable": true }, "id": { "type": "string", "description": "Id документа", "format": "guid", "nullable": true }, "size": { "type": "integer", "description": "Размер документа", "format": "int32", "nullable": true }, "link": { "type": "string", "description": "Ссылка на документ (только для сайта)" } } }, "OrderViewOfFullDealView": { "type": "object", "additionalProperties": false, "properties": { "load_copy": { "description": "Копия груза\n\n*При создании заказа груз копируется, копия не отображается в поиске и её невозможно отредактировать*", "oneOf": [ { "$ref": "#/components/schemas/LoadCopyView" } ] }, "deal": { "description": "Заказ\n \n*Основная информация о заказе*", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FullDealView" } ] } } }, "LoadTakeInfoIntegratorsDto": { "type": "object", "description": "Параметры Заказа", "additionalProperties": false, "properties": { "rate_type": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/RateType" } ] }, "driver_id": { "type": "string", "description": "Id водителя", "format": "guid", "nullable": true }, "truck_info_id": { "type": "string", "description": "Id транспортного средства", "format": "guid", "nullable": true }, "semitrailer_id": { "type": "string", "description": "Id полуприцепа\n \n*Может быть указан только если транспортное средство — тягач*", "format": "guid", "nullable": true }, "trailer_id": { "type": "string", "description": "Id прицепа\n \n*Может быть указан только если указан полуприцеп или транспортное средство — грузовик*", "format": "guid", "nullable": true }, "requisites_id": { "type": "string", "description": "Id реквизитов", "format": "guid", "nullable": true }, "signer_id": { "type": "string", "description": "Id подписанта", "format": "guid", "nullable": true }, "is_drop_docs": { "type": "boolean", "description": "Отзывать ли привязанные документы\n \n*Используется при редактировании*" }, "deal_kind": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DealKinds" } ] }, "taker_note": { "type": "string", "description": "Комментарий перевозчика" } } }, "InvitationPaymentView": { "type": "object", "additionalProperties": false, "properties": { "rates": { "type": "array", "description": "Список возможных ставок перевозки", "items": { "$ref": "#/components/schemas/InvitationRateView" } }, "prepay_percent": { "type": "integer", "description": "Процент предоплаты", "format": "int32" }, "prepay_percent_enabled": { "type": "boolean", "description": "Есть ли предоплата" }, "on_unloading": { "type": "boolean", "description": "Оплата на выгрузке" }, "in_fuel": { "type": "boolean", "description": "Оплата топливом" }, "pay_days_enabled": { "type": "boolean", "description": "Есть ли срок оплаты" }, "pay_days": { "type": "integer", "description": "Срок оплаты", "format": "int32" }, "fixed_rate": { "type": "boolean", "description": "Указана ли в грузе ставка" }, "torg": { "type": "boolean", "description": "Возможен ли торг" }, "direct_contract": { "type": "boolean", "description": "Прямой договор" }, "money_type": { "type": "integer", "description": "Способ оплаты", "format": "int32", "nullable": true }, "payment_source": { "$ref": "#/components/schemas/PaymentSource" } } }, "InvitationRateView": { "type": "object", "additionalProperties": false, "properties": { "rate": { "type": "number", "description": "Сумма", "format": "decimal", "nullable": true }, "rate_type": { "description": "Тип оплаты\n \n* `0` — Нет\n* `1` — Любая\n* `2` — С НДС\n* `3` — Без НДС", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/RateType" } ] }, "currency": { "type": "integer", "description": "Id валюты\\\nЗначение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes)", "format": "int32", "nullable": true } } }, "PersonalInvitationView3": { "type": "object", "additionalProperties": false, "properties": { "owner_ati_id": { "type": "string", "description": "Id фирмы грузовладельца" }, "owner_persistent_user_id": { "type": "integer", "description": "Постоянный Id фирмы грузовладельца", "format": "int32" }, "owner_contact_id": { "type": "integer", "description": "Id контакта, который отправил приглашение", "format": "int32", "nullable": true }, "taker_ati_id": { "type": "string", "description": "Id приглашенной фирмы" }, "taker_persistent_user_id": { "type": "integer", "description": "Постоянный Id приглашенной фирмы", "format": "int32" }, "taker_contact_id": { "type": "integer", "description": "Id контакта приглашенной фирмы", "format": "int32" }, "taker_contacts_list": { "type": "array", "description": "Список контактов приглашенной фирмы", "items": { "type": "integer", "format": "int32" } }, "date": { "type": "string", "description": "Время отправки приглашения", "format": "date-time" }, "cancellation_date": { "type": "string", "description": "Время отмены приглашения", "format": "date-time", "nullable": true }, "payment": { "description": "Предложенные параметры оплаты", "oneOf": [ { "$ref": "#/components/schemas/InvitationPaymentView" } ] }, "load": { "description": "Параметры предложенного груза", "oneOf": [ { "$ref": "#/components/schemas/ShortLoadView" } ] }, "is_tracking": { "type": "boolean", "description": "Запрос отслеживания через АТИ Водитель" }, "deal_kind": { "description": "Тип Заказа", "oneOf": [ { "$ref": "#/components/schemas/DealKinds" } ] } } }, "ShortLoadView": { "type": "object", "description": "Краткая информация по грузу", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "ID груза", "format": "guid" }, "load_number": { "type": "string", "description": "Сгенерированный номер груза" }, "distance": { "type": "integer", "description": "Расстояние для груза\n \n*При расчете учитываются дополнительные пункты разгрузки*", "format": "int32" }, "distance_type": { "type": "integer", "description": "Маршрут построен с проездом по МКАД или без МКАД\n \n* `0` — без МКАД\n* `1` — с МКАД", "format": "int32" }, "platon_roads_length": { "type": "integer", "description": "Расстояние по Платону", "format": "int32" }, "toll_roads_length": { "type": "integer", "description": "Расстояние по платным дорогам", "format": "int32" }, "travel_time": { "type": "string", "description": "Время в пути", "format": "duration" }, "true_price": { "type": "integer", "description": "Озвученная ставка", "format": "int32" }, "true_currency_id": { "type": "integer", "description": "ID валюты озвученной ставки", "format": "int32" }, "note": { "type": "string", "description": "Примечание к грузу" }, "first_date": { "type": "string", "description": "Дата, начиная с которой груз актуален", "format": "date-time" }, "last_date": { "type": "string", "description": "Дата, после которой груз не актуален", "format": "date-time" }, "date_type": { "$ref": "#/components/schemas/DateType" }, "periodicity_id": { "$ref": "#/components/schemas/Periodicity" }, "order_number": { "type": "string", "description": "Номер груза/заказа" }, "krugoreis": { "type": "boolean", "description": "Кругорейс" }, "zimnik": { "type": "boolean", "description": "Зимники" }, "ferries": { "type": "boolean", "description": "Паромные переправы" }, "loading": { "description": "Точка загрузки", "oneOf": [ { "$ref": "#/components/schemas/LoadPoint" } ] }, "extra_points": { "type": "array", "description": "Дополнительные точки ", "items": { "$ref": "#/components/schemas/LoadExtraPoint" } }, "unloading": { "description": "Точка разгрузки", "oneOf": [ { "$ref": "#/components/schemas/LoadPoint" } ] }, "cargo": { "description": "Параметры груза", "oneOf": [ { "$ref": "#/components/schemas/LoadCargo" } ] }, "transport": { "description": "Параметры перевозки", "oneOf": [ { "$ref": "#/components/schemas/LoadTransport" } ] }, "unload_first_date": { "type": "string", "description": "Дата, начиная с которой можно разгрузить груз", "format": "date-time", "nullable": true }, "unload_last_date": { "type": "string", "description": "Дата, до которой можно разгрузить груз", "format": "date-time", "nullable": true } } }, "AuctionOfLoadOwner": { "description": "Торги (аукцион) для грузовладельца", "properties": { "accept_second_pay_type": { "description": "Возможность принимать другой тип оплаты (с НДС или без НДС)", "example": true, "type": "boolean" }, "active_deal_id": { "description": "Id сделки, привязанной к Торгам (аукциону)", "format": "uuid", "type": "string" }, "auction_id": { "description": "Id Торгов (аукциона)", "example": "2fb965f2-85e9-4213-90e7-f396e47219e7", "format": "uuid", "type": "string" }, "auction_rates": { "description": "Список ставок по Торгам (аукциону)", "items": { "$ref": "#/components/schemas/AuctionRateOfLoadOwner" }, "type": "array" }, "auction_restart_parameters": { "$ref": "#/components/schemas/AuctionRestartParams" }, "auto_renew": { "description": "Автопродление Торгов (аукциона) при выставлении ставки в последние 5 минут до окончания Торгов (аукциона)", "example": false, "type": "boolean" }, "currency": { "description": "Валюта ставки на груз", "example": 1, "format": "int32", "type": "integer" }, "current_rate_with_nds": { "description": "Текущая ставка с НДС", "example": 25000, "format": "double", "type": "number" }, "current_rate_without_nds": { "description": "Текущая ставка без НДС", "example": 20000, "format": "double", "type": "number" }, "deleted": { "description": "Аукцион помечен удалённым - спустя некоторое время он автоматически удалится полностью", "example": true, "type": "boolean" }, "docs_expired_date": { "description": "Время окончания подачи документов (только для победителя)", "format": "date-time", "type": "string" }, "duration": { "description": "Длительность Торгов (аукциона) в минутах", "format": "int32", "type": "integer" }, "end_date": { "description": "Время окончания Торгов (аукциона)", "example": "2019-03-11T10:08:03.2530000+00:00", "format": "date-time", "type": "string" }, "end_date_boundary": { "description": "Время окончания Торгов (аукциона), после которого они автоматически завершаются, если нет автопродления", "example": "2019-05-21T15:15:10.8370000+00:00", "format": "date-time", "type": "string" }, "finish_type": { "$ref": "#/components/schemas/AuctionFinishType" }, "finished": { "description": "Завершены ли Торги (аукцион)", "example": true, "type": "boolean" }, "is_docs_expired": { "description": "Время подачи документов истекло (только для победителя)", "type": "boolean" }, "load_id": { "description": "Id груза, для которого активны Торги (аукцион)", "example": "2fb965f2-85e9-4213-90e7-f396e47219e7", "format": "uuid", "type": "string" }, "max_rate": { "description": "Максимально допустимая ставка по Торгам (аукциону) при автоповышении (RaiseBid = true)", "format": "double", "type": "number" }, "max_renew_time": { "description": "Максимально допустимое время, на которое сдвигается окончание Торгов (аукциона) при включённом AutoRenew (в минутах)", "format": "int32", "type": "integer" }, "nds": { "description": "Ставка НДС", "format": "double", "type": "number" }, "next_rate_with_nds": { "description": "Следующая возможная ставка с НДС", "format": "double", "type": "number" }, "next_rate_without_nds": { "description": "Следующая возможная ставка без НДС", "format": "double", "type": "number" }, "participants_count": { "description": "Количество участников", "example": 2, "format": "int32", "type": "integer" }, "raise_bid": { "description": "Автоповышение ставки на Шаг (step), если нет предложений", "type": "boolean" }, "raise_bid_interval": { "description": "Период увеличения ставки в минутах при автоповышении (RaiseBid = true)", "format": "int32", "type": "integer" }, "refuse_bet_prohibited": { "description": "Отмена ставки запрещена", "example": true, "type": "boolean" }, "renew_time": { "description": "Время, на которое сдвигается окончание Торгов (аукциона) при включённом AutoRenew (в минутах)", "example": 3, "format": "int32", "type": "integer" }, "response_in_minutes": { "description": "Количество минут с момента начала Торгов (аукциона) (StartDate), после которых возможно принимать встречные предложения", "format": "int32", "type": "integer" }, "response_prohibited": { "description": "Встречные предложения запрещены", "example": true, "type": "boolean" }, "server_date": { "description": "Серверное время. Для синхронизации Торгов (аукциона)", "example": "2019-06-04T18:24:45.7898742+00:00", "format": "date-time", "type": "string" }, "start_date": { "description": "Время начала Торгов (аукциона)", "example": "2019-03-11T10:05:03.7900000+00:00", "format": "date-time", "type": "string" }, "start_since_first_bet": { "description": "Длительность Торгов (аукциона) отсчитывается с момента первой ставки", "type": "boolean" }, "state": { "$ref": "#/components/schemas/AuctionState" }, "step": { "description": "Шаг изменения ставки Торгов (аукциона)", "example": 1000, "format": "double", "type": "number" }, "time_to_provide_documents": { "description": "Время на предоставление перевозчиком данных для заявки (в часах)", "format": "double", "type": "number" }, "win_date": { "description": "Время выигрыша ставки (только для победителя)", "format": "date-time", "type": "string" }, "winner_criterion": { "$ref": "#/components/schemas/WinnerCriteria" } }, "required": [ "auction_id", "auto_renew", "currency", "deleted", "finished", "load_id", "participants_count", "server_date", "start_date", "step" ], "type": "object" }, "AuctionOfTaker": { "description": "Торги (аукцион) для перевозчика", "properties": { "auction_id": { "description": "Id Торгов (аукциона)", "example": "2fb965f2-85e9-4213-90e7-f396e47219e7", "format": "uuid", "type": "string" }, "currency": { "description": "Валюта ставки на груз", "example": 1, "format": "int32", "type": "integer" }, "current_rate_with_nds": { "description": "Текущая ставка с НДС", "example": 25000, "format": "double", "type": "number" }, "current_rate_without_nds": { "description": "Текущая ставка без НДС", "example": 20000, "format": "double", "type": "number" }, "end_date": { "description": "Время окончания Торгов (аукциона)", "example": "2019-03-11T10:08:03.2530000+00:00", "format": "date-time", "type": "string" }, "finished": { "description": "Завершены ли Торги (аукцион)", "example": true, "type": "boolean" }, "is_our_rate_best": { "description": "Ставка лучшая в незавершенных Торгах (аукционе) (в завершенных - не отображается)", "type": "boolean" }, "load_id": { "description": "Id груза, для которого активны Торги (аукцион)", "example": "2fb965f2-85e9-4213-90e7-f396e47219e7", "format": "uuid", "type": "string" }, "next_rate_with_nds": { "description": "Следующая возможная ставка с НДС", "format": "double", "type": "number" }, "next_rate_without_nds": { "description": "Следующая возможная ставка без НДС", "format": "double", "type": "number" }, "our_rate": { "$ref": "#/components/schemas/AuctionRateOfTaker" }, "participants_count": { "description": "Количество участников", "example": 2, "format": "int32", "type": "integer" }, "refuse_bet_prohibited": { "description": "Отмена ставки запрещена", "example": true, "type": "boolean" }, "response_prohibited": { "description": "Встречные предложения запрещены", "example": true, "type": "boolean" }, "server_date": { "description": "Серверное время. Для синхронизации Торгов (аукциона)", "example": "2019-06-04T18:24:45.7898742+00:00", "format": "date-time", "type": "string" }, "start_date": { "description": "Время начала Торгов (аукциона)", "example": "2019-03-11T10:05:03.7900000+00:00", "format": "date-time", "type": "string" }, "winner_criterion": { "$ref": "#/components/schemas/WinnerCriteria" } }, "required": [ "auction_id", "currency", "finished", "load_id", "participants_count", "server_date", "start_date" ], "type": "object" }, "AuctionOfTakerWinner": { "description": "Торги (аукцион) для победителя", "properties": { "active_deal_id": { "description": "Id сделки, привязанной к Торгам (аукциону)", "format": "uuid", "type": "string" }, "auction_id": { "description": "Id Торгов (аукциона)", "example": "2fb965f2-85e9-4213-90e7-f396e47219e7", "format": "uuid", "type": "string" }, "currency": { "description": "Валюта ставки на груз", "example": 1, "format": "int32", "type": "integer" }, "current_rate_with_nds": { "description": "Текущая ставка с НДС", "example": 25000, "format": "double", "type": "number" }, "current_rate_without_nds": { "description": "Текущая ставка без НДС", "example": 20000, "format": "double", "type": "number" }, "docs_expired_date": { "description": "Время окончания подачи документов (только для победителя)", "format": "date-time", "type": "string" }, "end_date": { "description": "Время окончания Торгов (аукциона)", "example": "2019-03-11T10:08:03.2530000+00:00", "format": "date-time", "type": "string" }, "finished": { "description": "Завершены ли Торги (аукцион)", "example": true, "type": "boolean" }, "is_docs_expired": { "description": "Время подачи документов истекло (только для победителя)", "type": "boolean" }, "load_id": { "description": "Id груза, для которого активны Торги (аукцион)", "example": "2fb965f2-85e9-4213-90e7-f396e47219e7", "format": "uuid", "type": "string" }, "our_rate": { "$ref": "#/components/schemas/AuctionRateOfTaker" }, "participants_count": { "description": "Количество участников", "example": 2, "format": "int32", "type": "integer" }, "refuse_bet_prohibited": { "description": "Отмена ставки запрещена", "example": true, "type": "boolean" }, "response_prohibited": { "description": "Встречные предложения запрещены", "example": true, "type": "boolean" }, "server_date": { "description": "Серверное время. Для синхронизации Торгов (аукциона)", "example": "2019-06-04T18:24:45.7898742+00:00", "format": "date-time", "type": "string" }, "start_date": { "description": "Время начала Торгов (аукциона)", "example": "2019-03-11T10:05:03.7900000+00:00", "format": "date-time", "type": "string" }, "time_to_provide_documents": { "description": "Время на предоставление перевозчиком данных для заявки (в часах)", "format": "double", "type": "number" }, "win_date": { "description": "Время выигрыша ставки (только для победителя)", "format": "date-time", "type": "string" }, "winner_criterion": { "$ref": "#/components/schemas/WinnerCriteria" } }, "required": [ "auction_id", "currency", "finished", "load_id", "participants_count", "server_date", "start_date" ], "type": "object" }, "AuctionRateBetStatus": { "description": "Статус выставленной ставки\r\n\r\n* `0` - Ставка выставлена\r\n* `1` - Ставка выставлена и Торги (аукцион) завершены\r\n* `2` - Ставка не выставлена, поскольку Торги (аукцион) не найдены\r\n* `3` - Ставка не выставлена, поскольку она не лучшая\r\n* `4` - Ставка выставлена минимальная, но Торги (аукцион) не завершены\r\n* `5` - Ставка выставлена и Торги (аукцион) продлены\r\n* `6` - Ставка не выставлена, поскольку торги завершены", "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "format": "int32", "type": "integer" }, "AuctionRateOfLoadOwner": { "description": "Для вывода грузовладельцу ставки в списке", "properties": { "added_at": { "description": "Дата добавления", "format": "date-time", "type": "string" }, "ati_id": { "description": "Фирма, поставившая ставку", "type": "string" }, "auction_rate_id": { "description": "Id ставки", "format": "uuid", "type": "string" }, "contact_id": { "description": "Контакт", "format": "int32", "type": "integer" }, "loading_date": { "description": "Ближайшая возможная для перевозчика дата загрузки. Используется только в Торгах с критерием победы по ставке и дате загрузки", "format": "date-time", "type": "string" }, "rate_with_nds": { "description": "Ставка c НДС на груз, выставленная перевозчиком", "format": "double", "type": "number" }, "rate_without_nds": { "description": "Ставка без НДС на груз, выставленная перевозчиком", "format": "double", "type": "number" }, "source": { "$ref": "#/components/schemas/RateSource" }, "state": { "$ref": "#/components/schemas/AuctionRateState" } }, "required": [ "added_at", "ati_id", "auction_rate_id", "contact_id", "state" ], "type": "object" }, "AuctionRateOfTaker": { "description": "Выставленная ставка", "properties": { "added_at": { "description": "Дата добавления", "format": "date-time", "type": "string" }, "auction_rate_id": { "description": "Id ставки", "format": "uuid", "type": "string" }, "contact_id": { "description": "Контакт", "format": "int32", "type": "integer" }, "loading_date": { "description": "Ближайшая возможная для перевозчика дата загрузки. Используется только в Торгах с критерием победы по ставке и дате загрузки", "format": "date-time", "type": "string" }, "rate_with_nds": { "description": "Ставка c НДС на груз, выставленная перевозчиком", "format": "double", "type": "number" }, "rate_without_nds": { "description": "Ставка без НДС на груз, выставленная перевозчиком", "format": "double", "type": "number" }, "state": { "$ref": "#/components/schemas/AuctionRateState" } }, "required": [ "added_at", "auction_rate_id", "contact_id", "state" ], "type": "object" }, "AuctionRateOfTakerDto": { "description": "Для внесения ставки грузоперевозчиком", "properties": { "auction_id": { "description": "Id аукциона", "format": "uuid", "type": "string" }, "loading_date": { "description": "Ближайшая возможная для перевозчика дата загрузки. Используется только в Торгах с критерием победы по ставке и дате загрузки", "format": "date-time", "type": "string" }, "payment_type": { "$ref": "#/components/schemas/AuctionPaymentType" }, "rate": { "description": "Ставка на груз, поставленная перевозчиком", "format": "double", "type": "number" } }, "required": [ "auction_id", "payment_type", "rate" ], "type": "object" }, "AuctionRateStatusOfTaker": { "description": "Статус ставки после выставления", "properties": { "auction": { "$ref": "#/components/schemas/AuctionOfTaker" }, "auction_end_date": { "description": "Параметр устарел, используйте auction.end_date. Дата окончания Торгов (аукциона).", "example": "2019-03-11T10:08:03.2530000+00:00", "format": "date-time", "type": "string" }, "result_status": { "$ref": "#/components/schemas/AuctionRateBetStatus" } }, "type": "object" }, "AuctionRestartParams": { "description": "Параметры перезапуска торгов", "properties": { "auction_finish_action": { "$ref": "#/components/schemas/AuctionFinishAction" }, "current_change_winner_count": { "description": "Оставшееся количество попыток выбора нового победителя", "format": "int32", "type": "integer" }, "current_restart_count": { "description": "Оставшееся количество попыток перезапуска торгов", "format": "int32", "type": "integer" }, "duration_after_restart": { "description": "Длительность торгов в минутах после перезапуска", "format": "int32", "type": "integer" }, "init_change_winner_count": { "description": "Начальное количество попыток выбора нового победителя", "format": "int32", "type": "integer" }, "init_restart_count": { "description": "Начальное количество попыток перезапуска торгов", "format": "int32", "type": "integer" }, "is_manually_restarted": { "description": "Параметр, показывающий, был ли последний перезапуск выбран вручную", "type": "boolean" }, "rate_increase": { "description": "Повышение ставки при перезапуске", "format": "double", "type": "number" }, "rate_increase_option": { "$ref": "#/components/schemas/RateIncreaseOption" } }, "type": "object" }, "RateIncreaseOption": { "description": "Способ повышения ставки\r\n* `1` — Повышение ставки в валюте\r\n* `2` — Повышение ставки в процентах", "enum": [ 1, 2 ], "format": "int32", "type": "integer" }, "RateSource": { "description": "Система, на стороне которой сделана ставка", "enum": [ 0, 1 ], "format": "int32", "type": "integer" } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Authorization: Bearer {authorizationToken}" }, "JWT": { "description": "Bearer {access_token}", "in": "header", "name": "Authorization", "type": "apiKey" } } } }