{ "openapi": "3.0.0", "info": { "title": "usecases/cargoowner/findcarrier", "version": "1.0.0" }, "servers": [ { "url": "/" }, { "url": "https://api.ati.su" } ], "security": [ { "BearerAuth": [] } ], "paths": { "/v1.0/loads/new/{loadId}/responses": { "get": { "tags": [ "Новая структура отзывов" ], "summary": "Получение отзывов на конкретный груз фирмы.\nНа данный момент можно получить только встречные предложения.", "description": "Если груз твой, то вернутся все отзывы на твой груз с полной информацией.\nЕсли груз чужой, то вернутся все отзывы на этот груз, но все отзывы, кроме твоего, будут иметь в поле FirmInfo.Contact значение null.", "operationId": "NewLoadResponses_GetResponsesForLoadAll", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "ID груза", "schema": { "type": "string", "format": "guid" }, "x-position": 1 }, { "name": "dateFrom", "in": "query", "description": "Дата в UTC, начиная с которой необходимо показывать отзывы. Если ничего не передано, значит показываем абсолютно все отзывы.\nЕсли не передать модификатор часового пояса, дата отправляется в формате UTC+3 (Москва)\n ", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Массив отзывов", "content": { "application/json": { "schema": { "type": "array", "items": { "$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.0/loads/new/responses": { "get": { "tags": [ "Новая структура отзывов" ], "summary": "Получение встречных предложений на грузы фирмы с одной или несколькими ставками .", "operationId": "NewLoadResponses_GetResponsesForAllLoadsAll", "parameters": [ { "name": "dateFrom", "in": "query", "description": "Дата в UTC, начиная с которой необходимо показывать отзывы. Если ничего не передано, значит показываем абсолютно все отзывы.\nЕсли не передать модификатор часового пояса, дата отправляется в формате UTC+3 (Москва)\n ", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Массив отзывов на все грузы фирмы", "content": { "application/json": { "schema": { "type": "array", "items": { "$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/counter_offer": { "post": { "tags": [ "Персональные приглашения" ], "summary": "Отправка приглашения по встречному предложению", "description": "Отправляет приглашение оформить заказ грузоперевозчику по встречному предложению", "operationId": "PersonalInvitations_CounterOfferInvite", "requestBody": { "x-name": "dto", "description": "Параметры приглашения", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PersonalOfferInvitationDTO" } ] } } }, "x-position": 1 }, "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": [] } ] } }, "/v1.2/orders/invites": { "post": { "tags": [ "Персональные приглашения" ], "summary": "Отправка приглашения", "description": "Отправляет приглашение оформить заказ грузоперевозчику с оповещением\n \n*Отправленное повторно приглашение удалит предыдущее*", "operationId": "PersonalInvitations_Invite", "requestBody": { "x-name": "dto", "description": "Параметры приглашения", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PersonalInvitationDTO" } ] } } }, "x-position": 1 }, "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": [] } ] } }, "/v1.2/auction/bet/win/{auctionRateId}": { "post": { "parameters": [ { "description": "Id ставки Торгов (аукциона) (выбирается одна из ставок со статусами state=[0,-3]) устанавливается победной (со статусом state=1)", "in": "path", "name": "auctionRateId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "accept_second_pay_type": true, "active_deal_id": "c7ba865c-6dd2-43e4-bb29-66df7583989a", "auction_id": "c771ed18-84e4-4ab8-8f91-1be412274d86", "auction_rates": [ { "added_at": "2023-04-24T11:31:52.0690515Z", "ati_id": "12345", "auction_rate_id": "5a2e6b1c-b02a-45b0-9136-f64a9236ab21", "contact_id": 0, "loading_date": null, "rate_with_nds": 5500, "rate_without_nds": 6600, "source": 0, "state": 0 }, { "added_at": "2023-04-24T11:32:52.0690605Z", "ati_id": "33345", "auction_rate_id": "cd342abc-ac8d-4b08-87d3-def8f125b28d", "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:52.0690757Z", "duration": 6, "end_date": "2023-04-24T11:36:52.0690878Z", "end_date_boundary": "2023-04-24T11:36:52.0690866Z", "finish_type": 0, "finished": true, "is_docs_expired": false, "load_id": "a86db870-967e-4893-b6e1-fef16c73b054", "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:52.069361Z", "start_date": "2023-04-24T11:30:52.0690743Z", "start_since_first_bet": false, "state": 0, "step": 500, "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:52.0690844Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfLoadOwner" } }, "text/json": { "examples": { "response": { "value": { "accept_second_pay_type": true, "active_deal_id": "c7ba865c-6dd2-43e4-bb29-66df7583989a", "auction_id": "c771ed18-84e4-4ab8-8f91-1be412274d86", "auction_rates": [ { "added_at": "2023-04-24T11:31:52.0690515Z", "ati_id": "12345", "auction_rate_id": "5a2e6b1c-b02a-45b0-9136-f64a9236ab21", "contact_id": 0, "loading_date": null, "rate_with_nds": 5500, "rate_without_nds": 6600, "source": 0, "state": 0 }, { "added_at": "2023-04-24T11:32:52.0690605Z", "ati_id": "33345", "auction_rate_id": "cd342abc-ac8d-4b08-87d3-def8f125b28d", "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:52.0690757Z", "duration": 6, "end_date": "2023-04-24T11:36:52.0690878Z", "end_date_boundary": "2023-04-24T11:36:52.0690866Z", "finish_type": 0, "finished": true, "is_docs_expired": false, "load_id": "a86db870-967e-4893-b6e1-fef16c73b054", "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:52.069361Z", "start_date": "2023-04-24T11:30:52.0690743Z", "start_since_first_bet": false, "state": 0, "step": 500, "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:52.0690844Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfLoadOwner" } }, "text/plain": { "examples": { "response": { "value": { "accept_second_pay_type": true, "active_deal_id": "c7ba865c-6dd2-43e4-bb29-66df7583989a", "auction_id": "c771ed18-84e4-4ab8-8f91-1be412274d86", "auction_rates": [ { "added_at": "2023-04-24T11:31:52.0690515Z", "ati_id": "12345", "auction_rate_id": "5a2e6b1c-b02a-45b0-9136-f64a9236ab21", "contact_id": 0, "loading_date": null, "rate_with_nds": 5500, "rate_without_nds": 6600, "source": 0, "state": 0 }, { "added_at": "2023-04-24T11:32:52.0690605Z", "ati_id": "33345", "auction_rate_id": "cd342abc-ac8d-4b08-87d3-def8f125b28d", "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:52.0690757Z", "duration": 6, "end_date": "2023-04-24T11:36:52.0690878Z", "end_date_boundary": "2023-04-24T11:36:52.0690866Z", "finish_type": 0, "finished": true, "is_docs_expired": false, "load_id": "a86db870-967e-4893-b6e1-fef16c73b054", "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:52.069361Z", "start_date": "2023-04-24T11:30:52.0690743Z", "start_since_first_bet": false, "state": 0, "step": 500, "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:52.0690844Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfLoadOwner" } } }, "description": "Торги (аукцион) грузовладельца" }, "403": { "description": "У вас нет доступа на установление победной ставки" }, "404": { "description": "Торги (аукцион) не найдены, либо груз не найден" } }, "tags": [ "Auctions" ], "summary": "Смена победителя Торгов (аукциона)" } } }, "components": { "schemas": { "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 ] }, "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 ] }, "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 ] }, "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": "Ключ ошибки" } } }, "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": "Буквенный код страны" } } }, "PersonalInvitationDTO": { "type": "object", "additionalProperties": false, "required": [ "load_id", "taker_ati_id", "taker_contacts_list", "payment" ], "properties": { "load_id": { "type": "string", "description": "Id груза", "format": "guid", "minLength": 1, "example": "7a48a9d3-55cb-48a2-8527-35ff461eeb8c" }, "taker_ati_id": { "type": "string", "description": "Id аккаунта приглашаемой фирмы", "minLength": 1, "example": "14612" }, "taker_contacts_list": { "type": "array", "description": "Список контактов приглашаемой фирмы", "example": [ 0, 2, 5 ], "items": { "type": "integer", "format": "int32" } }, "payment": { "description": "Параметры оплаты заказа. Обязательно указание хотя бы одной ставки и валюты для неё.", "oneOf": [ { "$ref": "#/components/schemas/PersonalInvitationPaymentDTO" } ] }, "cancel_after_in_minutes": { "type": "integer", "description": "Через сколько минут отменить приглашение \"Оформить Заказ\".\nДопустимое значение от 1 до 4320 минут. По умолчанию - 4320 (3 суток)", "format": "int32", "deprecated": true, "x-deprecatedMessage": "удалить после выкладки ATIS-7844/ATIS-8074 и перехода приглашения из встречек на отдельный апи/указание точного времени", "nullable": true, "example": 60 }, "cancellation_date": { "type": "string", "description": "Дата отмены предложения на перевозку груза, формат ISO 8601", "format": "date-time", "nullable": true }, "is_tracking": { "type": "boolean", "description": "Запрос отслеживания через АТИ Водитель" } } }, "PersonalInvitationPaymentDTO": { "type": "object", "description": "Параметры оплаты заказа. Обязательно указание хотя бы одной ставки и валюты для неё.", "additionalProperties": false, "properties": { "price": { "type": "number", "description": "Сумма", "format": "decimal", "nullable": true, "example": 10000 }, "currency_id": { "type": "integer", "description": "ID валюты", "format": "int32", "nullable": true, "example": 32 }, "nds_price": { "type": "number", "description": "Сумма с НДС", "format": "decimal", "nullable": true }, "nds_currency_id": { "type": "integer", "description": "ID валюты c НДС", "format": "int32", "nullable": true }, "not_nds_price": { "type": "number", "description": "Сумма без НДС", "format": "decimal", "nullable": true }, "not_nds_currency_id": { "type": "integer", "description": "ID валюты без НДС", "format": "int32", "nullable": true } } }, "PersonalOfferInvitationDTO": { "type": "object", "additionalProperties": false, "properties": { "load_id": { "type": "string", "description": "Id груза", "format": "guid", "example": "7a48a9d3-55cb-48a2-8527-35ff461eeb8c" }, "response_id": { "type": "string", "description": "Id встречного приглашения.\nЗначение из метода [получения отзывов](https://ati.su/developers/api/loads/published/#get-v1.0-loads-new-responses)", "format": "guid", "example": "5026ffdd-4c2a-eb11-bb90-0025906a774d" }, "rate_types": { "type": "array", "description": "По каким ставкам отправить приглашение. \nТипы ставок:\n \n* `0` — наличные\n* `1` — б/нал с НДС\n* `2` — б/нал без НДС", "example": [ 0, 2 ], "items": { "$ref": "#/components/schemas/PriceType" } }, "cancel_after_in_minutes": { "type": "integer", "description": "Через сколько минут отменить приглашение \"Оформить Заказ\".\nДопустимое значение от 1 до 4320 минут. По умолчанию - 4320 (3 суток)", "format": "int32", "nullable": true, "example": 60 }, "is_auto": { "type": "boolean", "description": "Приглашение создано автоматически" }, "need_archive_on_invite": { "type": "boolean", "description": "Архивировать заявку при срабатывании автоматического приглашения" } } }, "PriceType": { "type": "integer", "description": "Тип ставки\n \n* `0` — наличные\n* `1` — б/нал с НДС\n* `2` — б/нал без НДС", "x-enumNames": [ "Cash", "CashlessWithNds", "CashlessWithoutNds" ], "enum": [ 0, 1, 2 ] }, "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" }, "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" }, "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": { "type": "apiKey", "description": "Bearer {access_token}", "name": "Authorization", "in": "header" } } } }