{ "openapi": "3.0.0", "info": { "title": "API Документация", "version": "1.0.0" }, "paths": { "/api/": {}, "/api/v1/supplier/registry": { "post": { "tags": [ "Реестр поставщиков привязанных к площадкам" ], "summary": "Добавление поставщика в ЕРП", "operationId": "2a526007e07eefe8db7c809b9c099186", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "supplierIinBin", "agreementTextBase64", "signature" ], "properties": { "supplierIinBin": { "description": "ИИН или БИН поставщика", "type": "string", "example": "123456789012" }, "agreementTextBase64": { "description": "Текст соглашения в формате Base64", "type": "string", "example": "U29tZSBiYXNlNjQgdGV4dA==" }, "signature": { "description": "Электронная подпись", "type": "string", "example": "Подпись12345" } }, "type": "object" } } } }, "responses": { "201": { "description": "Успешное выполнение операции", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Операция выполнена успешно" } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации или обработки данных", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Ошибка: некорректные данные" } }, "type": "object" } } } }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/supplier/info/{iin_bin}": { "get": { "tags": [ "Реестр поставщиков привязанных к площадкам" ], "summary": "Информация о конкретном поставщике в ЕРП", "operationId": "081afcc6d960bde1235750b472c882fd", "parameters": [ { "name": "iin_bin", "in": "path", "description": "ИИН или БИН поставщика", "required": true, "schema": { "type": "string", "example": "123456789012" } } ], "responses": { "200": { "description": "Успешное выполнение", "content": { "application/json": { "schema": { "properties": { "data": { "description": "Список поставщиков", "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "platformId": { "type": "integer", "example": 123 }, "platformName": { "type": "string", "example": "Platform Name" }, "platformDescription": { "type": "string", "example": "Описание платформы" }, "supplierIinBin": { "type": "string", "example": "123456789012" }, "supplierNameRu": { "type": "string", "example": "Название поставщика на русском" }, "supplierNameGos": { "type": "string", "example": "Название поставщика на казахском языке" }, "registryDate": { "type": "string", "format": "date-time", "example": "2024-01-01 10:00:00" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации или обработки данных", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Ошибка: некорректные данные" } }, "type": "object" } } } }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/supplier/list/": { "get": { "tags": [ "Реестр поставщиков привязанных к площадкам" ], "summary": "Список поставщиков ЕРП", "operationId": "0253d7b9e8596ac8fff570e1ae07c9e6", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "filter": { "properties": { "supplierIinBin": { "type": "array", "items": { "type": "string", "example": "123456789012" } } }, "type": "object" }, "limit": { "type": "integer", "minimum": 1, "example": 10 }, "page": { "type": "integer", "minimum": 1, "example": 1 } }, "type": "object" } } } }, "responses": { "200": { "description": "Успешное выполнение", "content": { "application/json": { "schema": { "properties": { "data": { "description": "Список поставщиков", "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "platformId": { "type": "integer", "example": 123 }, "platformName": { "type": "string", "example": "Platform Name" }, "platformDescription": { "type": "string", "example": "Описание платформы" }, "supplierIinBin": { "type": "string", "example": "123456789012" }, "supplierNameRu": { "type": "string", "example": "Название поставщика на русском" }, "supplierNameGos": { "type": "string", "example": "Название поставщика на казахском языке" }, "registryDate": { "type": "string", "format": "date-time", "example": "2024-01-01 10:00:00" } }, "type": "object" } }, "meta": { "description": "Метаданные пагинации", "properties": { "total": { "type": "integer", "example": 100 }, "count": { "type": "integer", "example": 10 } }, "type": "object" }, "links": { "description": "Ссылки пагинации", "properties": { "prev": { "type": "string", "example": "/api/v1/supplier/list?page=1&limit=10", "nullable": true }, "next": { "type": "string", "example": "/api/v1/supplier/list?page=3&limit=10", "nullable": true } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации или обработки данных", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Ошибка: некорректные данные" } }, "type": "object" } } } }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/distributors/registry": { "post": { "tags": [ "Дистрибьюторы" ], "summary": "Регистрация заявки на дистра", "operationId": "2def4ee40f9e4f85af01e2c8c82edc71", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "type", "companyIinBin", "products" ], "properties": { "type": { "description": "Тип дистрибьютора. Возможные значения: DISTRIBUTOR, SELF_DEALER, OTP", "type": "string", "example": "DISTRIBUTOR" }, "companyIinBin": { "description": "ИИН/БИН компании", "type": "string", "example": "123456789012" }, "products": { "type": "array", "items": { "required": [ "kztin", "regions" ], "properties": { "kztin": { "description": "Идентификатор товара", "type": "string", "example": "123456789012" }, "regions": { "type": "array", "items": { "description": "Идентификатор региона", "type": "string", "example": "123456789012" } } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "properties": { "appId": { "type": "string", "example": "123456789012" }, "registryAt": { "type": "string", "example": "2021-01-01 00:00:00" } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации фильтров" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/distributors/{app_id}/addDealer": { "post": { "tags": [ "Дистрибьюторы" ], "summary": "Добавление дилера", "operationId": "97894525321d2f14e39564b6cc639a21", "parameters": [ { "name": "app_id", "in": "path", "description": "Идентификатор дистрибьютора", "required": true, "schema": { "type": "integer", "example": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "kztin", "dealerIinBin", "products" ], "properties": { "kztin": { "description": "Идентификатор товара", "type": "string", "example": "123456789012" }, "dealerIinBin": { "description": "ИИН/БИН дилера", "type": "string", "example": "123456789012" }, "products": { "type": "array", "items": { "required": [ "kztin", "regions" ], "properties": { "kztin": { "description": "Идентификатор товара", "type": "string", "example": "123456789012" }, "regions": { "type": "array", "items": { "description": "Идентификатор региона", "type": "string", "example": "123456789012" } } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "properties": { "appId": { "type": "string", "example": "123456789012" }, "products": { "type": "array", "items": { "properties": { "kztin": { "type": "string", "example": "123456789012" }, "regions": { "type": "array", "items": { "type": "string", "example": "123456789012" } } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации фильтров" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/distributors/{app_id}/removeDealer": { "post": { "tags": [ "Дистрибьюторы" ], "summary": "Удаление дилера", "operationId": "306c3bf9f38fecba516cdba46aebcb02", "parameters": [ { "name": "app_id", "in": "path", "description": "Идентификатор дистрибьютора", "required": true, "schema": { "type": "integer", "example": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "kztin", "dealerIds" ], "properties": { "kztin": { "description": "Идентификатор товара", "type": "string", "example": "123456789012" }, "dealerIds": { "description": "Массив идентификаторов дилеров", "type": "array", "items": { "type": "integer", "example": 1 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "properties": { "kztin": { "type": "string", "example": "123456789012" }, "message": { "type": "string", "example": "Дилер успешно удален" } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации фильтров" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/distributors/info": { "get": { "tags": [ "Дистрибьюторы" ], "summary": "Получение информаии по товарам о дилерах и дистрах", "operationId": "84c547f026a4ebe85ba79e2dc1c4ab50", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "kztins", "limit" ], "properties": { "kztins": { "description": "Массив идентификаторов товаров", "type": "array", "items": { "type": "string", "example": "123456789012" } }, "limit": { "description": "Количество записей на странице", "type": "integer", "example": 10 } }, "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "kztins": { "type": "array", "items": { "type": "string", "example": "123456789012" } }, "distributors": { "type": "array", "items": { "properties": { "appId": { "type": "string", "example": "123456789012" }, "companyName": { "type": "string", "example": "Компания" }, "companyBinIin": { "type": "string", "example": "123456789012" }, "type": { "type": "string", "example": "Дистрибьютор" }, "hasRightAddDealer": { "type": "boolean", "example": true }, "dealers": { "type": "array", "items": { "properties": { "dealerId": { "type": "string", "example": "123456789012" }, "regions": { "type": "array", "items": { "type": "string", "example": "123456789012" } } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации фильтров" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/plans": { "get": { "tags": [ "Получение планов" ], "summary": "Получение планов", "operationId": "b082eccc03e992bf0ecee9c437fb51f6", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "filter": { "properties": { "ref_trade_methods_id": { "type": "array", "items": { "type": "integer", "example": 60 } }, "pln_point_year": { "type": "array", "items": { "type": "integer", "example": 2024 } }, "ref_subject_type_id": { "type": "integer", "example": 1 }, "ref_pln_point_status_id": { "type": "array", "items": { "type": "integer", "example": 2 } }, "is_active": { "type": "integer", "example": 1 }, "is_deleted": { "type": "integer", "example": 0 } }, "type": "object" }, "page": { "type": "integer", "example": 1 }, "limit": { "type": "integer", "example": 10 } }, "type": "object" } } } }, "responses": { "200": { "description": "Успешное выполнение", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "rootrecordId": { "type": "integer", "example": 123 }, "sysSubjectsId": { "type": "integer", "example": 456 }, "subjectBiin": { "type": "string", "example": "123456789012" }, "subjectNameRu": { "type": "string", "example": "Название субъекта на русском" }, "subjectNameKz": { "type": "string", "example": "Название субъекта на казахском" }, "nameRu": { "type": "string", "example": "План на русском" }, "nameKz": { "type": "string", "example": "План на казахском" }, "refTradeMethodsId": { "type": "integer", "example": 2 }, "refUnitsCode": { "type": "string", "example": "код" }, "count": { "type": "integer", "example": 5 }, "price": { "type": "number", "format": "float", "example": 100.5 }, "amount": { "type": "number", "format": "float", "example": 500 }, "refMonthsId": { "type": "integer", "example": 7 }, "refPlnPointStatusId": { "type": "integer", "example": 3 }, "plnPointYear": { "type": "integer", "example": 2024 }, "refSubjectTypeId": { "type": "integer", "example": 1 }, "refEnstruCode": { "type": "string", "example": "EN123" }, "descKz": { "type": "string", "example": "Описание на казахском" }, "descRu": { "type": "string", "example": "Описание на русском" }, "extraDescKz": { "type": "string", "example": "Дополнительное описание на казахском" }, "extraDescRu": { "type": "string", "example": "Дополнительное описание на русском" }, "supplyDateRu": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "disablePersonId": { "type": "integer", "example": 123 }, "systemId": { "type": "integer", "example": 456 }, "isPrimary": { "type": "boolean", "example": true }, "PlansKato": { "description": "Список мест доставки", "type": "array", "items": { "properties": { "id": { "description": "Идентификатор записи", "type": "integer", "example": 1 }, "plnPointsId": { "description": "Идентификатор точки плана", "type": "integer", "example": 123 }, "refKatoCode": { "description": "Код KATO", "type": "string", "example": "KATO123" }, "refCountriesCode": { "description": "Код страны", "type": "string", "example": "KZ" }, "fullDeliveryPlaceNameRu": { "description": "Полное название места доставки на русском", "type": "string", "example": "Полное название на русском" }, "fullDeliveryPlaceNameKz": { "description": "Полное название места доставки на казахском", "type": "string", "example": "Толық атау қазақша" }, "count": { "description": "Количество", "type": "integer", "example": 10 }, "isActive": { "description": "Активность записи", "type": "boolean", "example": true }, "isDeleted": { "description": "Флаг удаления", "type": "boolean", "example": false }, "systemId": { "description": "Идентификатор системы", "type": "integer", "example": 456 }, "indexDate": { "description": "Дата индексации", "type": "string", "format": "date-time", "example": "2024-01-01T10:00:00Z" } }, "type": "object" } } }, "type": "object" } }, "meta": { "properties": { "total": { "type": "integer", "example": 100 }, "count": { "type": "integer", "example": 10 } }, "type": "object" }, "links": { "properties": { "prev": { "type": "string", "example": "/api/v1/plans?page=1", "nullable": true }, "next": { "type": "string", "example": "/api/v1/plans?page=3", "nullable": true } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Неверные параметры запроса", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Неверные параметры запроса" } }, "type": "object" } } } }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/refs/ref_kato": { "get": { "tags": [ "Справочники" ], "summary": "Получение справочника КАТО", "operationId": "6db292d0b3f4cb3f6f8dd41b4e6ee341", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "page": { "type": "integer", "example": 1 }, "limit": { "type": "integer", "example": 10 } }, "type": "object" } } } }, "responses": { "200": { "description": "Успешное выполнение", "content": { "application/json": { "schema": { "properties": { "data": { "description": "Список записей справочника KATO", "type": "array", "items": { "properties": { "nameGos": { "type": "string", "example": "Название на государственном" }, "nameRu": { "type": "string", "example": "Название на русском" }, "level": { "type": "integer", "example": 1 }, "fullNameRu": { "type": "string", "example": "Полное название на русском" }, "fullNameGos": { "type": "string", "example": "Полное название на государственном" }, "code": { "type": "string", "example": "K123" }, "parentCode": { "type": "string", "example": "P123" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/refs/ref_enstru": { "get": { "tags": [ "Справочники" ], "summary": "Получение справочника ЕНСТРУ", "operationId": "78f63bcde9e4727c63e362c7a45e634e", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "page": { "type": "integer", "example": 1 }, "limit": { "type": "integer", "example": 10 } }, "type": "object" } } } }, "responses": { "200": { "description": "Успешное выполнение", "content": { "application/json": { "schema": { "properties": { "data": { "description": "Список записей справочника Enstru", "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "nameRu": { "type": "string", "example": "Название на русском" }, "nameGos": { "type": "string", "example": "Название на государственном" }, "code": { "type": "string", "example": "E123" }, "parentId": { "type": "integer", "example": 10 }, "level": { "type": "integer", "example": 1 }, "r": { "type": "string", "example": "r" }, "g": { "type": "string", "example": "g" }, "s": { "type": "string", "example": "s" }, "descRu": { "type": "string", "example": "Описание на русском" }, "descGos": { "type": "string", "example": "Описание на государственном" }, "mkei": { "type": "string", "example": "MKEI123" }, "edizm": { "type": "string", "example": "единица измерения" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/refs/rnu": { "get": { "tags": [ "Справочники" ], "summary": "Справочник РНУ", "operationId": "173bacf05d3444974c572432d9c65e9e", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "page": { "type": "integer", "example": 1 }, "limit": { "type": "integer", "example": 10 }, "filter": { "properties": { "supplierIinBin": { "type": "string", "example": "750421402532" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Успешное выполнение", "content": { "application/json": { "schema": { "properties": { "data": { "description": "Список записей справочника RNU", "type": "array", "items": { "description": "Информация о записи", "properties": { "id": { "description": "Идентификатор записи", "type": "integer", "example": 123 }, "pid": { "description": "Идентификатор родителя", "type": "integer", "example": 123 }, "supplierNameRu": { "description": "Название поставщика на русском", "type": "string", "example": "Товарищество с ограниченной ответственностью БИОЛОГИЯ МОРЯ" }, "supplierNameKz": { "description": "Название поставщика на казахском", "type": "string", "example": "БИОЛОГИЯ МОРЯ жауапкершілігі шектеулі серіктестігі" }, "supplierBiin": { "description": "БИН поставщика", "type": "string", "example": "123456789012" }, "supplierInnunp": { "description": "ИНН/УНП поставщика", "type": "string", "example": null, "nullable": true }, "systemId": { "description": "Идентификатор системы", "type": "integer", "example": 1 }, "startDate": { "description": "Дата начала", "type": "string", "format": "date-time", "example": "2023-07-31 00:00:00" }, "endDate": { "description": "Дата окончания", "type": "string", "format": "date-time", "example": "2025-07-31 00:00:00" }, "katoList": { "description": "Список KATO", "type": "array", "items": { "type": "integer" }, "example": [ 614830100 ] }, "indexDate": { "description": "Дата последнего обновления индекса", "type": "string", "format": "date-time", "example": "2024-10-04 09:41:57" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/refs/ref_enstru_national": { "get": { "tags": [ "Справочники" ], "summary": "Справочник нац изъятия", "operationId": "2de925e055044c93253b09e00a38db4e", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "page": { "type": "integer", "example": 1 }, "limit": { "type": "integer", "example": 10 }, "filter": { "properties": { "nationalCodes": { "type": "array", "items": { "type": "string", "example": "262013.000.000011" } } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Успешное выполнение", "content": { "application/json": { "schema": { "properties": { "data": { "description": "Список записей справочника Enstru National", "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "enstruCode": { "type": "string", "example": "EN123" }, "startDate": { "type": "string", "format": "date-time", "example": "2024-01-01" }, "endDate": { "type": "string", "format": "date-time", "example": "2024-12-31" }, "enstruTypeId": { "type": "integer", "example": 10 } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/refs/ref_units": { "get": { "tags": [ "Справочники" ], "summary": "Получение единиц измерения", "operationId": "4543b0f6bca6548d445aa9927233aeda", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "page": { "type": "integer", "example": 1 }, "limit": { "type": "integer", "example": 10 }, "filter": { "properties": { "code": { "type": "string", "example": "001" }, "alpha_code": { "type": "string", "example": "nm" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Успешное выполнение", "content": { "application/json": { "schema": { "properties": { "data": { "description": "Список записей справочника Units", "type": "array", "items": { "properties": { "code": { "type": "string", "example": "U123" }, "code2": { "type": "string", "example": "U12" }, "alphaCode": { "type": "string", "example": "UA" }, "nameRu": { "type": "string", "example": "Название на русском" }, "nameGos": { "type": "string", "example": "Название на государственном" }, "refSyncVer": { "type": "integer", "example": 1 }, "refSyncFlag": { "type": "boolean", "example": true }, "ord": { "type": "integer", "example": 5 }, "searchRu": { "type": "string", "example": "Поиск на русском" }, "searchGos": { "type": "string", "example": "Поиск на государственном" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/subjects": { "get": { "tags": [ "Справочники" ], "summary": "Реестр участников", "operationId": "077831759840a33122ba3fe7b94639c6", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "page": { "type": "integer", "example": 1 }, "limit": { "type": "integer", "example": 10 }, "biin": { "type": "string", "example": "123456789012" } }, "type": "object" } } } }, "responses": { "200": { "description": "Успешное выполнение", "content": { "application/json": { "schema": { "properties": { "data": { "description": "Список субъектов", "type": "array", "items": { "description": "Объект субъекта с динамическими полями, преобразованными в camelCase", "type": "object", "additionalProperties": true } }, "meta": { "description": "Метаданные пагинации", "properties": { "total": { "type": "integer", "example": 100 }, "count": { "type": "integer", "example": 10 } }, "type": "object" }, "links": { "description": "Ссылки пагинации", "properties": { "prev": { "type": "string", "example": "/api/v1/subjects?page=1&limit=10", "nullable": true }, "next": { "type": "string", "example": "/api/v1/subjects?page=3&limit=10", "nullable": true } }, "type": "object" } }, "type": "object" } } } }, "422": { "description": "Ошибка обработки запроса", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Ошибка: некорректные данные" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/subject_address/{pid}": { "get": { "tags": [ "Справочники" ], "summary": "Получение информации о адресе компании", "operationId": "ff804e532ae79ba71ecfcd32974c1cc5", "parameters": [ { "name": "pid", "in": "path", "description": "ID родителя", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Успешное выполнение", "content": { "application/json": { "schema": { "properties": { "id": { "description": "Идентификатор записи", "type": "integer", "example": 1 }, "pid": { "description": "Идентификатор субъекта", "type": "integer", "example": 123 }, "indexDate": { "description": "Дата индексации", "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "dateCreate": { "description": "Дата создания записи", "type": "string", "format": "date-time", "example": "2024-01-01T10:00:00Z" }, "editDate": { "description": "Дата последнего изменения", "type": "string", "format": "date-time", "example": "2024-01-02T10:00:00Z" }, "katoCode": { "description": "Код KATO", "type": "string", "example": "KATO123" }, "refSourceCode": { "description": "Код источника", "type": "string", "example": "SOURCE123" }, "addressType": { "description": "Тип адреса", "type": "string", "example": "Residential" }, "address": { "description": "Адрес", "type": "string", "example": "г. Астана, ул. Ленина, д. 10" }, "phone": { "description": "Контактный телефон", "type": "string", "example": "+77012345678" }, "systemId": { "description": "Идентификатор системы", "type": "integer", "example": 456 } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/notice": { "get": { "tags": [ "Уведомления" ], "summary": "Получение уведомлений", "operationId": "6d321a2bdc191c5dbcbbc6780bba55e7", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "dateFrom", "dateTo" ], "properties": { "dateFrom": { "description": "Дата начала диапазона фильтрации", "type": "string", "format": "date-time", "example": "2024-12-14 00:00:00.000000" }, "dateTo": { "description": "Дата конца диапазона фильтрации", "type": "string", "format": "date-time", "example": "2024-12-31 00:00:00.000000" }, "type": { "description": "Тип уведомления (код из справочника `ref_notification_types`)", "type": "string", "example": "CREATE_ORDER" } }, "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "createdAt": { "type": "string", "format": "date-time", "example": "2024-11-29 10:00:00" }, "type": { "type": "string", "example": "CREATE_ORDER" }, "link": { "type": "string", "example": "https://example.com/details/123" } }, "type": "object" } }, "meta": { "type": "array", "items": { "properties": { "total": { "type": "integer", "example": 123 }, "count": { "type": "integer", "example": 123 } }, "type": "object" } }, "links": { "type": "array", "items": { "properties": { "prev": { "type": "string", "example": "http://example.com" }, "next": { "type": "string", "example": "http://example.com" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации фильтров" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/order/offers": { "post": { "tags": [ "Подача ЦП" ], "summary": "Принятие ЦП", "operationId": "bcc266a83eeefd6329dbdb2ebf99f362", "requestBody": { "content": { "application/json": { "schema": { "required": [ "orderId", "plans" ], "properties": { "orderId": { "type": "integer", "example": 123 }, "plans": { "type": "array", "items": { "required": [ "planNumber", "products" ], "properties": { "planNumber": { "type": "integer", "example": 1 }, "products": { "type": "array", "items": { "required": [ "kztin", "offers" ], "properties": { "kztin": { "type": "string", "example": "123456789012" }, "offers": { "type": "array", "items": { "required": [ "supplierIinBin", "priceNoNds", "priceWithNds", "isNds", "publishedAt" ], "properties": { "supplierIinBin": { "type": "string", "example": "123456789012" }, "priceNoNds": { "type": "number", "format": "float", "example": 1000.5 }, "priceWithNds": { "type": "number", "format": "float", "example": 1200.6 }, "isNds": { "type": "boolean", "example": true }, "publishedAt": { "type": "string", "format": "date-time", "example": "2024-12-11 12:00:00" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Предложения успешно обработаны", "content": { "application/json": { "schema": { "properties": { "order_id": { "type": "integer", "example": 123 }, "accepted_offers": { "type": "array", "items": { "type": "string" } }, "rejected_offers": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/order/list": { "get": { "tags": [ "Заказы/Предзаказы" ], "summary": "Сведения о заказах", "operationId": "b035730d2c7f49ac132c00a1e183565f", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "perPage": { "description": "Количество элементов на странице", "type": "integer", "example": 10 }, "customerBinIin": { "description": "БИН/ИИН клиента", "type": "string", "example": "123456789012" }, "status": { "description": "Статус заказа", "type": "integer", "example": 1 }, "platformName": { "description": "Название платформы", "type": "string", "example": "Platform Name" }, "platformBin": { "description": "БИН платформы", "type": "string", "example": "123456789012" }, "orderId": { "description": "ID заказа", "type": "integer", "example": 123 }, "type": { "description": "Тип заказа", "type": "string", "enum": [ "order", "preorder" ], "example": "order" } }, "type": "object" } } } }, "responses": { "200": { "description": "Успешно получен список товаров", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 123 }, "type": { "type": "string", "enum": [ "order", "preorder" ], "example": "order" }, "preorderId": { "type": "integer", "example": 123 }, "status": { "type": "array", "items": { "properties": { "symbol_code": { "type": "string", "example": "abc" }, "nameRu": { "type": "string", "example": "Название на русском" }, "nameGos": { "type": "string", "example": "Название на казахском" } }, "type": "object" } }, "unitedLot": { "type": "boolean", "example": false }, "customer": { "properties": { "binIin": { "type": "string", "example": "123456789012" }, "nameGos": { "type": "string", "example": "Гос название" }, "nameRu": { "type": "string", "example": "Название на русском" }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" } }, "type": "object" }, "platform": { "properties": { "name": { "type": "string", "example": "Платформа" }, "binIin": { "type": "string", "example": "123456789012" } }, "type": "object" }, "plans": { "type": "array", "items": { "properties": { "planId": { "type": "integer", "example": 123 }, "rootRecordId": { "type": "integer", "example": 456 }, "enstru": { "type": "string", "example": "Example Enstru" }, "nameRu": { "type": "string", "example": "План на русском" }, "count": { "type": "number", "format": "float", "example": 10.5 }, "isDisableSign": { "type": "boolean", "example": false }, "isNationalExemption": { "type": "boolean", "example": false }, "purchaseType": { "type": "string", "example": "Тип закупки" }, "price": { "type": "number", "format": "float", "example": 100.5 }, "amount": { "type": "number", "format": "float", "example": 1050 }, "products": { "type": "array", "items": { "properties": { "nameRu": { "type": "string", "example": "Продукт на русском" }, "kztin": { "type": "string", "example": "KZ123456" }, "unitId": { "type": "integer", "example": 123 }, "additionServices": { "type": "array", "items": { "type": "string", "example": "service_code" } }, "deliveryPlaces": { "type": "array", "items": { "properties": { "kato": { "type": "string", "example": "KATO123" }, "count": { "type": "number", "format": "float", "example": 5 } }, "type": "object" } } }, "type": "object" } }, "deliveryInfo": { "type": "array", "items": { "properties": { "kato": { "type": "string", "example": "KATO123" }, "streetType": { "type": "string", "example": "Street" }, "address": { "type": "string", "example": "ул. Ленина" }, "houseNumber": { "type": "string", "example": "10" }, "apartmentNumber": { "type": "string", "example": "5" }, "recipientFullName": { "type": "string", "example": "Иван Иванов" }, "recipientPhoneNumber": { "type": "string", "example": "+77012345678" } }, "type": "object" } } }, "type": "object" } }, "decision": { "properties": { "supplierIinBin": { "type": "string", "example": "123456789012" }, "platformId": { "type": "integer", "example": 123 }, "platformName": { "type": "string", "example": "Platform Name" }, "deadline": { "type": "string", "format": "date-time", "example": "2024-01-01T23:59:59Z" }, "products": { "type": "array", "items": { "properties": { "planNumber": { "type": "integer", "example": 123 }, "kztin": { "type": "string", "example": "0123456789012" } }, "type": "object" } }, "status": { "type": "string", "example": "Approved" } }, "type": "object" }, "dates": { "properties": { "offerStartDate": { "type": "string", "format": "date-time", "example": "2024-01-01T09:00:00Z" }, "offerEndDate": { "type": "string", "format": "date-time", "example": "2024-01-10T18:00:00Z" }, "deadlineDate": { "type": "string", "format": "date-time", "example": "2024-01-20T23:59:59Z" } }, "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" } }, "type": "object" } }, "meta": { "type": "array", "items": { "properties": { "total": { "type": "integer", "example": 123 }, "count": { "type": "integer", "example": 123 } }, "type": "object" } }, "links": { "type": "array", "items": { "properties": { "prev": { "type": "string", "example": "http://example.com" }, "next": { "type": "string", "example": "http://example.com" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/order/{order}": { "get": { "tags": [ "Заказы/Предзаказы" ], "summary": "Просмотр заказа", "operationId": "c2c9e6b62393f9a42721f3924f6c4f04", "parameters": [ { "name": "order", "in": "path", "description": "Идентификатор заказа", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Успешно получен список товаров", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 123 }, "type": { "type": "string", "example": "order/preorder" }, "preorderId": { "type": "integer", "example": 123 }, "status": { "type": "array", "items": { "properties": { "symbol_code": { "type": "string", "example": "abc" }, "nameRu": { "type": "string", "example": "Название на русском" }, "nameGos": { "type": "string", "example": "Название на казахском" } }, "type": "object" } }, "unitedLot": { "type": "boolean", "example": false }, "customer": { "properties": { "binIin": { "type": "string", "example": "123456789012" }, "nameGos": { "type": "string", "example": "Гос название" }, "nameRu": { "type": "string", "example": "Название на русском" }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" } }, "type": "object" }, "platform": { "properties": { "name": { "type": "string", "example": "Платформа" }, "binIin": { "type": "string", "example": "123456789012" } }, "type": "object" }, "plans": { "type": "array", "items": { "properties": { "planId": { "type": "integer", "example": 123 }, "rootRecordId": { "type": "integer", "example": 456 }, "enstru": { "type": "string", "example": "Example Enstru" }, "nameRu": { "type": "string", "example": "План на русском" }, "count": { "type": "number", "format": "float", "example": 10.5 }, "isDisableSign": { "type": "boolean", "example": false }, "isNationalExemption": { "type": "boolean", "example": false }, "purchaseType": { "type": "string", "example": "Тип закупки" }, "price": { "type": "number", "format": "float", "example": 100.5 }, "amount": { "type": "number", "format": "float", "example": 1050 }, "products": { "type": "array", "items": { "properties": { "nameRu": { "type": "string", "example": "Продукт на русском" }, "kztin": { "type": "string", "example": "KZ123456" }, "unitId": { "type": "integer", "example": 123 }, "additionServices": { "type": "array", "items": { "type": "string", "example": "service_code" } }, "deliveryPlaces": { "type": "array", "items": { "properties": { "kato": { "type": "string", "example": "KATO123" }, "count": { "type": "number", "format": "float", "example": 5 } }, "type": "object" } } }, "type": "object" } }, "deliveryInfo": { "type": "array", "items": { "properties": { "kato": { "type": "string", "example": "KATO123" }, "streetType": { "type": "string", "example": "Street" }, "address": { "type": "string", "example": "ул. Ленина" }, "houseNumber": { "type": "string", "example": "10" }, "apartmentNumber": { "type": "string", "example": "5" }, "recipientFullName": { "type": "string", "example": "Иван Иванов" }, "recipientPhoneNumber": { "type": "string", "example": "+77012345678" } }, "type": "object" } } }, "type": "object" } }, "decision": { "properties": { "supplierIinBin": { "type": "string", "example": "123456789012" }, "platformId": { "type": "integer", "example": 123 }, "platformName": { "type": "string", "example": "Platform Name" }, "products": { "type": "array", "items": { "properties": { "planNumber": { "type": "integer", "example": 123 }, "kztin": { "type": "string", "example": "0123456789012" } }, "type": "object" } }, "deadline": { "type": "string", "format": "date-time", "example": "2024-01-01T23:59:59Z" }, "status": { "type": "string", "example": "Approved" } }, "type": "object" }, "dates": { "properties": { "offerStartDate": { "type": "string", "format": "date-time", "example": "2024-01-01T09:00:00Z" }, "offerEndDate": { "type": "string", "format": "date-time", "example": "2024-01-10T18:00:00Z" }, "deadlineDate": { "type": "string", "format": "date-time", "example": "2024-01-20T23:59:59Z" } }, "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" } }, "type": "object" } }, "meta": { "type": "array", "items": { "properties": { "total": { "type": "integer", "example": 123 }, "count": { "type": "integer", "example": 123 } }, "type": "object" } }, "links": { "type": "array", "items": { "properties": { "prev": { "type": "string", "example": "http://example.com" }, "next": { "type": "string", "example": "http://example.com" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/order/registry": { "post": { "tags": [ "Заказы/Предзаказы" ], "summary": "Создание заказа", "operationId": "28d4f09779b3258985f1c2c8cfcc8d22", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "orderCreatedDate", "customer", "orders" ], "properties": { "orderCreatedDate": { "type": "string", "format": "date-time", "example": "2024-01-01 10:00:00" }, "customer": { "required": [ "bin", "createdUserIin", "signature" ], "properties": { "bin": { "type": "string", "maxLength": 12, "minLength": 12, "example": "123456789012" }, "createdUserIin": { "type": "string", "maxLength": 12, "minLength": 12, "example": "123456789012" }, "signature": { "type": "string", "example": "signature_string" } }, "type": "object" }, "orders": { "type": "array", "items": { "required": [ "needPreorder", "unitedLot", "plans" ], "properties": { "needPreorder": { "type": "boolean", "example": true }, "unitedLot": { "type": "boolean", "example": false }, "plans": { "type": "array", "items": { "required": [ "planId", "planNumber", "deliveryInfo", "products" ], "properties": { "planId": { "type": "integer", "example": 1 }, "planNumber": { "type": "integer", "example": 123 }, "deliveryInfo": { "type": "array", "items": { "required": [ "kato", "streetTypeCode", "address", "recipientFullName", "recipientPhoneNumber" ], "properties": { "kato": { "type": "string", "example": "KATO123" }, "streetTypeCode": { "type": "string", "example": "ул" }, "address": { "type": "string", "example": "ул. Ленина" }, "houseNumber": { "type": "string", "example": "10", "nullable": true }, "apartmentNumber": { "type": "string", "example": "5", "nullable": true }, "recipientFullName": { "type": "string", "example": "Иван Иванов" }, "recipientPhoneNumber": { "type": "string", "example": "+77012345678" } }, "type": "object" } }, "products": { "type": "array", "items": { "required": [ "kztin", "unitId", "deliveryPlaces" ], "properties": { "kztin": { "type": "string", "example": "KZ123456" }, "unitId": { "type": "integer", "example": 123 }, "additionServiceCodes": { "type": "array", "items": { "type": "string", "example": "service_code" }, "nullable": true }, "deliveryPlaces": { "type": "array", "items": { "required": [ "kato", "cnt" ], "properties": { "kato": { "type": "string", "example": "KATO123" }, "cnt": { "type": "number", "format": "float", "example": 5 } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "201": { "description": "Операция выполнена успешно", "content": { "application/json": { "schema": { "properties": { "id": { "type": "integer", "example": 1 }, "plans": { "description": "Список планов", "type": "array", "items": { "properties": { "planId": { "type": "integer", "example": 1 }, "planNumber": { "type": "integer", "example": 123 } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/order/confirm": { "post": { "tags": [ "Заказы/Предзаказы" ], "summary": "Подтверждение заказа", "operationId": "16c0c7ebfb95c62f6826a74ddb606c6d", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "orderId", "supplierBinIin", "products" ], "properties": { "orderId": { "type": "integer", "example": 123 }, "supplierBinIin": { "type": "string", "example": "123456789012" }, "products": { "type": "array", "items": { "required": [ "kztin" ], "properties": { "kztin": { "type": "string", "example": "KZ123456" } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Успешное выполнение операции", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "success" }, "orderStatus": { "type": "integer", "example": 1 } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/order/reject": { "post": { "tags": [ "Заказы/Предзаказы" ], "summary": "Отклонение заказа", "operationId": "dc23799b7f0e57abb1ead33ee9b45d7c", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "orderId", "supplierBinIin", "rejectReasonCode" ], "properties": { "orderId": { "description": "Идентификатор заказа", "type": "integer", "example": 123 }, "supplierBinIin": { "description": "БИН/ИИН поставщика", "type": "string", "example": "123456789012" }, "rejectReasonCode": { "description": "Код причины отклонения", "type": "integer", "example": 1 } }, "type": "object" } } } }, "responses": { "200": { "description": "Успешное отклонение заказа", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "success" }, "orderStatus": { "description": "Текущий статус заказа", "type": "integer", "example": 2 } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/protocol/{protocol}": { "get": { "tags": [ "Заказы/Предзаказы" ], "summary": "Получение информации о ПИ", "operationId": "91602a662835ab721499d29ffa9271c9", "parameters": [ { "name": "protocol", "in": "path", "description": "ID протокола заказа", "required": true, "schema": { "type": "integer", "example": 123 } } ], "responses": { "200": { "description": "Успешное выполнение", "content": { "application/json": { "schema": { "properties": { "id": { "type": "integer", "example": 123 }, "orderId": { "type": "integer", "example": 456 }, "type": { "type": "string", "example": "protocol_type" }, "status": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Protocol Status" } }, "type": "object" }, "winner": { "properties": { "supplierId": { "type": "integer", "example": 123 }, "nameRu": { "type": "string", "example": "Название на русском" }, "nameGos": { "type": "string", "example": "Название на казахском языке" }, "binIin": { "type": "string", "example": "123456789012" }, "platform": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Platform Name" }, "description": { "type": "string", "example": "Описание платформы" } }, "type": "object" }, "orderAmountNoNds": { "type": "number", "format": "float", "example": 1000.5 }, "orderAmountWithNds": { "type": "number", "format": "float", "example": 1200.6 }, "publishDate": { "type": "string", "format": "date-time", "example": "2024-01-01T10:00:00Z" }, "platformPublishDate": { "type": "string", "format": "date-time", "example": "2024-01-01T10:00:00Z" }, "status": { "type": "string", "example": "confirmed" }, "statusUpdateDate": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00Z", "nullable": true }, "reason": { "properties": { "id": { "type": "integer", "example": 1 }, "text": { "type": "string", "example": "Причина отклонения" } }, "type": "object", "nullable": true }, "offers": { "type": "array", "items": { "properties": { "planNumber": { "type": "integer", "example": 555555 }, "priceNoNds": { "type": "number", "format": "float", "example": 500.5 }, "priceWithNds": { "type": "number", "format": "float", "example": 500.5 }, "quantity": { "type": "number", "format": "float", "example": 10.5 }, "kztin": { "type": "number", "format": "float", "example": "1111111111111" }, "amountNoNds": { "type": "number", "format": "float", "example": 500.5 }, "amountWithNds": { "type": "number", "format": "float", "example": 500.5 } }, "type": "object" } } }, "type": "object", "nullable": true }, "suppliers": { "type": "array", "items": { "properties": { "supplierId": { "type": "integer", "example": 123 }, "nameRu": { "type": "string", "example": "Название на русском" }, "nameGos": { "type": "string", "example": "Название на казахском языке" }, "binIin": { "type": "string", "example": "123456789012" }, "platform": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Platform Name" }, "description": { "type": "string", "example": "Описание платформы" } }, "type": "object" }, "orderAmountNoNds": { "type": "number", "format": "float", "example": 1000.5 }, "orderAmountWithNds": { "type": "number", "format": "float", "example": 1200.6 }, "publishDate": { "type": "string", "format": "date-time", "example": "2024-01-01T10:00:00Z" }, "platformPublishDate": { "type": "string", "format": "date-time", "example": "2024-01-01T10:00:00Z" }, "status": { "type": "string", "example": "confirmed" }, "statusUpdateDate": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00Z", "nullable": true }, "reason": { "properties": { "id": { "type": "integer", "example": 1 }, "text": { "type": "string", "example": "Причина отклонения" } }, "type": "object", "nullable": true }, "offers": { "type": "array", "items": { "properties": { "planNumber": { "type": "integer", "example": 555555 }, "priceNoNds": { "type": "number", "format": "float", "example": 500.5 }, "priceWithNds": { "type": "number", "format": "float", "example": 500.5 }, "quantity": { "type": "number", "format": "float", "example": 10.5 }, "kztin": { "type": "number", "format": "float", "example": "1111111111111" }, "amountNoNds": { "type": "number", "format": "float", "example": 500.5 }, "amountWithNds": { "type": "number", "format": "float", "example": 500.5 } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/preorder/{preorderId}": { "get": { "tags": [ "Заказы/Предзаказы" ], "summary": "Просмотр предзаказа", "operationId": "ab45b64b7d26dd05db64638d8f057d6a", "parameters": [ { "name": "preorderId", "in": "path", "description": "Идентификатор предзаказа", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Успешное выполнение", "content": { "application/json": { "schema": { "properties": { "preorderId": { "description": "Идентификатор предзаказа", "type": "integer", "example": 1 }, "unitedLot": { "description": "Объединённый лот", "type": "boolean", "example": false }, "purchaseType": { "description": "Тип закупки", "type": "string", "example": "Закупка" }, "status": { "description": "Статус предзаказа", "type": "string", "example": "Активный" }, "offerStartDate": { "description": "Дата начала подачи предложений", "type": "string", "format": "date-time", "example": "2024-01-01T10:00:00Z" }, "offerEndDate": { "description": "Дата окончания подачи предложений", "type": "string", "format": "date-time", "example": "2024-01-05T10:00:00Z" }, "offerList": { "description": "Список предложений", "type": "array", "items": { "properties": { "offerId": { "description": "Идентификатор предложения", "type": "integer", "example": 101 }, "supplierIinBin": { "description": "БИН/ИИН поставщика", "type": "string", "example": "123456789012" }, "supplierName": { "description": "Название поставщика", "type": "string", "example": "Название поставщика" }, "amountNoNds": { "description": "Сумма без НДС", "type": "number", "format": "float", "example": 1000.5 }, "amountWithNds": { "description": "Сумма с НДС", "type": "number", "format": "float", "example": 1200.6 }, "publishedAt": { "description": "Дата публикации предложения", "type": "string", "format": "date-time", "example": "2024-01-01 15:00:00" }, "platformId": { "description": "Идентификатор платформы", "type": "integer", "example": 10 }, "platformName": { "description": "Название платформы", "type": "string", "example": "Платформа" }, "products": { "description": "Список продуктов предложения", "type": "array", "items": { "properties": { "kztin": { "description": "Код продукта (KZTIN)", "type": "string", "example": "KZ123456" }, "productName": { "description": "Название продукта", "type": "string", "example": "Продукт 1" }, "planNumber": { "description": "Номер плана", "type": "integer", "example": 456 }, "unit_id": { "description": "Идентификатор единицы измерения", "type": "integer", "example": 1 }, "priceNoNds": { "description": "Цена без НДС", "type": "number", "format": "float", "example": 500.25 }, "priceWithNds": { "description": "Цена с НДС", "type": "number", "format": "float", "example": 600.3 }, "amountNoNds": { "description": "Сумма без НДС", "type": "number", "format": "float", "example": 1000.5 }, "amountWithNds": { "description": "Сумма с НДС", "type": "number", "format": "float", "example": 1200.6 } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "422": { "description": "Ошибка валидации" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/refs/orders/ref_street_types": { "get": { "tags": [ "Справочники" ], "summary": "Справочник типов улиц", "operationId": "71f083c127de5f9030869295538a2fa2", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "page": { "type": "integer", "example": 1 }, "limit": { "type": "integer", "example": 10 } }, "type": "object" } } } }, "responses": { "200": { "description": "Успешное выполнение", "content": { "application/json": { "schema": { "properties": { "data": { "description": "Список типов улиц", "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "nameRu": { "type": "string", "example": "Улица на русском" }, "shortNameRu": { "type": "string", "example": "Короткое название на русском" }, "nameGos": { "type": "string", "example": "Улица на казахском" }, "shortNameGos": { "type": "string", "example": "Короткое название на казахском" }, "code": { "type": "string", "example": "Код" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/refs/orders/ref_order_addition_services": { "get": { "tags": [ "Справочники" ], "summary": "Справочник доп услуг", "operationId": "1b71cfab8991dae06e85e407c085dc6a", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "page": { "type": "integer", "example": 1 }, "limit": { "type": "integer", "example": 10 } }, "type": "object" } } } }, "responses": { "200": { "description": "Успешное выполнение", "content": { "application/json": { "schema": { "properties": { "data": { "description": "Список дополнительных услуг", "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "code": { "type": "string", "example": "Код" }, "nameRu": { "type": "string", "example": "Название на русском" }, "nameGos": { "type": "string", "example": "Название на казахском" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/refs/orders/ref_order_reject_reasons": { "get": { "tags": [ "Справочники" ], "summary": "Справочник причин отклонения", "operationId": "a13e76c108a95f77e4d3e1d007029932", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "page": { "type": "integer", "example": 1 }, "limit": { "type": "integer", "example": 10 } }, "type": "object" } } } }, "responses": { "200": { "description": "Успешное выполнение", "content": { "application/json": { "schema": { "properties": { "data": { "description": "Список причин отклонения заказа", "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "nameRu": { "type": "string", "example": "Причина на русском" }, "nameGos": { "type": "string", "example": "Причина на казахском" }, "egzId": { "type": "integer", "example": 10 }, "penalties": { "type": "string", "example": "Штрафы" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Неавторизован" }, "500": { "description": "Внутренняя ошибка сервера" } }, "security": [ { "bearerAuth": [] } ] } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "description": "Введите Bearer токен для авторизации", "bearerFormat": "JWT", "scheme": "bearer" } } }, "tags": [ { "name": "Реестр поставщиков привязанных к площадкам", "description": "Реестр поставщиков привязанных к площадкам" }, { "name": "Дистрибьюторы", "description": "Дистрибьюторы" }, { "name": "Получение планов", "description": "Получение планов" }, { "name": "Справочники", "description": "Справочники" }, { "name": "Уведомления", "description": "Уведомления" }, { "name": "Подача ЦП", "description": "Подача ЦП" }, { "name": "Заказы/Предзаказы", "description": "Заказы/Предзаказы" } ] }