{ "openapi": "3.1.0", "info": { "title": "Документация по SelSup API", "description": "API SelSup — программный интерфейс для работы с сервисом SelSup. Даёт возможность работать со всеми функциями SelSup из вашей системы. Для использования API добавьте новый токен на странице:https://selsup.ru/application/integration/api. Добавленный токен необходимо передавать во всех запросах к API SelSup, в заголовке Authorization.", "contact": { "name": "Support Team", "email": "admin@selsup.ru" }, "license": { "name": "Apache 2.0", "url": "https://selsup.ru/dogovor-offerta/" }, "version": "1.0" }, "servers": [ { "url": "https://api.selsup.ru/", "description": "Production server" } ], "tags": [ { "name": "Аналитика", "description": "Методы для работы с аналитическими отчетами: товарный, финансовый по всем маркетплейсам. Лимит запросов: 1 запрос в минуту" } ], "paths": { "/api/stat/productHandOnPulse": { "get": { "tags": [ "Аналитика" ], "summary": "Получить отчет по-товарный Рука на пульсе", "description": "Получение данных из по-товарного Рука на пульсе по фильтру", "operationId": "getProductHandOnPulseReports", "parameters": [ { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "timeZone", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "productId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "productIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true } }, { "name": "allProductIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true } }, { "name": "query", "in": "query", "description": "Поисковый запрос. Может содержать штрих-код, часть названия товара, внешние идентификаторы товаров Wildberries или Ozon", "required": false, "schema": { "type": "string", "description": "Поисковый запрос. Может содержать штрих-код, часть названия товара, внешние идентификаторы товаров Wildberries или Ozon" } }, { "name": "dateFrom", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "dateTo", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } }, { "name": "organizationId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "date", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "description": "Ограничение на количество записей. Максимальное значение - 500", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Ограничение на количество записей. Максимальное значение - 500" } }, { "name": "page", "in": "query", "description": "Номер страницы начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Номер страницы начиная с 1" } }, { "name": "count", "in": "query", "description": "Возвратить в ответе общее количество записей", "required": false, "schema": { "type": "boolean", "description": "Возвратить в ответе общее количество записей" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки записей. Работает только при получении списка.", "required": false, "schema": { "type": "string", "description": "Поле сортировки записей. Работает только при получении списка." } }, { "name": "ascending", "in": "query", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка.", "required": false, "schema": { "type": "boolean", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка." } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/FindResponseProductHandOnPulseReport" } } } } } }, "put": { "tags": [ "Аналитика" ], "summary": "Обновить по-товарный отчет Рука на пульсе", "description": "Обновление по-товарный отчет Рука на пульсе", "operationId": "updateProductHandOnPulseReports", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductHandOnPulseReport" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "object" } } } } } } }, "/api/stat/updateSalePlanReport": { "post": { "tags": [ "Аналитика" ], "summary": "Сохранить план продаж", "description": "Метод сохраняет план продаж", "operationId": "updateSalePlanReport", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlanSales" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlanSales" } } } } } } } }, "/api/stat/saveSalePlanReport": { "post": { "tags": [ "Аналитика" ], "summary": "Сохранить план продаж", "description": "Метод сохраняет план продаж", "operationId": "saveSalePlanReport", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlanSales" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlanSales" } } } } } } } }, "/api/stat/realization/reload": { "get": { "tags": [ "Аналитика" ], "summary": "Подтянуть баллы озон из отчета по реализации", "description": "Получить с OZON данные по баллам", "operationId": "updateOzonBonus", "parameters": [ { "name": "month", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "year", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "organizationId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } }, "post": { "tags": [ "Аналитика" ], "summary": "Подтянуть баллы озон из отчета по реализации", "description": "Получить с OZON данные по баллам", "operationId": "updateOzonBonusTask", "parameters": [ { "name": "month", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "year", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "organizationId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/productHandOnPulse/reload": { "post": { "tags": [ "Аналитика" ], "summary": "Перерасчет отчета по-товарный Рука на пульсе", "operationId": "reloadProductHandOnPulseData", "parameters": [ { "name": "fullReload", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "organizationId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "timeZone", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/import": { "post": { "tags": [ "Аналитика" ], "summary": "Импорт отчета о реализации (multipart)", "description": "Метод принимает файл в формате multipart/form-data и создает задачу по импорту данных из файлов WB и OZON и SberMarket по реализации", "operationId": "importRealization", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } }, "required": [ "file" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/importProfitReportFromExcelFile": { "post": { "tags": [ "Аналитика" ], "summary": "Импорт Excel профит репорт", "description": "Создает задачу импорта Excel файла с данными реализации по МП.", "operationId": "importProfitReportFromExcelFile", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } }, "required": [ "file" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/importPlanSalesFromExcelFile": { "post": { "tags": [ "Аналитика" ], "summary": "Импорт Excel плана продаж", "description": "Создает задачу импорта Excel файла с понедельным планом продаж", "operationId": "importPlanSalesFromExcelFile", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } }, "required": [ "file" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/importFboOrders": { "post": { "tags": [ "Аналитика" ], "summary": "Импорт заказов FBO", "description": "Метод добавляет задачу в очередь на импорт заказов FBO", "operationId": "importFboOrders", "parameters": [ { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "organizationId", "in": "query", "description": "Идентификатор организации", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации" } }, { "name": "service", "in": "query", "description": "Маркетплейс", "required": false, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "filterOrders", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "uniqueItems": true } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/importBankTransactionFromFile": { "post": { "tags": [ "Аналитика" ], "summary": "Импорт выписки из банка", "description": "Метод принимает файл в формате multipart/form-data из банковской выписки операции с МП. Выписка из банка выгружается в формате 1C.", "operationId": "importBankTransactionFromFile", "parameters": [ { "name": "clientOrganizationId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "saveAll", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } }, "required": [ "file" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/import/binary": { "post": { "tags": [ "Аналитика" ], "summary": "Импорт отчета о реализации", "description": "Метод принимает файл в формате multipart/form-data и создает задачу по импорту данных из файлов WB и OZON и SberMarket по реализации", "operationId": "importRealization_1", "parameters": [ { "name": "name", "in": "query", "description": "Название файла", "required": true, "schema": { "type": "string" } }, { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/funnel/upload": { "post": { "tags": [ "Аналитика" ], "summary": "Загрузить данные по воронке продаж", "description": "Позволяет загрузить данные из ЛК МП по отчету Воронка продаж, которые не импортируются автоматически", "operationId": "uploadWbSalesFunnelData", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesFunnelReport" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "object" } } } } } } }, "/api/stat/deleteSalePlanById": { "post": { "tags": [ "Аналитика" ], "summary": "Удалить план продаж", "description": "Метод удаляет план продаж", "operationId": "deleteSalePlanById", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/stat/ai/tips": { "post": { "tags": [ "Аналитика" ], "summary": "Умный анализ финансов", "description": "Метод для возврата данных для отображения в блоке умного анализа финансов, сгенерированные с помощью AI. В теле запроса передается объект полученный из GET fullFinanceReport, чтобы не пересчитывать", "operationId": "getFindirTips", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComprehensiveFinanceAnalytics" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Tip" } } } } } } } }, "/api/stat/addDownloadHandOnPulseTask": { "post": { "tags": [ "Аналитика" ], "summary": "Excel рука на пульсе", "description": "Создает задачу на скачивание Excel файла с данными по товарной аналитике.Обязательно нужно передать в запросе dateTo, dateFrom.Не обязательные поля clientOrganizationId, serviceIds.Поле - period и productAnalyticField не используются.Добавлена возможность отсортировать список по полю sortBy и по порядку ascending.", "operationId": "addDownloadHandOnPulseTask", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/updatePurchasePriceTask": { "get": { "tags": [ "Аналитика" ], "summary": "Обновление закупочных цен в аналитике", "description": "Метод ставит в очередь задачу по обновлению закупочных цен и прочих расходов в аналитике по данным из товаров", "operationId": "updatePurchasePricesTask", "parameters": [ { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/supplyPlanReport/download": { "get": { "tags": [ "Аналитика" ], "summary": "Предрасчитанный Excel план поставок товаров", "description": "Создает задачу на скачивание Excel файла по предрасчитанному плану поставок товаров", "operationId": "downloadPreprocessedSupplyPlanReportTask", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/runImportStatTaskByClientOrganizationId": { "get": { "tags": [ "Аналитика" ], "summary": "Обновление остатков с маркетплейса", "description": "Метод ставит в очередь задачу по получению данных о продажах c ozon или wildberries по организации и запись их в отчет по операциям", "operationId": "runImportStatTaskByClientOrganizationId", "parameters": [ { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "service", "in": "query", "description": "Маркетплейс с которого обновить данные", "required": true, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/repeat-sales": { "get": { "tags": [ "Аналитика" ], "summary": "Отчет повторные продажи", "description": "Получение данных о повторных продажах по фильтру", "operationId": "getRepeatSalesReport", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/RepeatSalesReport" } } } } } } }, "/api/stat/reDownloadAnalytics": { "get": { "tags": [ "Аналитика" ], "summary": "Задача на перезакачку аналитики", "description": "Создает задачу на перезакачку аналитике по маркетплейсам.", "operationId": "reDownloadAnalytic", "parameters": [ { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/products": { "get": { "tags": [ "Аналитика" ], "summary": "Статистика по количеству созданных карточек", "description": "Метод для возврата статистики по количеству созданных карточек на маркетплейсах и в SelSup", "operationId": "getCreatedCardsStats", "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } } } } } } } }, "/api/stat/productAnalytics": { "get": { "tags": [ "Аналитика" ], "summary": "Товарная аналитика", "description": "Метод получает данные по товарной аналитике. Обязательно нужно передать в запросе dateTo, dateFrom, productAnalyticField.Не обязательные поля clientOrganizationId, serviceIds.Поле - period не используется.", "operationId": "getProductsAnalytics", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/FindResponseProductAnalytics" } } } } } } }, "/api/stat/nmReport": { "get": { "tags": [ "Аналитика" ], "summary": "Получить отчет Воронка продаж", "description": "Получение данных из воронки продаж по фильтру", "operationId": "getNmReports", "parameters": [ { "name": "dateFrom", "in": "query", "description": "Дата начала периода", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода", "example": "2024-03-01T00:00:00Z" }, "example": "2024-03-01T00:00:00Z" }, { "name": "dateTo", "in": "query", "description": "Дата окончания периода", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания периода", "example": "2024-03-31T23:59:59Z" }, "example": "2024-03-31T23:59:59Z" }, { "name": "pastDateFrom", "in": "query", "description": "Дата начала периода для сравнения. Если не указано - рассчитывается автоматически как предыдущий смежный период той же длины", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения. Если не указано - рассчитывается автоматически как предыдущий смежный период той же длины", "example": "2024-02-01T00:00:00Z" }, "example": "2024-02-01T00:00:00Z" }, { "name": "pastDateTo", "in": "query", "description": "Дата окончания периода для сравнения. Если не указано - рассчитывается автоматически как предыдущий смежный период той же длины", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания периода для сравнения. Если не указано - рассчитывается автоматически как предыдущий смежный период той же длины", "example": "2024-02-29T23:59:59Z" }, "example": "2024-02-29T23:59:59Z" }, { "name": "brandNames", "in": "query", "description": "Список названий брендов", "required": false, "schema": { "type": "array", "description": "Список названий брендов", "example": [ "Nike", "Adidas" ], "items": { "type": "string", "description": "Список названий брендов", "example": [ "Nike", "Adidas" ] } }, "example": [ "Nike", "Adidas" ] }, { "name": "objectIDs", "in": "query", "description": "Список ID предметов", "required": false, "schema": { "type": "array", "description": "Список ID предметов", "example": [ 123, 456 ], "items": { "type": "integer", "format": "int32", "description": "Список ID предметов", "example": [ 123, 456 ] } }, "example": [ 123, 456 ] }, { "name": "tagIDs", "in": "query", "description": "Список ID ярлыков", "required": false, "schema": { "type": "array", "description": "Список ID ярлыков", "example": [ 10, 20, 30 ], "items": { "type": "integer", "format": "int32", "description": "Список ID ярлыков", "example": [ 10, 20, 30 ] } }, "example": [ 10, 20, 30 ] }, { "name": "nmIDs", "in": "query", "description": "Список артикулов Wildberries, они же wildberriesId у view", "required": false, "schema": { "type": "array", "description": "Список артикулов Wildberries, они же wildberriesId у view", "example": [ 987654 ], "items": { "type": "integer", "format": "int32", "description": "Список артикулов Wildberries, они же wildberriesId у view", "example": [ 987654 ] } }, "example": [ 987654 ] }, { "name": "timezone", "in": "query", "description": "Временная зона. По умолчанию Europe/Moscow", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Временная зона. По умолчанию Europe/Moscow" } }, { "name": "organizationId", "in": "query", "description": "Идентификатор организации", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации" } }, { "name": "service", "in": "query", "description": "Сервис для которого получить данные", "required": false, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } }, { "name": "query", "in": "query", "description": "Поисковой запрос. Поиск идет по артикулу", "required": false, "schema": { "type": "string", "description": "Поисковой запрос. Поиск идет по артикулу" } }, { "name": "skipDeletedNm", "in": "query", "description": "Скрыть удалённые карточки товаров", "required": false, "schema": { "type": "boolean", "description": "Скрыть удалённые карточки товаров" } }, { "name": "limit", "in": "query", "description": "Ограничение на количество записей. Максимальное значение - 500", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Ограничение на количество записей. Максимальное значение - 500" } }, { "name": "page", "in": "query", "description": "Номер страницы начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Номер страницы начиная с 1" } }, { "name": "count", "in": "query", "description": "Возвратить в ответе общее количество записей", "required": false, "schema": { "type": "boolean", "description": "Возвратить в ответе общее количество записей" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки записей. Работает только при получении списка.", "required": false, "schema": { "type": "string", "description": "Поле сортировки записей. Работает только при получении списка." } }, { "name": "ascending", "in": "query", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка.", "required": false, "schema": { "type": "boolean", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка." } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/FindResponseSalesFunnelReport" } } } } } } }, "/api/stat/nmReport/reload": { "get": { "tags": [ "Аналитика" ], "summary": "Запускает обновление воронки продаж за максимальный период", "operationId": "reloadSalesFunnelReportData", "parameters": [ { "name": "organizationId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/mergeOrderFromProfitReports": { "get": { "tags": [ "Аналитика" ], "summary": "Создать FBO заказы из профит репортов", "description": "Создает задачу для создания новых FBO заказов из таблички профит репорта по МП Wildberries.", "operationId": "mergeOrderFromProfitReports", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/getUsersStats": { "get": { "tags": [ "Аналитика" ], "summary": "Данные о раскладке товаров операторами", "description": "Возвращает информацию о раскладке за период", "operationId": "getUsersStat", "parameters": [ { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/UsersStat" } } } } } } }, "/api/stat/getUsersJobStats": { "get": { "tags": [ "Аналитика" ], "summary": "Данные о выполненных работах", "description": "Возвращает информацию о количестве созданных карточек и добавленных в поставку товаров", "operationId": "getUserJobStats", "parameters": [ { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } }, { "name": "jobId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/UsersStat" } } } } } } }, "/api/stat/getTurnoverByContractorId": { "get": { "tags": [ "Аналитика" ], "summary": "Взаиморасчеты с поставщиками.", "description": "Метод получает данные оборота за период с контрагентом и сальдо.", "operationId": "getTurnoverByContractorId", "parameters": [ { "name": "request", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/AnalyticsRequest" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Turnover" } } } } } } } }, "/api/stat/getTotalSalePlanReport": { "get": { "tags": [ "Аналитика" ], "summary": "Получить весь план продаж", "description": "Метод возвращает общие данные по плану продаж", "operationId": "getTotalSalePlanReport", "parameters": [ { "name": "productAnalyticFields", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } } }, { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/FindResponsePlanSales" } } } } } } }, "/api/stat/getTaxes": { "get": { "tags": [ "Аналитика" ], "summary": "Налоги", "description": "Метод возвращает данные о предполагаемом налоге с продаж.", "operationId": "getTaxe", "parameters": [ { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Taxes" } } } } } } } }, "/api/stat/getStructureTurnoverByContractorId": { "get": { "tags": [ "Аналитика" ], "summary": "Структура расчетов с поставщиками.", "description": "Метод получает структуру оплат за период с контрагентом.", "operationId": "getStructureTurnoverByContractorId", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/FindResponsePaymentStructure" } } } } } } }, "/api/stat/getStatOrderAndSales": { "get": { "tags": [ "Аналитика" ], "summary": "Статистика по заказам и выручке", "description": "Возвращает статистику по заказам и выручку по фильтру", "operationId": "getStatOrderAndSales", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ProductStats" } } } } } } }, "/api/stat/getServiceStructure": { "get": { "tags": [ "Аналитика" ], "summary": "Структура услуг", "description": "Метод получает данные по структуре услуг.Обязательно нужно передать в запросе dateTo, dateFromНе обязательные поля clientOrganizationId, serviceIds", "operationId": "getServicesStructure", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RowStructureForFinanceTable" } } } } } } } }, "/api/stat/getSalesReportForGraphic": { "get": { "tags": [ "Аналитика" ], "summary": "График по продажам", "description": "Метод возвращает данные о продажах и возвратах и группирует их по сервисам.Обязательно передать dateFrom, dateToне обязательные поля clientOrganizationId, services", "operationId": "getSalesReportsForGraphic", "parameters": [ { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesReportForGraphic" } } } } } } } }, "/api/stat/getSalesExpensesOnMarketplaces": { "get": { "tags": [ "Аналитика" ], "summary": "Расходы по продажам на маркетплейсах", "description": "Метод получает расходы по продажам на маркетплейсах.", "operationId": "getSalesExpensesOnMarketplaces", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/FindResponseRowStructureForFinanceTable" } } } } } } }, "/api/stat/getSaleOrReturnStructure": { "get": { "tags": [ "Аналитика" ], "summary": "Структура продаж", "description": "Метод получает данные по структуре продаж на ВБ.", "operationId": "getSaleOrReturnStructure", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/GetFinanceStructureResult" } } } } } } }, "/api/stat/getProfitStructure": { "get": { "tags": [ "Аналитика" ], "summary": "Структура выручки", "description": "Метод получает данные по структуре дохода.Обязательно нужно передать в запросе dateTo, dateFrom, periodНе обязательные поля clientOrganizationId, serviceIds", "operationId": "getProfitStructures", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/GetFinanceStructureResult" } } } } } } }, "/api/stat/getProfitStat": { "get": { "tags": [ "Аналитика" ], "summary": "Данные по продажам", "description": "Метод возвращает данные по продажам за период.", "operationId": "getProfitStats", "parameters": [ { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } }, { "name": "id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "field", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ProductStats" } } } } } } }, "/api/stat/getProfitStatDifferenceToDashBoard": { "get": { "tags": [ "Аналитика" ], "summary": "Дашборд аналитики", "description": "Метод возвращает данные за текущий период и такой же предыдущий.", "operationId": "getProfitStatDifferenceToDashBoard", "parameters": [ { "name": "request", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/AnalyticsRequest" } }, { "name": "Referer", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinanceReport" } } } } } } } }, "/api/stat/getProfitStatByPeriodToDashBoard": { "get": { "tags": [ "Аналитика" ], "summary": "Данные по продажам", "description": "Метод возвращает данные по продажам за период.", "operationId": "getProfitStat", "parameters": [ { "name": "request", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/AnalyticsRequest" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/FindResponseFinanceReport" } } } } } } }, "/api/stat/getProfitReportFileHistory": { "get": { "tags": [ "Аналитика" ], "summary": "Получить истори загрузки реализации", "description": "Метод получает историю загрузок файлов реализации по МП и фильтрует их", "operationId": "getProfitReportFileHistory", "parameters": [ { "name": "dateFrom", "in": "query", "description": "Фильтр по дате операции - от", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Фильтр по дате операции - от" } }, { "name": "dateTo", "in": "query", "description": "Фильтр по дате операции - до", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Фильтр по дате операции - до" } }, { "name": "clientOrganizationId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "limit", "in": "query", "description": "Ограничение на количество записей. Максимальное значение - 500", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Ограничение на количество записей. Максимальное значение - 500" } }, { "name": "page", "in": "query", "description": "Номер страницы начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Номер страницы начиная с 1" } }, { "name": "count", "in": "query", "description": "Возвратить в ответе общее количество записей", "required": false, "schema": { "type": "boolean", "description": "Возвратить в ответе общее количество записей" } }, { "name": "sortBy", "in": "query", "description": "Поле для сортировки", "required": false, "schema": { "type": "string", "description": "Поле для сортировки", "enum": [ "SERVICES", "ORGANIZATION", "CREATEDDATE", "DATEFROM", "DATETO" ] } }, { "name": "ascending", "in": "query", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка.", "required": false, "schema": { "type": "boolean", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка." } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/FindResponseProfitReportFileHistory" } } } } } } }, "/api/stat/getProfitDifferenceForPeriod": { "get": { "tags": [ "Аналитика" ], "summary": "Дашборд аналитики", "description": "Метод возвращает данные за текущий период и такой же предыдущий.", "operationId": "getProfitsDifferenceForPeriod", "parameters": [ { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } }, { "name": "id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "field", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "service", "in": "query", "required": true, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductStats" } } } } } } } }, "/api/stat/getProductBalanceResult": { "get": { "tags": [ "Аналитика" ], "summary": "Отчет по остаткам", "description": "Метод получает данные по остаткам на текущий момент и подсчитывает на какой период еще хватит товара. Обязательно нужно передать в запросе dateTo, dateFromНе обязательные поля clientOrganizationId, serviceIds", "operationId": "getProductBalanceResults", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/GetProductBalanceResult" } } } } } } }, "/api/stat/getProductAnalyticsByField": { "get": { "tags": [ "Аналитика" ], "summary": "Товарная аналитика", "description": "Метод получает данные по товарной аналитике. Обязательно нужно передать в запросе dateTo, dateFrom, productAnalyticField.Не обязательные поля clientOrganizationId, serviceIds.Поле - period не используется.", "operationId": "getProductsAnalyticsByField", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/FindResponseProductAnalytics" } } } } } } }, "/api/stat/getProblematicProductStats": { "get": { "tags": [ "Аналитика" ], "summary": "Отчет по проблемным товарам", "description": "Метод получает данные по проблемным товарам.", "operationId": "getProblematicProductStats", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/FindResponseProductAnalytics" } } } } } } }, "/api/stat/getPlanSalesByField": { "get": { "tags": [ "Аналитика" ], "summary": "Получить план продаж по типу", "description": "Метод возвращает данные по плану продаж по типу", "operationId": "getPlanSalesByField", "parameters": [ { "name": "productAnalyticFields", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } } }, { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/FindResponsePlanSales" } } } } } } }, "/api/stat/getPenaltyStructure": { "get": { "tags": [ "Аналитика" ], "summary": "Структура расходов", "description": "Метод получает данные по структуре штрафов.Обязательно нужно передать в запросе dateTo, dateFrom, periodНе обязательные поля clientOrganizationId, serviceIds", "operationId": "getPenaltyStructures", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RowStructureForFinanceTable" } } } } } } } }, "/api/stat/getOrderSaleStat": { "get": { "tags": [ "Аналитика" ], "summary": "Заказы", "description": "Метод возвращает данные о заказах за период", "operationId": "getOrderSaleStats", "parameters": [ { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } }, { "name": "field", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ProductStats" } } } } } } }, "/api/stat/getOrderReport": { "get": { "tags": [ "Аналитика" ], "summary": "Отчет по по заказам", "description": "Метод получает данные по заказам с группировкой по заказу и товару (для одного заказа с 3 разными товарами в отчете будет 3 строки).", "operationId": "getOrdersReport", "parameters": [ { "name": "actual", "in": "query", "description": "Отображать только актуальные заказы - не закрытые?", "required": false, "schema": { "type": "boolean", "description": "Отображать только актуальные заказы - не закрытые?" } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "serviceWarehouseId", "in": "query", "description": "Внешний номер склада", "required": false, "schema": { "type": "string", "description": "Внешний номер склада" } }, { "name": "externalOrderId", "in": "query", "description": "Внешний номер заказа", "required": false, "schema": { "type": "string", "description": "Внешний номер заказа" } }, { "name": "invoiceNumber", "in": "query", "description": "ID Номера счета", "required": false, "schema": { "type": "integer", "format": "int64", "description": "ID Номера счета" } }, { "name": "article", "in": "query", "description": "Фильтр по артикулу модели товара в заказе", "required": false, "schema": { "type": "string", "description": "Фильтр по артикулу модели товара в заказе" } }, { "name": "containsArticle", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "product", "in": "query", "description": "Фильтр по названию товара в заказе", "required": false, "schema": { "type": "string", "description": "Фильтр по названию товара в заказе" } }, { "name": "organizations", "in": "query", "description": "Фильтр по ID организации. Можно передавать несколько значений organizations=123&organizations=345", "required": false, "schema": { "type": "array", "description": "Фильтр по ID организации. Можно передавать несколько значений organizations=123&organizations=345", "items": { "type": "integer", "format": "int64", "description": "Фильтр по ID организации. Можно передавать несколько значений organizations=123&organizations=345" }, "uniqueItems": true } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации заказов по номеру или названию", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации заказов по номеру или названию" } }, { "name": "userId", "in": "query", "description": "ID пользователя который брал на сборку заказ", "required": false, "schema": { "type": "integer", "format": "int32", "description": "ID пользователя который брал на сборку заказ" } }, { "name": "service", "in": "query", "description": "Фильтр заказа по маркетплейсу", "required": false, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "statuses", "in": "query", "description": "Фильтр по статусам заказа. Можно передавать несколько значений statuses=CREATED&statuses=PACKING", "required": false, "schema": { "type": "array", "description": "Фильтр по статусам заказа. Можно передавать несколько значений statuses=CREATED&statuses=PACKING", "items": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } } }, { "name": "withoutSupply", "in": "query", "description": "Фильтр по заказам не прикрепленным к поставке?", "required": false, "schema": { "type": "boolean", "description": "Фильтр по заказам не прикрепленным к поставке?" } }, { "name": "orderProductId", "in": "query", "description": "Фильтр по ID позиции в заказе", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Фильтр по ID позиции в заказе" } }, { "name": "productId", "in": "query", "description": "Фильтр по ID товара из заказа", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Фильтр по ID товара из заказа" } }, { "name": "supplierId", "in": "query", "description": "Фильтр по поставщику", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Фильтр по поставщику" } }, { "name": "hasCollectTask", "in": "query", "description": "Фильтр по наличию у заказа сборочного задания?", "required": false, "schema": { "type": "boolean", "description": "Фильтр по наличию у заказа сборочного задания?" } }, { "name": "organizationId", "in": "query", "description": "Фильтр по ID организации заказа", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Фильтр по ID организации заказа" } }, { "name": "updateInService", "in": "query", "description": "Заказы, которые стоят в очереди на изменение статуса на маркетплейсе?", "required": false, "schema": { "type": "boolean", "description": "Заказы, которые стоят в очереди на изменение статуса на маркетплейсе?" } }, { "name": "hasServiceError", "in": "query", "description": "Заказы с ошибкой обновления статуса на маркетплейсе?", "required": false, "schema": { "type": "boolean", "description": "Заказы с ошибкой обновления статуса на маркетплейсе?" } }, { "name": "noLabel", "in": "query", "description": "Фильтрует заказы без этикетки?", "required": false, "schema": { "type": "boolean", "description": "Фильтрует заказы без этикетки?" } }, { "name": "isLegal", "in": "query", "description": "Фильтрует заказы для бизнеса", "required": false, "schema": { "type": "boolean", "description": "Фильтрует заказы для бизнеса" } }, { "name": "noMsOrder", "in": "query", "description": "Фильтрует по заказам не созданным в Моем складе?", "required": false, "schema": { "type": "boolean", "description": "Фильтрует по заказам не созданным в Моем складе?" } }, { "name": "noMsDemand", "in": "query", "description": "Фильтрует по заказам с несозданными отгрузками в Моем складе?", "required": false, "schema": { "type": "boolean", "description": "Фильтрует по заказам с несозданными отгрузками в Моем складе?" } }, { "name": "ids", "in": "query", "description": "ID заказов. Можно передавать несколько значений ids=123&ids=345", "required": false, "schema": { "type": "array", "description": "ID заказов. Можно передавать несколько значений ids=123&ids=345", "items": { "type": "integer", "format": "int64", "description": "ID заказов. Можно передавать несколько значений ids=123&ids=345" }, "uniqueItems": true } }, { "name": "supplyId", "in": "query", "description": "ID поставки, в которой отгружается заказ", "required": false, "schema": { "type": "integer", "format": "int64", "description": "ID поставки, в которой отгружается заказ" } }, { "name": "notCollected", "in": "query", "description": "Заказы, которые не собирались через SelSup?", "required": false, "schema": { "type": "boolean", "description": "Заказы, которые не собирались через SelSup?" } }, { "name": "dbs", "in": "query", "description": "DBS заказы?", "required": false, "schema": { "type": "boolean", "description": "DBS заказы?" } }, { "name": "express", "in": "query", "description": "Express заказы?", "required": false, "schema": { "type": "boolean", "description": "Express заказы?" } }, { "name": "fbs", "in": "query", "description": "FBS заказы?", "required": false, "schema": { "type": "boolean", "description": "FBS заказы?" } }, { "name": "noWarehouse", "in": "query", "description": "Заказы без склада?", "required": false, "schema": { "type": "boolean", "description": "Заказы без склада?" } }, { "name": "closeDate", "in": "query", "description": "Фильтр по дате сборки заказа - конкретный день", "required": false, "schema": { "type": "string", "description": "Фильтр по дате сборки заказа - конкретный день" } }, { "name": "modifiedDate", "in": "query", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе начиная с этой даты", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе начиная с этой даты" } }, { "name": "modifiedDateTo", "in": "query", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе до этой даты", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе до этой даты" } }, { "name": "incomeId", "in": "query", "description": "ID закупки из которого создан заказ", "required": false, "schema": { "type": "integer", "format": "int64", "description": "ID закупки из которого создан заказ" } }, { "name": "bindingOrderId", "in": "query", "description": "ID заказа, которому делаем возврат", "required": false, "schema": { "type": "integer", "format": "int64", "description": "ID заказа, которому делаем возврат" } }, { "name": "closeDateFrom", "in": "query", "description": "Фильтр по дате сборки заказа от - ISO", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Фильтр по дате сборки заказа от - ISO" } }, { "name": "closeDateTo", "in": "query", "description": "Фильтр по дате сборки заказа до - ISO", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Фильтр по дате сборки заказа до - ISO" } }, { "name": "orderDate", "in": "query", "description": "Фильтр по дате заказа", "required": false, "schema": { "type": "string", "description": "Фильтр по дате заказа" } }, { "name": "deliveryDate", "in": "query", "description": "Фильтр по дате доставки заказа", "required": false, "schema": { "type": "string", "description": "Фильтр по дате доставки заказа" } }, { "name": "deliveryDateFrom", "in": "query", "description": "Фильтр по дате доставки заказа от", "required": false, "schema": { "type": "string", "description": "Фильтр по дате доставки заказа от" } }, { "name": "deliveryDateTo", "in": "query", "description": "Фильтр по дате доставки заказа до", "required": false, "schema": { "type": "string", "description": "Фильтр по дате доставки заказа до" } }, { "name": "createdDateFrom", "in": "query", "description": "Фильтр по дате создания заказа от", "required": false, "schema": { "type": "string", "description": "Фильтр по дате создания заказа от" } }, { "name": "createdDateTo", "in": "query", "description": "Фильтр по дате создания заказа до", "required": false, "schema": { "type": "string", "description": "Фильтр по дате создания заказа до" } }, { "name": "forMoySklad", "in": "query", "description": "Для создания в МойСклад?", "required": false, "schema": { "type": "boolean", "description": "Для создания в МойСклад?" } }, { "name": "withMoySkladOrder", "in": "query", "description": "Только заказы, у которых уже есть заказ в МойСклад (moy_sklad_id задан)", "required": false, "schema": { "type": "boolean", "description": "Только заказы, у которых уже есть заказ в МойСклад (moy_sklad_id задан)" } }, { "name": "warehouseId", "in": "query", "description": "Фильтр по ID склада, с которого отгружается заказ", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Фильтр по ID склада, с которого отгружается заказ" } }, { "name": "warehouseIds", "in": "query", "description": "Фильтр по ID складам, с которого отгружается заказ. Можно передавать несколько значений warehouseIds=123&warehouseIds=345", "required": false, "schema": { "type": "array", "description": "Фильтр по ID складам, с которого отгружается заказ. Можно передавать несколько значений warehouseIds=123&warehouseIds=345", "items": { "type": "integer", "format": "int64", "description": "Фильтр по ID складам, с которого отгружается заказ. Можно передавать несколько значений warehouseIds=123&warehouseIds=345" }, "uniqueItems": true } }, { "name": "dateFrom", "in": "query", "description": "Фильтр по дате заказа - от", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Фильтр по дате заказа - от" } }, { "name": "dateTo", "in": "query", "description": "Фильтр по дате заказа - до", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Фильтр по дате заказа - до" } }, { "name": "timeZone", "in": "query", "description": "ID часового пояса клиента по UTC в часах, например 3", "required": false, "schema": { "type": "integer", "format": "int32", "description": "ID часового пояса клиента по UTC в часах, например 3" } }, { "name": "markingStatus", "in": "query", "description": "Фильтр по статусу в честном знаке", "required": false, "schema": { "type": "string", "description": "Фильтр по статусу в честном знаке", "enum": [ "UNKNOWN", "CARDS_SEND", "CARDS_CREATED", "SUZ_ORDERS_CREATED", "MARKS_RECEIVED", "CARDS_SIGNED", "DOCUMENT_CREATED", "SUCCESS", "NO_NEED_MARKING" ] } }, { "name": "deleted", "in": "query", "description": "Показать удаленные заказы?", "required": false, "schema": { "type": "boolean", "description": "Показать удаленные заказы?" } }, { "name": "collectLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?" } }, { "name": "sortOrdersByDate", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?" } }, { "name": "sortBySku", "in": "query", "description": "Только для печати в PDF. Признак необходимости использовать в сортировке данные о товарах объединенных по SKU?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости использовать в сортировке данные о товарах объединенных по SKU?" } }, { "name": "notGroupByOrganization", "in": "query", "description": "Только для печати в PDF. Признак того, что все организации сортируются одним списком?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак того, что все организации сортируются одним списком?" } }, { "name": "notGroupByService", "in": "query", "description": "Только для печати в PDF. Признак того, что все маркетплейсы сортируются одним списком?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак того, что все маркетплейсы сортируются одним списком?" } }, { "name": "productLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать этикетку товара в ленте?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать этикетку товара в ленте?" } }, { "name": "servicesForLabel", "in": "query", "description": "Сервисы для которых нужна печать в PDF", "required": false, "schema": { "type": "array", "description": "Сервисы для которых нужна печать в PDF", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "infoLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать информационную этикетку для ленты заказов?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать информационную этикетку для ленты заказов?" } }, { "name": "grouped", "in": "query", "description": "Отдает сгруппированные позиции из заказов. Только для выгрузки в Excel?", "required": false, "schema": { "type": "boolean", "description": "Отдает сгруппированные позиции из заказов. Только для выгрузки в Excel?" } }, { "name": "replaceSetByComponent", "in": "query", "description": "Заменяет в заказах комплекты на компоненты?", "required": false, "schema": { "type": "boolean", "description": "Заменяет в заказах комплекты на компоненты?" } }, { "name": "replaceSetsByComponentsIncome", "in": "query", "description": "Заменяет в заказах комплекты на компоненты в файле закупки?", "required": false, "schema": { "type": "boolean", "description": "Заменяет в заказах комплекты на компоненты в файле закупки?" } }, { "name": "collectDeliveryLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать накладную службы доставки для \"умной ленты\"?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать накладную службы доставки для \"умной ленты\"?" } }, { "name": "shippingServicesForLabel", "in": "query", "description": "Сервисы доставки для которых нужна печать накладной в PDF", "required": false, "schema": { "type": "array", "description": "Сервисы доставки для которых нужна печать накладной в PDF", "items": { "type": "string", "description": "Сервисы доставки для которых нужна печать накладной в PDF", "enum": [ "CDEK", "OWN_DELIVERY", "POST", "BOXBERRY", "DPD", "YANDEX", "DOSTAVISTA", "DELLIN", "PEC" ] } } }, { "name": "orderId", "in": "query", "description": "ID заказа", "required": false, "schema": { "type": "integer", "format": "int64", "description": "ID заказа" } }, { "name": "hasVideoFixation", "in": "query", "description": "Идентификатор была ли видео фиксация?", "required": false, "schema": { "type": "boolean", "description": "Идентификатор была ли видео фиксация?" } }, { "name": "withProducts", "in": "query", "description": "Признак, что заказы необходимо отдать c товарами?", "required": false, "schema": { "type": "boolean", "description": "Признак, что заказы необходимо отдать c товарами?" } }, { "name": "passageIds", "in": "query", "description": "Фильтр по ID проходов. Можно передавать несколько значений passageIds=123&passageIds=345", "required": false, "schema": { "type": "array", "description": "Фильтр по ID проходов. Можно передавать несколько значений passageIds=123&passageIds=345", "items": { "type": "integer", "format": "int64", "description": "Фильтр по ID проходов. Можно передавать несколько значений passageIds=123&passageIds=345" }, "uniqueItems": true } }, { "name": "withContractor", "in": "query", "description": "Включить информацию о поставщиках в выгрузку?", "required": false, "schema": { "type": "boolean", "description": "Включить информацию о поставщиках в выгрузку?" } }, { "name": "boxId", "in": "query", "description": "Идентификатор короба", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор короба" } }, { "name": "limit", "in": "query", "description": "Ограничение на количество записей. Максимальное значение - 500", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Ограничение на количество записей. Максимальное значение - 500" } }, { "name": "page", "in": "query", "description": "Номер страницы начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Номер страницы начиная с 1" } }, { "name": "count", "in": "query", "description": "Возвратить в ответе общее количество записей", "required": false, "schema": { "type": "boolean", "description": "Возвратить в ответе общее количество записей" } }, { "name": "sortBy", "in": "query", "description": "Поле для сортировки", "required": false, "schema": { "type": "string", "description": "Поле для сортировки", "enum": [ "ID", "CREATEDDATE", "ORDERCREATED", "CREATED", "CREATEDUSER", "STATUS", "SERVICE", "TYPE", "BOXTYPE", "NAME", "ORGANIZATIONID", "WAREHOUSE", "INVOICENUMBER", "EXTERNALORDERID", "QUEUE", "SUPPLYID", "CLOSEDATE", "STARTCOLLECTDATE", "CLOSEUSERID", "USERID", "PRICE", "PRODUCT", "COLLECTORDERTASKID", "DELIVERYDATE", "MARKINGSTATUS", "QUANTITY", "DATE", "SERVICEWAREHOUSEID" ] } }, { "name": "ascending", "in": "query", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка.", "required": false, "schema": { "type": "boolean", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка." } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/FindResponseOrderReport" } } } } } } }, "/api/stat/getOperatorJobStats": { "get": { "tags": [ "Аналитика" ], "summary": "Данные о выполненных задания", "description": "Возвращает информацию о выполненных заданиях сотрудников за период", "operationId": "getOperatorJobStat", "parameters": [ { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/UsersStat" } } } } } } }, "/api/stat/getIncomePriceStats": { "get": { "tags": [ "Аналитика" ], "summary": "Данные о заказах поставщикам", "description": "Возвращает информацию о заказах поставщикам для расчетов с контрагентами", "operationId": "getIncomePriceStat", "parameters": [ { "name": "modelId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ProductStats" } } } } } } }, "/api/stat/getHandOnPulseReport": { "get": { "tags": [ "Аналитика" ], "summary": "Возвращает отчет рука на пульсе", "description": "Метод возвращает данные по отчету рука на пульсе Wildberries", "operationId": "getHandOnPulseReport", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/FindResponseHandOnPulseReport" } } } } } } }, "/api/stat/getFirstAnalyticDay": { "get": { "tags": [ "Аналитика" ], "summary": "Дата начала аналитика", "description": "Возвращает первую дату записанной аналитики по клиенту", "operationId": "getFirstAnalyticDay", "parameters": [ { "name": "clientOrganizationId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "services", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "string", "format": "date-time" } } } } } } }, "/api/stat/getFinancesReportByPeriod": { "get": { "tags": [ "Аналитика" ], "summary": "Финансовый отчет", "description": "Метод получает данные по финансовой аналитике. Обязательно нужно передать в запросе dateTo, dateFrom, periodНе обязательные поля clientOrganizationId, serviceIds", "operationId": "getFinanceReportByPeriod", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/FindResponseFinanceReport" } } } } } } }, "/api/stat/getFactSalePlanReport": { "get": { "tags": [ "Аналитика" ], "summary": "Получить факт продаж", "description": "Метод возвращает данные по факту продаж", "operationId": "getFactSalePlanReport", "parameters": [ { "name": "productAnalyticFields", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } } }, { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/FindResponsePlanFactSalesReport" } } } } } } }, "/api/stat/getCountFbsFbo": { "get": { "tags": [ "Аналитика" ], "summary": "Остатки на дашборде FBO/FBS", "description": "Получить кол-во и сумму остатков по FBS и FBO", "operationId": "getCountsFbsFbo", "parameters": [ { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "fieldId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "field", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/StockBalance" } } } } } } }, "/api/stat/getCostStructure": { "get": { "tags": [ "Аналитика" ], "summary": "Структура расходов", "description": "Метод получает данные по структуре расходов.Обязательно нужно передать в запросе dateTo, dateFrom, periodНе обязательные поля clientOrganizationId, serviceIds", "operationId": "getCostStructures", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/GetFinanceStructureResult" } } } } } } }, "/api/stat/getContractorsReport": { "get": { "tags": [ "Аналитика" ], "summary": "Отчет по поставщикам", "description": "Метод получает данные по продажам и остаткам товара по каждому поставщику.", "operationId": "getContractorReport", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/FindResponseContractorsReport" } } } } } } }, "/api/stat/getCommonStat": { "get": { "tags": [ "Аналитика" ], "summary": "Остатки товаров", "description": "Возвращает общие данные об остатках товаров по FBO/FBS", "operationId": "getCommonStat", "parameters": [ { "name": "organizationIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "organizationId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/CommonStat" } } } } } } }, "/api/stat/getClientProductsStat": { "get": { "tags": [ "Аналитика" ], "summary": "Общие данные по клиентам", "description": "Метод возвращает данные за текущий период и такой же предыдущий.", "operationId": "getClientProductsStat", "parameters": [ { "name": "dateFrom", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "dateTo", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClientProductsStat" } } } } } } } }, "/api/stat/getAggregateProductStatsByField": { "get": { "tags": [ "Аналитика" ], "summary": "Аналитика по модели/цвету или размеру", "description": "Метод возвращает агрегированные данные по Product.Size", "operationId": "getAggregateProductsStatsByField", "parameters": [ { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } }, { "name": "entityId", "in": "query", "description": "Идентификатор модели, цвета, размера или категории, в зависимости от field", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "field", "in": "query", "description": "Тип сущности для которой рассчитывает данные", "required": true, "schema": { "type": "string", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "service", "in": "query", "description": "Маркетплейс", "required": false, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } }, { "name": "groupBy", "in": "query", "description": "Группировать по", "required": true, "schema": { "type": "string", "enum": [ "COLOR", "SIZE" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ProductStats" } } } } } } }, "/api/stat/getAggregateDataByCategory": { "get": { "tags": [ "Аналитика" ], "summary": "Товарная аналитика по категориям", "description": "Метод возвращает агрегируемые данные для каждой категории товара из отчета по операциям за определенный период", "operationId": "getAggregateDataByCategorys", "parameters": [ { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } }, { "name": "service", "in": "query", "required": true, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } }, { "name": "field", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "fieldId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ProductStats" } } } } } } }, "/api/stat/getAbcAnalysisByRevenue": { "get": { "tags": [ "Аналитика" ], "summary": "ABC анализ по выручке", "description": "Возвращает ABC анализ по выручке", "operationId": "getAbcAnalysisByRevenues", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/AbcAnalysisResult" } } } } } } }, "/api/stat/getAbcAnalysisByGrossProfit": { "get": { "tags": [ "Аналитика" ], "summary": "ABC анализ по валовой прибыли", "description": "Возвращает результат ABC анализа по валовой прибыли", "operationId": "getAbcAnalysisByGrossProfits", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/AbcAnalysisResult" } } } } } } }, "/api/stat/funnel/organization/{organizationId}/last-date": { "get": { "tags": [ "Аналитика" ], "summary": "Получить дату последнего импорта", "operationId": "getWbSalesFunnelLastImportDate", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "string" } } } } } } }, "/api/stat/fullFinanceReport": { "get": { "tags": [ "Аналитика" ], "summary": "Полный финансовый отчет", "description": "Объединение методов getFinancesReportByPeriod, getCostStructure,getSalesExpensesOnMarketplaces, getProfitStructure,getPenaltyStructure, getServiceStructure", "operationId": "getFullFinanceReport", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } }, { "name": "Referer", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ComprehensiveFinanceAnalytics" } } } } } } }, "/api/stat/findirTips": { "get": { "tags": [ "Аналитика" ], "summary": "Умный анализ финансов", "operationId": "getFindirTipsResponse", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TipsResponse" } } } } } } }, "/api/stat/findir/tips": { "get": { "tags": [ "Аналитика" ], "summary": "Умный анализ финансов", "operationId": "getFindirTips_1", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Tip" } } } } } } } }, "/api/stat/findProfitReport": { "get": { "tags": [ "Аналитика" ], "summary": "Поиск операций аналитики", "description": "Метод возвращает список операций аналитики по фильтру", "operationId": "findProfitReport", "parameters": [ { "name": "dateFrom", "in": "query", "description": "Фильтр по дате операции - от", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Фильтр по дате операции - от" } }, { "name": "dateTo", "in": "query", "description": "Фильтр по дате операции - до", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Фильтр по дате операции - до" } }, { "name": "field", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "fieldId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "commission", "in": "query", "required": false, "schema": { "type": "number", "format": "double" } }, { "name": "clientOrganizationId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "sourceReport", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "services", "in": "query", "description": "Список маркетплейсов", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Список категорий", "required": false, "schema": { "type": "array", "description": "Список категорий", "items": { "type": "integer", "format": "int64", "description": "Список категорий" } } }, { "name": "brands", "in": "query", "description": "Список брендов", "required": false, "schema": { "type": "array", "description": "Список брендов", "items": { "type": "integer", "format": "int64", "description": "Список брендов" } } }, { "name": "noProduct", "in": "query", "description": "Без карточки", "required": false, "schema": { "type": "boolean", "description": "Без карточки" } }, { "name": "operationType", "in": "query", "description": "Тип операции(Продажи, возврат, логистика и т.д.)", "required": false, "schema": { "type": "string", "description": "Тип операции(Продажи, возврат, логистика и т.д.)", "enum": [ "DEFAULT", "SALES", "RETURNS", "PENALTIES", "LOGISTICS", "SERVICES", "COMPENSATION", "STORNO_SALES", "STORNO_RETURNS", "IS_CANCEL", "ONE_PENALTIES", "ONE_ADDITION_PAY", "ORDERS", "TRANSFER_DELIVERY", "OTHERS_AMOUNT", "ACQUIRING", "COST_STORAGE", "CAMPAIGN_OPERATION", "DEDUCTIONS", "COMPENSATION_FOR_LOST_ITEM_ON_WB", "LOGISTICS_CORRECTION", "ACCEPTANCE", "NEW_ACCEPTANCE", "OWN_DELIVERY", "MARKETPLACE_BONUS" ] } }, { "name": "query", "in": "query", "description": "Вид операции", "required": false, "schema": { "type": "string", "description": "Вид операции" } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "clientId", "in": "query", "description": "Идентификатор клиента через репрайсер", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор клиента через репрайсер" } }, { "name": "fileHistoryId", "in": "query", "description": "Идентификатор загруженного файла", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор загруженного файла" } }, { "name": "notCurrentCurrency", "in": "query", "description": "Валюта отчета", "required": false, "schema": { "type": "string", "description": "Валюта отчета" } }, { "name": "limit", "in": "query", "description": "Ограничение на количество записей. Максимальное значение - 500", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Ограничение на количество записей. Максимальное значение - 500" } }, { "name": "page", "in": "query", "description": "Номер страницы начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Номер страницы начиная с 1" } }, { "name": "count", "in": "query", "description": "Возвратить в ответе общее количество записей", "required": false, "schema": { "type": "boolean", "description": "Возвратить в ответе общее количество записей" } }, { "name": "sortBy", "in": "query", "description": "Поле для сортировки", "required": false, "schema": { "type": "string", "description": "Поле для сортировки", "enum": [ "ID", "SALECOMMISSION", "OPERATION_DATE", "SERVICENAME", "SUBJECTNAME", "SERVICECARD", "PRODUCTNAME", "DOCUMENTTYPE", "SUPPLIEROPERNAME", "BONUSTYPENAME", "PENALTY" ] } }, { "name": "ascending", "in": "query", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка.", "required": false, "schema": { "type": "boolean", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка." } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/FindResponseRealizationReport" } } } } } } }, "/api/stat/exportPlanSalesExcelFile": { "get": { "tags": [ "Аналитика" ], "summary": "Скачивание шаблона Excel плана продаж", "description": "Создает задачу на скачивание шаблона Excel файла с понедельным планом продаж", "operationId": "exportPlanSalesExcelFile", "parameters": [ { "name": "productAnalyticFields", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } } }, { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/downloadStockReportFile": { "get": { "tags": [ "Аналитика" ], "summary": "Файл остатков на складах МП", "description": "Метод ставит в очередь задачу по скачивании файла с остатками по каждому складу маркеплейса", "operationId": "downloadStockReportFile", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/downloadContractorsReportFile": { "get": { "tags": [ "Аналитика" ], "summary": "Excel отчет по поставщикам", "description": "Метод ставит в очередь задачу на скачивание Excel файла с данными по продажам и остаткам товара по каждому поставщику.", "operationId": "downloadContractorsReportFile", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/deleteProfitReportsByFileHistoryId": { "get": { "tags": [ "Аналитика" ], "summary": "Удалить данные о загрузке", "description": "Метод удаляет данные о загрузке вместе со всеми загруженными данными по этому файлу", "operationId": "deleteProfitReportsByFileHistoryId", "parameters": [ { "name": "ids", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/analytics/total": { "get": { "tags": [ "Аналитика" ], "summary": "Итого по товарной аналитике", "description": "Метод получает суммарные данные по товарной аналитике по тем же фильтрам, что и getProductAnalyticsByField, без пагинации.", "operationId": "getTotalProductsAnalyticsByField", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ProductAnalytics" } } } } } } }, "/api/stat/addWildberriesStorageReportTask": { "get": { "tags": [ "Аналитика" ], "summary": "Запуск закачки данных по хранению", "description": "Метод ставит в очередь задачу по закачки данных оплат за хранение на Wildberries", "operationId": "addWildberriesStorageReportTask", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/addSetPurchasePercentTask": { "get": { "tags": [ "Аналитика" ], "summary": "Запуск установки процента выкупа из аналитики", "description": "Метод ставит в очередь задачу по вычислению и установки процента выкупа товаров из аналитики", "operationId": "addSetPurchasePercentTask", "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/addMatchUnregisteredProfitReportTask": { "get": { "tags": [ "Аналитика" ], "summary": "Матчинг аналитики к карточке", "description": "Метод ставит в очередь задачу по привязке продукта к профит репорту, где отсутствует связь. OZON и WB", "operationId": "addMatchUnregisteredProfitReportTask", "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/addMatchProductLastOperationDate": { "get": { "tags": [ "Аналитика" ], "summary": "Матчинг дат операций в продукт", "description": "Метод ставит в очередь задачу по обновлению последних дат операций по маркетплейсам, метод принимает список МП", "operationId": "addMatchProductLastOperationDate", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/addDownloadReportSupplyPlanTask": { "get": { "tags": [ "Аналитика" ], "summary": "Excel план поставок и закупка товаров", "description": "Создает задачу на скачивание Excel файла по плату поставок и закупок товаровОбязательно нужно передать в запросе dateTo, dateFrom, planDayCount Не обязательные поля clientOrganizationId, services", "operationId": "addDownloadReportSupplyPlanTask", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/addDownloadReportProblematicProductsTask": { "get": { "tags": [ "Аналитика" ], "summary": "Excel проблемные товары", "description": "Создает задачу на скачивание Excel файла с данными по проблемным товарам.Остаток есть, но продаж за период не было.Обязательно нужно передать в запросе dateTo, dateFrom.Не обязательные поля clientOrganizationId.", "operationId": "addDownloadReportProblematicProductsTask", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/addDownloadProductAnalyticsFileTask": { "get": { "tags": [ "Аналитика" ], "summary": "Excel товарной аналитики", "description": "Создает задачу на скачивание Excel файла с данными по товарной аналитике.Обязательно нужно передать в запросе dateTo, dateFrom.Не обязательные поля clientOrganizationId, serviceIds.Поле - period и productAnalyticField не используются.Добавлена возможность отсортировать список по полю sortBy и по порядку ascending.", "operationId": "addDownloadProductsAnalyticsFileTask", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/addDownloadProblematicProductPriceFileTask": { "get": { "tags": [ "Аналитика" ], "summary": "Excel выгрузка цен по проблемным товарам", "description": "Создает задачу на скачивание Excel файла по выгрузке проблемных товаров в Excel файлНе обязательные поля clientOrganizationId, services, query для поиска", "operationId": "addDownloadProblematicProductPriceFileTask", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/addDownloadPlanFactSalesReportFileTask": { "get": { "tags": [ "Аналитика" ], "summary": "Excel план/факт продаж", "description": "Создает задачу на скачивание Excel файла с отчетом план/факт продажОбязательно нужно передать в запросе dateTo, dateFrom.Не обязательные поля clientOrganizationId.", "operationId": "addDownloadPlanFactSalesReportFileTask", "parameters": [ { "name": "productAnalyticFields", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } } }, { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/addDownloadOrderReportFile": { "get": { "tags": [ "Аналитика" ], "summary": "Экспорт позаказного Excel файла", "description": "Создает задачу на скачивание Excel файла с данными по заказам", "operationId": "addDownloadOrderReportsFile", "parameters": [ { "name": "actual", "in": "query", "description": "Отображать только актуальные заказы - не закрытые?", "required": false, "schema": { "type": "boolean", "description": "Отображать только актуальные заказы - не закрытые?" } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "serviceWarehouseId", "in": "query", "description": "Внешний номер склада", "required": false, "schema": { "type": "string", "description": "Внешний номер склада" } }, { "name": "externalOrderId", "in": "query", "description": "Внешний номер заказа", "required": false, "schema": { "type": "string", "description": "Внешний номер заказа" } }, { "name": "invoiceNumber", "in": "query", "description": "ID Номера счета", "required": false, "schema": { "type": "integer", "format": "int64", "description": "ID Номера счета" } }, { "name": "article", "in": "query", "description": "Фильтр по артикулу модели товара в заказе", "required": false, "schema": { "type": "string", "description": "Фильтр по артикулу модели товара в заказе" } }, { "name": "containsArticle", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "product", "in": "query", "description": "Фильтр по названию товара в заказе", "required": false, "schema": { "type": "string", "description": "Фильтр по названию товара в заказе" } }, { "name": "organizations", "in": "query", "description": "Фильтр по ID организации. Можно передавать несколько значений organizations=123&organizations=345", "required": false, "schema": { "type": "array", "description": "Фильтр по ID организации. Можно передавать несколько значений organizations=123&organizations=345", "items": { "type": "integer", "format": "int64", "description": "Фильтр по ID организации. Можно передавать несколько значений organizations=123&organizations=345" }, "uniqueItems": true } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации заказов по номеру или названию", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации заказов по номеру или названию" } }, { "name": "userId", "in": "query", "description": "ID пользователя который брал на сборку заказ", "required": false, "schema": { "type": "integer", "format": "int32", "description": "ID пользователя который брал на сборку заказ" } }, { "name": "service", "in": "query", "description": "Фильтр заказа по маркетплейсу", "required": false, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "statuses", "in": "query", "description": "Фильтр по статусам заказа. Можно передавать несколько значений statuses=CREATED&statuses=PACKING", "required": false, "schema": { "type": "array", "description": "Фильтр по статусам заказа. Можно передавать несколько значений statuses=CREATED&statuses=PACKING", "items": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } } }, { "name": "withoutSupply", "in": "query", "description": "Фильтр по заказам не прикрепленным к поставке?", "required": false, "schema": { "type": "boolean", "description": "Фильтр по заказам не прикрепленным к поставке?" } }, { "name": "orderProductId", "in": "query", "description": "Фильтр по ID позиции в заказе", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Фильтр по ID позиции в заказе" } }, { "name": "productId", "in": "query", "description": "Фильтр по ID товара из заказа", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Фильтр по ID товара из заказа" } }, { "name": "supplierId", "in": "query", "description": "Фильтр по поставщику", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Фильтр по поставщику" } }, { "name": "hasCollectTask", "in": "query", "description": "Фильтр по наличию у заказа сборочного задания?", "required": false, "schema": { "type": "boolean", "description": "Фильтр по наличию у заказа сборочного задания?" } }, { "name": "organizationId", "in": "query", "description": "Фильтр по ID организации заказа", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Фильтр по ID организации заказа" } }, { "name": "updateInService", "in": "query", "description": "Заказы, которые стоят в очереди на изменение статуса на маркетплейсе?", "required": false, "schema": { "type": "boolean", "description": "Заказы, которые стоят в очереди на изменение статуса на маркетплейсе?" } }, { "name": "hasServiceError", "in": "query", "description": "Заказы с ошибкой обновления статуса на маркетплейсе?", "required": false, "schema": { "type": "boolean", "description": "Заказы с ошибкой обновления статуса на маркетплейсе?" } }, { "name": "noLabel", "in": "query", "description": "Фильтрует заказы без этикетки?", "required": false, "schema": { "type": "boolean", "description": "Фильтрует заказы без этикетки?" } }, { "name": "isLegal", "in": "query", "description": "Фильтрует заказы для бизнеса", "required": false, "schema": { "type": "boolean", "description": "Фильтрует заказы для бизнеса" } }, { "name": "noMsOrder", "in": "query", "description": "Фильтрует по заказам не созданным в Моем складе?", "required": false, "schema": { "type": "boolean", "description": "Фильтрует по заказам не созданным в Моем складе?" } }, { "name": "noMsDemand", "in": "query", "description": "Фильтрует по заказам с несозданными отгрузками в Моем складе?", "required": false, "schema": { "type": "boolean", "description": "Фильтрует по заказам с несозданными отгрузками в Моем складе?" } }, { "name": "ids", "in": "query", "description": "ID заказов. Можно передавать несколько значений ids=123&ids=345", "required": false, "schema": { "type": "array", "description": "ID заказов. Можно передавать несколько значений ids=123&ids=345", "items": { "type": "integer", "format": "int64", "description": "ID заказов. Можно передавать несколько значений ids=123&ids=345" }, "uniqueItems": true } }, { "name": "supplyId", "in": "query", "description": "ID поставки, в которой отгружается заказ", "required": false, "schema": { "type": "integer", "format": "int64", "description": "ID поставки, в которой отгружается заказ" } }, { "name": "notCollected", "in": "query", "description": "Заказы, которые не собирались через SelSup?", "required": false, "schema": { "type": "boolean", "description": "Заказы, которые не собирались через SelSup?" } }, { "name": "dbs", "in": "query", "description": "DBS заказы?", "required": false, "schema": { "type": "boolean", "description": "DBS заказы?" } }, { "name": "express", "in": "query", "description": "Express заказы?", "required": false, "schema": { "type": "boolean", "description": "Express заказы?" } }, { "name": "fbs", "in": "query", "description": "FBS заказы?", "required": false, "schema": { "type": "boolean", "description": "FBS заказы?" } }, { "name": "noWarehouse", "in": "query", "description": "Заказы без склада?", "required": false, "schema": { "type": "boolean", "description": "Заказы без склада?" } }, { "name": "closeDate", "in": "query", "description": "Фильтр по дате сборки заказа - конкретный день", "required": false, "schema": { "type": "string", "description": "Фильтр по дате сборки заказа - конкретный день" } }, { "name": "modifiedDate", "in": "query", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе начиная с этой даты", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе начиная с этой даты" } }, { "name": "modifiedDateTo", "in": "query", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе до этой даты", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе до этой даты" } }, { "name": "incomeId", "in": "query", "description": "ID закупки из которого создан заказ", "required": false, "schema": { "type": "integer", "format": "int64", "description": "ID закупки из которого создан заказ" } }, { "name": "bindingOrderId", "in": "query", "description": "ID заказа, которому делаем возврат", "required": false, "schema": { "type": "integer", "format": "int64", "description": "ID заказа, которому делаем возврат" } }, { "name": "closeDateFrom", "in": "query", "description": "Фильтр по дате сборки заказа от - ISO", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Фильтр по дате сборки заказа от - ISO" } }, { "name": "closeDateTo", "in": "query", "description": "Фильтр по дате сборки заказа до - ISO", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Фильтр по дате сборки заказа до - ISO" } }, { "name": "orderDate", "in": "query", "description": "Фильтр по дате заказа", "required": false, "schema": { "type": "string", "description": "Фильтр по дате заказа" } }, { "name": "deliveryDate", "in": "query", "description": "Фильтр по дате доставки заказа", "required": false, "schema": { "type": "string", "description": "Фильтр по дате доставки заказа" } }, { "name": "deliveryDateFrom", "in": "query", "description": "Фильтр по дате доставки заказа от", "required": false, "schema": { "type": "string", "description": "Фильтр по дате доставки заказа от" } }, { "name": "deliveryDateTo", "in": "query", "description": "Фильтр по дате доставки заказа до", "required": false, "schema": { "type": "string", "description": "Фильтр по дате доставки заказа до" } }, { "name": "createdDateFrom", "in": "query", "description": "Фильтр по дате создания заказа от", "required": false, "schema": { "type": "string", "description": "Фильтр по дате создания заказа от" } }, { "name": "createdDateTo", "in": "query", "description": "Фильтр по дате создания заказа до", "required": false, "schema": { "type": "string", "description": "Фильтр по дате создания заказа до" } }, { "name": "forMoySklad", "in": "query", "description": "Для создания в МойСклад?", "required": false, "schema": { "type": "boolean", "description": "Для создания в МойСклад?" } }, { "name": "withMoySkladOrder", "in": "query", "description": "Только заказы, у которых уже есть заказ в МойСклад (moy_sklad_id задан)", "required": false, "schema": { "type": "boolean", "description": "Только заказы, у которых уже есть заказ в МойСклад (moy_sklad_id задан)" } }, { "name": "warehouseId", "in": "query", "description": "Фильтр по ID склада, с которого отгружается заказ", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Фильтр по ID склада, с которого отгружается заказ" } }, { "name": "warehouseIds", "in": "query", "description": "Фильтр по ID складам, с которого отгружается заказ. Можно передавать несколько значений warehouseIds=123&warehouseIds=345", "required": false, "schema": { "type": "array", "description": "Фильтр по ID складам, с которого отгружается заказ. Можно передавать несколько значений warehouseIds=123&warehouseIds=345", "items": { "type": "integer", "format": "int64", "description": "Фильтр по ID складам, с которого отгружается заказ. Можно передавать несколько значений warehouseIds=123&warehouseIds=345" }, "uniqueItems": true } }, { "name": "dateFrom", "in": "query", "description": "Фильтр по дате заказа - от", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Фильтр по дате заказа - от" } }, { "name": "dateTo", "in": "query", "description": "Фильтр по дате заказа - до", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Фильтр по дате заказа - до" } }, { "name": "timeZone", "in": "query", "description": "ID часового пояса клиента по UTC в часах, например 3", "required": false, "schema": { "type": "integer", "format": "int32", "description": "ID часового пояса клиента по UTC в часах, например 3" } }, { "name": "markingStatus", "in": "query", "description": "Фильтр по статусу в честном знаке", "required": false, "schema": { "type": "string", "description": "Фильтр по статусу в честном знаке", "enum": [ "UNKNOWN", "CARDS_SEND", "CARDS_CREATED", "SUZ_ORDERS_CREATED", "MARKS_RECEIVED", "CARDS_SIGNED", "DOCUMENT_CREATED", "SUCCESS", "NO_NEED_MARKING" ] } }, { "name": "deleted", "in": "query", "description": "Показать удаленные заказы?", "required": false, "schema": { "type": "boolean", "description": "Показать удаленные заказы?" } }, { "name": "collectLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?" } }, { "name": "sortOrdersByDate", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?" } }, { "name": "sortBySku", "in": "query", "description": "Только для печати в PDF. Признак необходимости использовать в сортировке данные о товарах объединенных по SKU?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости использовать в сортировке данные о товарах объединенных по SKU?" } }, { "name": "notGroupByOrganization", "in": "query", "description": "Только для печати в PDF. Признак того, что все организации сортируются одним списком?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак того, что все организации сортируются одним списком?" } }, { "name": "notGroupByService", "in": "query", "description": "Только для печати в PDF. Признак того, что все маркетплейсы сортируются одним списком?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак того, что все маркетплейсы сортируются одним списком?" } }, { "name": "productLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать этикетку товара в ленте?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать этикетку товара в ленте?" } }, { "name": "servicesForLabel", "in": "query", "description": "Сервисы для которых нужна печать в PDF", "required": false, "schema": { "type": "array", "description": "Сервисы для которых нужна печать в PDF", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "infoLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать информационную этикетку для ленты заказов?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать информационную этикетку для ленты заказов?" } }, { "name": "grouped", "in": "query", "description": "Отдает сгруппированные позиции из заказов. Только для выгрузки в Excel?", "required": false, "schema": { "type": "boolean", "description": "Отдает сгруппированные позиции из заказов. Только для выгрузки в Excel?" } }, { "name": "replaceSetByComponent", "in": "query", "description": "Заменяет в заказах комплекты на компоненты?", "required": false, "schema": { "type": "boolean", "description": "Заменяет в заказах комплекты на компоненты?" } }, { "name": "replaceSetsByComponentsIncome", "in": "query", "description": "Заменяет в заказах комплекты на компоненты в файле закупки?", "required": false, "schema": { "type": "boolean", "description": "Заменяет в заказах комплекты на компоненты в файле закупки?" } }, { "name": "collectDeliveryLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать накладную службы доставки для \"умной ленты\"?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать накладную службы доставки для \"умной ленты\"?" } }, { "name": "shippingServicesForLabel", "in": "query", "description": "Сервисы доставки для которых нужна печать накладной в PDF", "required": false, "schema": { "type": "array", "description": "Сервисы доставки для которых нужна печать накладной в PDF", "items": { "type": "string", "description": "Сервисы доставки для которых нужна печать накладной в PDF", "enum": [ "CDEK", "OWN_DELIVERY", "POST", "BOXBERRY", "DPD", "YANDEX", "DOSTAVISTA", "DELLIN", "PEC" ] } } }, { "name": "orderId", "in": "query", "description": "ID заказа", "required": false, "schema": { "type": "integer", "format": "int64", "description": "ID заказа" } }, { "name": "hasVideoFixation", "in": "query", "description": "Идентификатор была ли видео фиксация?", "required": false, "schema": { "type": "boolean", "description": "Идентификатор была ли видео фиксация?" } }, { "name": "withProducts", "in": "query", "description": "Признак, что заказы необходимо отдать c товарами?", "required": false, "schema": { "type": "boolean", "description": "Признак, что заказы необходимо отдать c товарами?" } }, { "name": "passageIds", "in": "query", "description": "Фильтр по ID проходов. Можно передавать несколько значений passageIds=123&passageIds=345", "required": false, "schema": { "type": "array", "description": "Фильтр по ID проходов. Можно передавать несколько значений passageIds=123&passageIds=345", "items": { "type": "integer", "format": "int64", "description": "Фильтр по ID проходов. Можно передавать несколько значений passageIds=123&passageIds=345" }, "uniqueItems": true } }, { "name": "withContractor", "in": "query", "description": "Включить информацию о поставщиках в выгрузку?", "required": false, "schema": { "type": "boolean", "description": "Включить информацию о поставщиках в выгрузку?" } }, { "name": "boxId", "in": "query", "description": "Идентификатор короба", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор короба" } }, { "name": "limit", "in": "query", "description": "Ограничение на количество записей. Максимальное значение - 500", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Ограничение на количество записей. Максимальное значение - 500" } }, { "name": "page", "in": "query", "description": "Номер страницы начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Номер страницы начиная с 1" } }, { "name": "count", "in": "query", "description": "Возвратить в ответе общее количество записей", "required": false, "schema": { "type": "boolean", "description": "Возвратить в ответе общее количество записей" } }, { "name": "sortBy", "in": "query", "description": "Поле для сортировки", "required": false, "schema": { "type": "string", "description": "Поле для сортировки", "enum": [ "ID", "CREATEDDATE", "ORDERCREATED", "CREATED", "CREATEDUSER", "STATUS", "SERVICE", "TYPE", "BOXTYPE", "NAME", "ORGANIZATIONID", "WAREHOUSE", "INVOICENUMBER", "EXTERNALORDERID", "QUEUE", "SUPPLYID", "CLOSEDATE", "STARTCOLLECTDATE", "CLOSEUSERID", "USERID", "PRICE", "PRODUCT", "COLLECTORDERTASKID", "DELIVERYDATE", "MARKINGSTATUS", "QUANTITY", "DATE", "SERVICEWAREHOUSEID" ] } }, { "name": "ascending", "in": "query", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка.", "required": false, "schema": { "type": "boolean", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка." } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/addDownloadFileSalesDynamicReportByPeriodTask": { "get": { "tags": [ "Аналитика" ], "summary": "Excel отчет динамики продаж", "description": "Создает задачу на скачивание Excel файла с данными по динамике продаж.Обязательно нужно передать в запросе dateTo, dateFrom, periodНе обязательные поля clientOrganizationId, serviceIds", "operationId": "addDownloadFileSalesDynamicReportsByPeriodTask", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/addDownloadFileProductBalanceDynamicsTask": { "get": { "tags": [ "Аналитика" ], "summary": "Excel динамика остатков", "description": "Создает задачу на скачивание Excel файла с данными по динамике остаткам за период.Обязательно нужно передать в запросе dateTo, dateFrom, periodНе обязательные поля clientOrganizationId, serviceIds", "operationId": "addDownloadFileProductsBalanceDynamicsTask", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/addDownloadFileFinancesReportByPeriodTask": { "get": { "tags": [ "Аналитика" ], "summary": "Excel финансового отчета", "description": "Создает задачу на скачивание Excel файла с данными по финансовой аналитике.Обязательно нужно передать в запросе dateTo, dateFrom, periodНе обязательные поля clientOrganizationId, serviceIds", "operationId": "addDownloadFileFinancesReportsByPeriodTask", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/addDownloadFileCurrentProductBalance": { "get": { "tags": [ "Аналитика" ], "summary": "Excel отчет по остаткам", "description": "Создает задачу на скачивание Excel файла с данными по остаткам на текущий момент.Обязательно нужно передать в запросе dateTo, dateFrom, для расчетов.Не обязательное поле clientOrganizationId", "operationId": "addDownloadFileCurrentProductsBalance", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/addDownloadFileAbcReport": { "get": { "tags": [ "Аналитика" ], "summary": "Excel файл ABC анализа", "description": "Ставит в очередь задачу на создание Excel файла с ABC анализом по выручке и валовой прибыли.", "operationId": "addDownloadFileAbcReports", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/stat/abc-analysis": { "get": { "tags": [ "Аналитика" ], "summary": "ABC анализ (выручка + валовая прибыль)", "description": "Возвращает объединённый ABC анализ по выручке и валовой прибыли в одной таблице. Каждая строка содержит данные по обоим показателям одновременно.", "operationId": "getAbcAnalysis", "parameters": [ { "name": "productAnalyticField", "in": "query", "description": "Агрегировать данные по сущности", "required": true, "schema": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации аналитики", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" } }, { "name": "withDuplicate", "in": "query", "description": "Отдавать аналитику по дубликатам товаров", "required": false, "schema": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" } }, { "name": "withOzonBonus", "in": "query", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике", "required": false, "schema": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" } }, { "name": "limit", "in": "query", "description": "Количество записей в ответе", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" } }, { "name": "page", "in": "query", "description": "Страница для навигации по страницам, начиная с 1", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" } }, { "name": "sortBy", "in": "query", "description": "Поле сортировки", "required": false, "schema": { "type": "string", "description": "Поле сортировки" } }, { "name": "ascending", "in": "query", "description": "Сортировать по возрастанию по полю sortBy", "required": false, "schema": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "isMarketPlaceStructure", "in": "query", "description": "Идентификатор, получать данные только по маркетплейсу или по всем.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." } }, { "name": "isDashboard", "in": "query", "description": "Идентификатор, запрос с дашборда или нет.", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." } }, { "name": "analyticsField", "in": "query", "description": "Агрегировать данные по model/product/view", "required": false, "schema": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } }, { "name": "planDayCount", "in": "query", "description": "Кол-во дней для отчетов", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" } }, { "name": "daysToSupply", "in": "query", "description": "Через сколько дней ожидается поставка", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" } }, { "name": "plannedSupplyDate", "in": "query", "description": "Планируемая дата поставки", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" } }, { "name": "groupByView", "in": "query", "description": "Сгруппировать по цвету", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать по цвету" } }, { "name": "warehouses", "in": "query", "description": "Список идентификаторов складов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов складов" } } }, { "name": "regions", "in": "query", "description": "Список регионов", "required": false, "schema": { "type": "array", "description": "Список регионов", "items": { "type": "string", "description": "Список регионов" } } }, { "name": "group", "in": "query", "description": "Сгруппировать данные", "required": false, "schema": { "type": "boolean", "description": "Сгруппировать данные" } }, { "name": "calculationByOrders", "in": "query", "description": "Делать расчет по заказанному количеству", "required": false, "schema": { "type": "boolean", "description": "Делать расчет по заказанному количеству" } }, { "name": "sourceReport", "in": "query", "description": "Операция по которой выводить данные", "required": false, "schema": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] } }, { "name": "skipDayWithoutStocks", "in": "query", "description": "Пропускать дни без остатков", "required": false, "schema": { "type": "boolean", "description": "Пропускать дни без остатков" } }, { "name": "replaceSetsByComponents", "in": "query", "description": "Раскрывать комплекты по компонентам", "required": false, "schema": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" } }, { "name": "distributeFbsByWarehouse", "in": "query", "description": "Распределять FBS по складам пропорционально FBO", "required": false, "schema": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" } }, { "name": "isSaleStructure", "in": "query", "description": "Идентификатор, что нужно получить структуру по продажам", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" } }, { "name": "isAveragePerOneUnit", "in": "query", "description": "Идентификатор, получить среднее за 1 единицу", "required": false, "schema": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" } }, { "name": "updateDate", "in": "query", "description": "Обновлять даты", "required": false, "schema": { "type": "boolean", "description": "Обновлять даты" } }, { "name": "useWeightedGroup", "in": "query", "description": "Использовать группы по весу", "required": false, "schema": { "type": "boolean", "description": "Использовать группы по весу" } }, { "name": "isFindirRequest", "in": "query", "description": "Является ли запрос - запросом для Задачника", "required": false, "schema": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" } }, { "name": "brandIds", "in": "query", "description": "Фильтр по идентификаторам брендов (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам брендов (список)" } } }, { "name": "categoryIds", "in": "query", "description": "Фильтр по идентификаторам категорий (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64", "description": "Фильтр по идентификаторам категорий (список)" } } }, { "name": "articles", "in": "query", "description": "Фильтр по артикулу (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string", "description": "Фильтр по артикулу (список)" } } }, { "name": "colors", "in": "query", "description": "Фильтр по цвету (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string", "description": "Фильтр по цвету (список)" } } }, { "name": "sizes", "in": "query", "description": "Фильтр по размеру (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string", "description": "Фильтр по размеру (список)" } } }, { "name": "barcodes", "in": "query", "description": "Фильтр по штрих-коду (список)", "required": false, "schema": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string", "description": "Фильтр по штрих-коду (список)" } } }, { "name": "penaltyFrom", "in": "query", "description": "Фильтр по штрафам (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" } }, { "name": "penaltyTo", "in": "query", "description": "Фильтр по штрафам (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" } }, { "name": "logisticsFrom", "in": "query", "description": "Фильтр по логистике (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" } }, { "name": "logisticsTo", "in": "query", "description": "Фильтр по логистике (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" } }, { "name": "marginFrom", "in": "query", "description": "Фильтр по маржинальности (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" } }, { "name": "marginTo", "in": "query", "description": "Фильтр по маржинальности (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" } }, { "name": "salesAmountFrom", "in": "query", "description": "Фильтр по сумме продаж (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" } }, { "name": "salesAmountTo", "in": "query", "description": "Фильтр по сумме продаж (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" } }, { "name": "totalSalesAmountFrom", "in": "query", "description": "Фильтр по выручке (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" } }, { "name": "totalSalesAmountTo", "in": "query", "description": "Фильтр по выручке (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" } }, { "name": "grossProfitFrom", "in": "query", "description": "Фильтр по валовой прибыли (от)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" } }, { "name": "grossProfitTo", "in": "query", "description": "Фильтр по валовой прибыли (до)", "required": false, "schema": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" } }, { "name": "taxNds", "in": "query", "description": "Налог ндс", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Налог ндс" } }, { "name": "useOsno", "in": "query", "description": "Тип налогообложения осно", "required": false, "schema": { "type": "boolean", "description": "Тип налогообложения осно" } }, { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата начала отчета" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр категорий для которых отдать данные" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Фильтр брендов для которых отдать данные" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций клиента" }, "uniqueItems": true } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64", "description": "Список идентификаторов" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" } }, { "name": "clientOrganizationIds", "in": "query", "description": "Идентификаторы организаций, для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64", "description": "Идентификаторы организаций, для которых отдать данные" } } }, { "name": "ignoreCredit", "in": "query", "description": "Не учитывать кредит в прочих удержаниях", "required": false, "schema": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/CombinedAbcAnalysisResult" } } } } } } } }, "components": { "schemas": { "Address": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "postCode": { "type": "string" }, "country": { "$ref": "#/components/schemas/Country" }, "region": { "$ref": "#/components/schemas/Region" }, "regionId": { "type": "integer", "format": "int32" }, "street": { "type": "string" }, "house": { "type": "string" }, "district": { "type": "string" }, "city": { "type": "string" }, "locality": { "type": "string" }, "building": { "type": "string" }, "flat": { "type": "string" }, "short": { "type": "string" }, "addressId": { "$ref": "#/components/schemas/Address", "writeOnly": true }, "full": { "type": "string" } } }, "AliexpressCategory": { "type": "object", "description": "Категория Aliexpress", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "published": { "type": "boolean" }, "parentId": { "type": "integer", "format": "int64" }, "aliexpressId": { "type": "integer", "format": "int64" }, "lastSyncDate": { "type": "string", "format": "date-time", "description": "Дата последней синхронизации категории" }, "notChangedDays": { "type": "integer", "format": "int32", "description": "Количество дней, в течение которых данные категории не менялась. Используется для того, чтобы сократить обновление категорий, которые не меняются" }, "isLeaf": { "type": "boolean", "description": "Категория является листовой. Карточки можно добавлять только в листовые" } } }, "AvitoCategory": { "type": "object", "description": "Категория Авито", "properties": { "id": { "type": "integer", "format": "int64", "description": "Идентификатор категории на Авито.Совпадает с идентификатором Авито" }, "name": { "type": "string", "description": "Полное название категории (включает в себя названия родительских категорий)" }, "shortName": { "type": "string", "description": "Краткое название категории" }, "published": { "type": "boolean", "description": "Опубликована категория" }, "parentId": { "type": "integer", "format": "int64", "description": "id родительской категории Авито. Используется при импорте обьявлений с Авито" }, "lastSyncDate": { "type": "string", "format": "date-time", "description": "Дата последней синхронизации категории" }, "isLeaf": { "type": "boolean", "description": "Категория является листовой. Карточки можно добавлять только в листовые" }, "goodsType": { "type": "string", "description": "Тег GoodsType в фиде" }, "category": { "type": "string", "description": "Тег Category в фиде" } }, "required": [ "id", "name" ] }, "Brand": { "type": "object", "description": "Бренд", "properties": { "brandId": { "type": "integer", "format": "int32", "description": "Идентификатор бренда", "readOnly": true }, "name": { "type": "string", "description": "Название бренда" }, "clientId": { "type": "integer", "format": "int64", "description": "Идентификатор клиента", "readOnly": true }, "logoUrl": { "type": "string", "description": "Ссылка логотипа бренда", "readOnly": true }, "logoSize": { "type": "integer", "format": "int32", "description": "Размер логотипа в байтах", "readOnly": true }, "logoWidth": { "type": "integer", "format": "int32", "description": "Ширина логотипа в пикселях", "readOnly": true }, "logoHeight": { "type": "integer", "format": "int32", "description": "Высота логотипа в пикселях", "readOnly": true }, "deleted": { "type": "boolean", "description": "Бренд удален?" }, "ozonName": { "type": "string", "description": "Название бренда на Ozon" }, "ozonId": { "type": "integer", "format": "int64", "description": "ID бренда на Ozon" }, "oneCId": { "type": "string", "description": "Идентификатор 1С" } }, "required": [ "name" ] }, "Category": { "type": "object", "description": "Категория", "properties": { "categoryId": { "type": "integer", "format": "int32", "description": "Идентификатор категории. Проставляется автоматически", "readOnly": true }, "name": { "type": "string", "description": "Наименование категории", "maxLength": 255 }, "deleted": { "type": "boolean", "description": "Признак удаленных категорий", "readOnly": true }, "parentId": { "type": "integer", "format": "int32", "description": "Идентификатор родительской категории" }, "clientId": { "type": "integer", "format": "int64", "description": "Идентификатор клиента", "readOnly": true }, "marked": { "type": "boolean", "description": "Маркируется ли категория" }, "categoryClass": { "type": "string", "description": "Тип категории для Честного знака. По умолчанию ставится OTHER", "enum": [ "SHOES", "LIGHT", "DRUGS", "CAMERA", "TYRES", "MILK", "WATER", "TOBACCO", "FURS", "BEER", "BICYCLES", "PERFUMES", "ELECTRONIC", "OTHER", "NONE", "FOOD", "WHEELCHAIRS", "OTP", "NCP", "BIO", "ANTISEPTIC", "NABEER", "SOFTDRINKS", "PETFOOD", "SEAFOOD", "MEAT", "TOYS", "TITAN", "RADIO", "OPTIC_FIBER", "VEGETABLE_OIL", "CONSERVE", "VETPHARMA", "CHEMISTRY", "AUTOFLUIDS", "GROCERY", "BOOKS", "CONSTRUCTION", "FIRE", "HEATER", "CABLERAW", "POLYMER", "SWEETS" ] }, "wildberriesType": { "$ref": "#/components/schemas/WildberriesType", "description": "Предмет Вайлдбериз. Можно устанавливать либо объект,либо только идентификатор" }, "wildberriesCategoryId": { "type": "integer", "format": "int64", "description": "Идентификатор категории Wildberries, совпадает с ID категории на самом Wildberries" }, "wildberriesFbmCommission": { "type": "number", "format": "double", "description": "Комиссия по тарифу FBM", "readOnly": true }, "wildberriesFbwCommission": { "type": "number", "format": "double", "description": "Комиссия по тарифу FBW", "readOnly": true }, "wildberriesFbsCommission": { "type": "number", "format": "double", "description": "Комиссия по тарифу FBS", "readOnly": true }, "wildberriesDbsCommission": { "type": "number", "format": "double", "description": "Комиссия по тарифу DBS", "readOnly": true }, "wildberriesEdbsCommission": { "type": "number", "format": "double", "description": "Комиссия по тарифу EDBS", "readOnly": true }, "wildberriesCAndCCommission": { "type": "number", "format": "double", "description": "Комиссия по тарифу C&C", "readOnly": true }, "wildberriesBookingCommission": { "type": "number", "format": "double", "description": "Комиссия за бронирование", "readOnly": true }, "ozonDescriptionCategoryId": { "type": "integer", "format": "int64", "description": "Идентификатор категории на Ozon. Строится из ID категории + ID типа на Ozon" }, "yandexMarketCategoryId": { "type": "integer", "format": "int64", "description": "Идентификатор категории в Яндекс.Маркет. Совпадает с идентификатором категории на самом Яндекс.Маркет" }, "yandexMarketCategory": { "$ref": "#/components/schemas/YandexMarketCategory", "description": "Категория Яндекс.Маркета. Можно проставлять либо объект, либо только идентификатор" }, "ozonDescriptionCategory": { "$ref": "#/components/schemas/OzonDescriptionCategory", "description": "Категория Озон" }, "ozonCommission": { "type": "number", "format": "double", "description": "Комиссия озона.", "readOnly": true }, "tnved": { "$ref": "#/components/schemas/Tnved", "description": "ТНВЭД. Можно проставлять либо объект, либо идентификатор ТНВЭД" }, "tnvedId": { "type": "integer", "format": "int64", "description": "Идентификатор ТНВЭД" }, "laundry": { "type": "string", "description": "Правила ухода за вещами. Разделяются запятыми" }, "params": { "type": "string", "description": "JSON значений параметров для категории" }, "namePattern": { "type": "string", "description": "Шаблон названий категории" }, "aliexpressCategory": { "$ref": "#/components/schemas/AliexpressCategory", "description": "Категория Aliexpress" }, "aliexpressCategoryId": { "type": "integer", "format": "int64", "description": "Идентификатор категории на самом Aliexpress" }, "avitoCategory": { "$ref": "#/components/schemas/AvitoCategory", "description": "Категория Avito" }, "lamodaCategory": { "$ref": "#/components/schemas/LamodaCategory", "description": "Категория Lamoda" }, "lamodaCategoryId": { "type": "integer", "format": "int64", "description": "Идентификатор категории на Lamoda" }, "avitoCategoryId": { "type": "integer", "format": "int64", "description": "Идентификатор категории на Avito" }, "packDepth": { "type": "integer", "format": "int32", "description": "Глубина упаковки в мм. Проставляется всем товарам в категории" }, "packWidth": { "type": "integer", "format": "int32", "description": "Ширина упаковки в мм. Проставляется всем товарам в категории" }, "packHeight": { "type": "integer", "format": "int32", "description": "Высота упаковки в мм. Проставляется всем товарам в категории" }, "packWeight": { "type": "integer", "format": "int32", "description": "Вес упаковки в граммах. Проставляется всем товарам в категории" }, "hasSize": { "type": "boolean", "description": "Признак разделения товаров в категории по размеру. Меняет вид редактора карточки" }, "hasColor": { "type": "boolean", "description": "Признак разделения товаров в категории по цвету. Меняет вид редактора карточки" }, "autoName": { "type": "boolean", "description": "Автоматически формировать названия товаров в категории" }, "removeFbsStock": { "type": "boolean", "description": "Не передавать остатки товаров по FBS для товаров из этой категории" }, "oneCId": { "type": "string", "description": "Идентификатор категории в 1С" }, "externalId": { "type": "string", "description": "Идентификатор категории на сайте" }, "moySkladId": { "type": "string", "description": "Идентификатор категории в сервисе МойСклад" }, "useClientParams": { "type": "boolean", "description": "Показывать пользовательские параметры в категории" }, "requiredExpirationDate": { "type": "boolean", "description": "Является ли срок годности обязательным параметром" }, "productCount": { "type": "integer", "format": "int32", "description": "Количество товаров в категории. Отдается только при withProductCount=true" } }, "required": [ "name" ] }, "Cell": { "type": "object", "description": "Ячейка хранения товара на складе, в которой может храниться один или несколько товаров", "properties": { "id": { "type": "integer", "format": "int32", "description": "Идентификатор ячейки", "readOnly": true }, "warehouseId": { "type": "integer", "format": "int64", "description": "Склад к которому относится ячейка" }, "passageId": { "type": "integer", "format": "int32", "description": "Проход на складе, к которому относится ячейка. Может соджержать название этажа и пр" }, "shelfId": { "type": "integer", "format": "int32", "description": "Полка стеллажа, к которой относится ячейка" }, "rackId": { "type": "integer", "format": "int32", "description": "Стеллаж, к которому относится ячейка" }, "name": { "type": "string", "description": "Название ячейки. По умолчанию формируется автоматически" }, "fullName": { "type": "string", "description": "Полное название ячейки из названий прохода, стелажа, полки и ячейки" }, "sortName": { "type": "string", "description": "Название для сортировки ячейки из названий прохода, стелажа, полки и ячейки" }, "barcode": { "type": "string", "description": "Уникальный в рамках клиента штрих-код ячейки для идентификации ячейки с помощью сканера штрих-кода. Присваивается автоматически при создании ячейки" }, "deleted": { "type": "boolean", "description": "Признак того, что ячейка удалена" }, "width": { "type": "integer", "format": "int32", "description": "Ширина ячейки для определения товаров, которые можно положить в нее" }, "height": { "type": "integer", "format": "int32", "description": "Высота ячейки для определения товаров, которые можно положить в нее" }, "depth": { "type": "integer", "format": "int32", "description": "Глубина ячейки для определения товаров, которые можно положить в нее" }, "clientId": { "type": "integer", "format": "int64", "description": "Клиент которому принадлежит ячейка. Проставляется автоматически", "readOnly": true }, "lastInventoryId": { "type": "integer", "format": "int32", "description": "Идентификатор последней инвентаризации", "readOnly": true }, "type": { "type": "string", "description": "Тип ячейки: NORMAL, NO_PLACE - не разложенные, REFUND - для возвратов", "enum": [ "NORMAL", "NO_PLACE", "REFUND" ] } } }, "Contractor": { "type": "object", "description": "Контрагенты", "properties": { "id": { "type": "integer", "format": "int64", "description": "Идентификатор контрагента. Проставляется автоматически" }, "name": { "type": "string", "description": "Наименование контрагента", "maxLength": 255 }, "versionId": { "type": "integer", "format": "int64", "description": "Поле нужно передавать при изменении,для предотвращения одновременной перезаписи" }, "clientId": { "type": "integer", "format": "int64", "description": "Идентификатор клиента", "readOnly": true }, "createdUser": { "type": "string", "description": "Логин пользователя, который создал контрагента", "readOnly": true }, "lastIncomeDate": { "type": "string", "format": "date-time", "description": "Дата последнего поступления для этого контрагента для сортировки", "readOnly": true }, "deleted": { "type": "boolean", "description": "Признак удаления контрагента", "readOnly": true }, "organizationId": { "type": "integer", "format": "int64", "description": "Организация для реквизитов контрагента" }, "phoneNumber": { "type": "string", "description": "Номер телефона", "maxLength": 200 }, "email": { "type": "string", "description": "Адрес электронной почты", "maxLength": 200 }, "contactName": { "type": "string", "description": "Имя контакта", "maxLength": 200 }, "moySkladId": { "type": "string", "description": "Идентификатор в сервисе МойСклад" }, "url": { "type": "string", "description": "Ссылка на сайт" }, "organization": { "$ref": "#/components/schemas/Organization", "description": "Организация для документов. Можно передать как сам объект, так и просто organizationId", "readOnly": true } }, "required": [ "name" ] }, "Country": { "type": "object", "description": "Страна", "properties": { "countryId": { "type": "integer", "format": "int32", "description": "Идентификатор страны" }, "name": { "type": "string", "description": "Название страны" }, "code2": { "type": "string", "description": "Двухбуквенный код страны" }, "code3": { "type": "string", "description": "Трехбуквенный код страны" }, "names": { "type": "object", "additionalProperties": { "type": "string" } }, "printName": { "type": "string" } } }, "LamodaCategory": { "type": "object", "description": "Категория Lamoda", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "description": "Название" }, "shortName": { "type": "string", "description": "Краткое название категории" }, "published": { "type": "boolean", "description": "Опубликованность категории" }, "isLeaf": { "type": "boolean", "description": "Листовая категория" }, "parentId": { "type": "integer", "format": "int64" }, "lastSyncDate": { "type": "string", "format": "date-time", "description": "Дата последней синхронизации" }, "notChangedDays": { "type": "integer", "format": "int32", "description": "Количество дней, в течение которых данные категории не менялась. Используется для того, чтобы сократить обновление категорий, которые не меняются" } } }, "Manufacturer": { "type": "object", "description": "Производитель", "properties": { "manufacturerId": { "type": "integer", "format": "int32", "description": "Идентификатор производителя. Генерируется автоматически" }, "title": { "type": "string", "description": "Название производителя внешнее для печати" }, "name": { "type": "string", "description": "Название производителя внутреннее" }, "address": { "type": "string", "description": "Адрес производителя производителя внутреннее" }, "organizationId": { "type": "integer", "format": "int64", "description": "Связь производителя с организацией - контрагентом" }, "clientId": { "type": "integer", "format": "int64", "description": "Идентификатор клиента", "readOnly": true }, "countryId": { "type": "integer", "format": "int32", "description": "Идентификатор страны" }, "countryName": { "type": "string", "description": "Название страны", "readOnly": true }, "inn": { "type": "string", "description": "ИНН производителя, используется в основном для Честного знака" }, "deleted": { "type": "boolean", "description": "Если true - производитель удален" }, "oneCId": { "type": "string", "description": "Идентификатор в 1С" } }, "required": [ "name" ] }, "Option": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Идентификатор значения, может отсутствовать" }, "name": { "type": "string", "description": "Название значения, лучше всегда передавать" }, "paramId": { "type": "integer", "format": "int64", "description": "Идентификатор значения параметра Param.id" }, "ozonId": { "type": "integer", "format": "int64", "description": "Идентификатор значения параметра на Ozon" }, "wildberriesId": { "type": "integer", "format": "int64", "description": "Признак того, что значение параметра WB" }, "ymId": { "type": "integer", "format": "int64", "description": "Признак того, что значение параметра YM" }, "aliexpressId": { "type": "integer", "format": "int64", "description": "Идентификатор значения параметра на Aliexpress" }, "clientId": { "type": "integer", "format": "int64" }, "deleted": { "type": "boolean" }, "oneCId": { "type": "string", "description": "Идентификатор значения параметра в 1С" }, "dictionary": { "type": "boolean" }, "optionId": { "$ref": "#/components/schemas/Option", "writeOnly": true } } }, "Organization": { "type": "object", "description": "Данные об организации", "properties": { "id": { "type": "integer", "format": "int64", "description": "Идентификатор организации. Проставляется автоматически", "readOnly": true }, "name": { "type": "string", "description": "Полное наименование организации" }, "shortName": { "type": "string" }, "taxType": { "type": "string", "description": "Система налогооблажения", "enum": [ "YSN", "YSN_CONSUMPTION", "OSNO", "SELF_EMPLOYED" ] }, "taxRate": { "type": "integer", "format": "int32", "description": "Ставка налога, если она отличается от стандартной" }, "taxNds": { "type": "integer", "format": "int32", "description": "Ставка налога, если она отличается от стандартной" }, "enableNewTaxCalculation": { "type": "boolean", "description": "Включить расчет налогов по новым правилам" }, "useNdsCostPrice": { "type": "boolean", "description": "Учитывать входящий НДС в себестоимости" }, "inn": { "type": "string", "description": "ИНН" }, "kpp": { "type": "string", "description": "КПП. Проставляется только для ООО" }, "bank": { "type": "string", "description": "Название банка" }, "bik": { "type": "string", "description": "БИК счета организации" }, "corrBill": { "type": "string", "description": "Номер корреспондентского счета" }, "billNumber": { "type": "string", "description": "Номер счета организации" }, "stampPath": { "type": "string", "description": "Ссылка на изображение печати организации", "readOnly": true }, "stampUrl": { "type": "string", "description": "Ссылка на изображение печати организации", "readOnly": true }, "stampSize": { "type": "integer", "format": "int32", "description": "Размер в байтах изображения печати организации", "readOnly": true }, "stampWidth": { "type": "integer", "format": "int32", "description": "Ширина изображения печати организации", "readOnly": true }, "stampHeight": { "type": "integer", "format": "int32", "description": "Высота изображения печати организации", "readOnly": true }, "signaturePath": { "type": "string", "description": "Фото подписи директора организации", "readOnly": true }, "signatureUrl": { "type": "string", "description": "Фото подписи директора организации", "readOnly": true }, "signatureSize": { "type": "integer", "format": "int32", "description": "Размер файла в байтах подписи директора организации", "readOnly": true }, "signatureWidth": { "type": "integer", "format": "int32", "description": "Ширина изображения подписи директора", "readOnly": true }, "signatureHeight": { "type": "integer", "format": "int32", "description": "Высота изображения подписи директора", "readOnly": true }, "ipPerson": { "$ref": "#/components/schemas/Person", "description": "Руководитель организации или ИП" }, "form": { "type": "string", "description": "Организационно правовая форма", "enum": [ "OOO", "IP", "SELF_EMPLOYED" ] }, "ip": { "type": "boolean" }, "clientId": { "type": "integer", "format": "int64", "description": "Идентификатор клиента", "readOnly": true }, "address": { "$ref": "#/components/schemas/Address", "description": "Адресс организации" }, "phoneNumber": { "type": "string", "description": "Номер телефона" }, "addressFull": { "type": "string", "description": "Полный адрес", "readOnly": true } }, "required": [ "form", "inn", "name" ] }, "OzonDescriptionCategory": { "type": "object", "description": "Категория Озон", "properties": { "id": { "type": "integer", "format": "int64", "description": "Идентификатор категории на Ozon. Состоит из двух идентификаторов Категории + ID типа на самом Ozon" }, "name": { "type": "string", "description": "Название категории" }, "published": { "type": "boolean" }, "parentId": { "type": "integer", "format": "int64" }, "isLeaf": { "type": "boolean", "description": "Признак листовой категории, в которой могут находиться товары" }, "lastSyncDate": { "type": "string", "format": "date-time", "description": "Дата последней синхронизации категории с Озон" }, "notChangedDays": { "type": "integer", "format": "int32", "description": "Количество дней, в течение которых данные категории не менялась. Используется для того, чтобы сократить обновление категорий, которые не меняются" }, "isError": { "type": "boolean" }, "errorDate": { "type": "string", "format": "date" }, "types": { "type": "string" }, "typeId": { "type": "integer", "format": "int64", "description": "Идентификатор типа на Ozon" } }, "required": [ "name" ] }, "ParamValue": { "type": "object", "description": "Значение параметра", "properties": { "paramId": { "type": "integer", "format": "int64", "description": "Идентификатор параметра" }, "paramName": { "type": "string", "description": "Название параметра, для тех, у кого нет ID" }, "option": { "$ref": "#/components/schemas/Option", "description": "Значение перечислимого параметра" }, "doubleValue": { "type": "number", "format": "double", "description": "Числовое значение параметра" }, "longValue": { "type": "integer", "format": "int64", "description": "Целочисленное значение параметра" }, "booleanValue": { "type": "boolean", "description": "Булево значение параметра" }, "stringValue": { "type": "string", "description": "Строковое значение параметра" }, "dateValue": { "type": "string", "format": "date-time", "description": "Значение параметра даты" }, "service": { "type": "string", "description": "Привязка к сервису параметра", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] }, "unit": { "$ref": "#/components/schemas/Unit", "description": "Единица измерения для параметра" }, "auto": { "type": "boolean", "description": "Автоматически проставленное значение параметра" }, "created": { "type": "integer", "format": "int64", "description": "Дата заполнения параметра" }, "user": { "type": "string", "description": "Пользователь, который заполнил параметр" } }, "required": [ "paramId" ] }, "Person": { "type": "object", "description": "Сотрудник", "properties": { "personId": { "type": "integer", "format": "int64", "readOnly": true }, "firstName": { "type": "string", "description": "Имя сотрудника", "maxLength": 255 }, "lastName": { "type": "string", "description": "Фамилия сотрудника", "maxLength": 255 }, "surName": { "type": "string", "description": "Отчество сотрудника", "maxLength": 255 }, "clientId": { "type": "integer", "format": "int64", "description": "Идентификатор клиента", "readOnly": true }, "position": { "$ref": "#/components/schemas/PersonPosition", "description": "Должность сотрудника" }, "versionId": { "type": "integer", "format": "int64", "description": "Поле нужно передавать при изменении,для предотвращения одновременной перезаписи", "readOnly": true }, "createdUser": { "type": "string", "description": "Проставляется автоматически. Пользователь создавший сотрудника", "readOnly": true }, "createdDate": { "type": "string", "format": "date-time", "description": "Проставляется автоматически. Дата создания сотрудника", "readOnly": true }, "deleted": { "type": "boolean", "description": "Признак удаления сотрудника", "readOnly": true }, "userId": { "type": "integer", "format": "int32", "description": "Связь сотрудника с пользователем", "readOnly": true }, "hasChanges": { "type": "boolean" }, "fullName": { "type": "string", "description": "Полные ФИО", "readOnly": true }, "shortName": { "type": "string", "description": "Фамилия и инициалы", "readOnly": true } }, "required": [ "firstName", "lastName", "position" ] }, "PersonPosition": { "type": "object", "description": "Должность", "properties": { "id": { "type": "integer", "format": "int64", "description": "Идентификатор должности. Проставляется автоматически", "readOnly": true }, "name": { "type": "string", "description": "Название должности", "maxLength": 255 }, "deleted": { "type": "boolean", "description": "Признак удаления должности", "readOnly": true }, "clientId": { "type": "integer", "format": "int64", "description": "Идентификатор клиента", "readOnly": true }, "defaultJobId": { "type": "integer", "format": "int64", "description": "Работа по умолчанию для должности" }, "createdUser": { "type": "string", "description": "Пользователь, который создал должность", "readOnly": true }, "createdDate": { "type": "string", "format": "date-time", "description": "Дата создания должности", "readOnly": true } }, "required": [ "name" ] }, "Product": { "type": "object", "description": "Товар - уникальный с точки зрения подтребительских свойств товар.", "properties": { "id": { "type": "integer", "format": "int64", "description": "Идентификатор товара. Проставляется автоматически" }, "productType": { "type": "string", "description": "Тип товара", "enum": [ "PRODUCT", "SET", "SERVICE", "DIGITAL" ] }, "name": { "type": "string", "description": "Наименование товара внутреннее", "maxLength": 240 }, "deleted": { "type": "boolean", "description": "Признак удаления товара", "readOnly": true }, "printName": { "type": "string", "description": "Название товара для внешних сервисов. Если не задано, проставляется равным наименованию товара", "maxLength": 240 }, "realSize": { "type": "string", "description": "Российский размер товара для одежды или характеристики для других категорий", "maxLength": 255 }, "vendorSize": { "type": "string", "description": "Размер производителя или характеристики производителя. Не обязательно заполнять", "maxLength": 200 }, "size": { "type": "string", "description": "Размер для одежды или характеристики для внешних сервисов. Должен быть уникальным в рамках цвета", "maxLength": 200 }, "wildberriesImtId": { "type": "integer", "format": "int64", "description": "Используется для категорий, у которых не предусмотрен размер", "readOnly": true }, "wildberriesStockCount": { "type": "integer", "format": "int32", "description": "Остатки товара на Вайлдбериз", "readOnly": true }, "ozonId": { "type": "integer", "format": "int64", "description": "Идентификатор товара Озон на сайте. SKU в озон", "readOnly": true }, "ozonRealFbs": { "type": "boolean", "description": "Признак использования RealFbs для товара", "readOnly": true }, "ozonProductId": { "type": "integer", "format": "int64", "description": "Идентификатор товара Озон в кабинете API", "readOnly": true }, "wildberriesSizeId": { "type": "integer", "format": "int64", "description": "Идентификатор размера на Вайлдбериз", "readOnly": true }, "simalandId": { "type": "integer", "format": "int64", "description": "Уникальный идентификатор товара для Simaland" }, "ozonArticle": { "type": "string", "description": "Уникальный артикул товара для озон. Offer ID в озон", "maxLength": 255 }, "externalArticle": { "type": "string", "description": "Уникальный артикул товара для стороннего сервиса", "maxLength": 255 }, "uzumArticle": { "type": "string", "description": "Уникальный артикул товара для Uzum", "maxLength": 255 }, "ozonStockCount": { "type": "integer", "format": "int32", "description": "Остаток товара на складах Озон", "readOnly": true }, "ozonStockBetweenWarehouses": { "type": "integer", "format": "int32", "description": "Остаток товара в Озон, которые перемещаются между складами", "readOnly": true }, "removeFbsStock": { "type": "boolean", "description": "Не выгружать остатки товара на маркетплейсы" }, "purchaseCurrency": { "type": "string", "description": "Валюта закупочной цены товара", "enum": [ "RUB", "USD", "EUR", "AUD", "AZN", "GBP", "AMD", "BYN", "BGN", "BRL", "HUF", "VND", "HKD", "GEL", "DKK", "AED", "EGP", "INR", "IDR", "KZT", "CAD", "QAR", "KGS", "CNY", "MDL", "NZD", "NOK", "PLN", "RON", "XDR", "SGD", "TJS", "THB", "TRY", "TMT", "UZS", "UAH", "CZK", "SEK", "CHF", "RSD", "ZAR", "KRW", "JPY" ] }, "purchasePriceInCurrency": { "type": "number", "format": "double", "description": "Цена закупки в валюте" }, "deliveryCostInCurrency": { "type": "number", "format": "double", "description": "Цена на доставку в валюте" }, "versionId": { "type": "integer", "format": "int64", "description": "Поле нужно передавать при изменении,для предотвращения одновременной перезаписи" }, "createdDate": { "type": "string", "format": "date-time", "description": "Дата создания товара на МП", "readOnly": true }, "created": { "type": "string", "format": "date-time", "description": "Дата создания товара в SelSup", "readOnly": true }, "createdUser": { "type": "string", "description": "Пользователь, который создал товар", "readOnly": true }, "sourceIncomeItemId": { "type": "integer", "format": "int64", "description": "Идентификатор товара из заказа поставщика по данным которого был создан товар" }, "sourceProductId": { "type": "integer", "format": "int64", "description": "Идентификатор товара, который копировали" }, "ozonRequiredStock": { "type": "integer", "format": "int32", "description": "Расчитанное количество товара, для поставки на склад Озон", "readOnly": true }, "wildberriesRequiredStock": { "type": "integer", "format": "int32", "description": "Расчитанное количество товара, для поставки на склад Wildberries", "readOnly": true }, "wildberriesProfit": { "type": "number", "format": "double", "description": "Профит с продажи товара на Вайлдбериз по FBM", "readOnly": true }, "wildberriesProfitFbs": { "type": "number", "format": "double", "description": "Профит с продажи товара на Вайлдбериз по FBS", "readOnly": true }, "wildberriesOrderQuantity": { "type": "integer", "format": "int32", "description": "Количество заказов по FBO товара на Вайлдбериз за 2 недели", "readOnly": true }, "wildberriesSupplyingQuantity": { "type": "integer", "format": "int32", "description": "Поставляемое количество товара на Вайлдбериз по FBM заказам", "readOnly": true }, "wildberriesQuantityInWayToClient": { "type": "integer", "format": "int32", "description": "Поставляемое количество товара на Вайлдбериз по FBM заказам к клиенту", "readOnly": true }, "wildberriesQuantityInWayFromClient": { "type": "integer", "format": "int32", "description": "Поставляемое количество товара на Вайлдбериз по FBM заказам от клиента", "readOnly": true }, "wildberriesSaleQuantity": { "type": "integer", "format": "int32", "description": "Продажи товара на Вайлдбериз по FBM за 2 недели", "readOnly": true }, "wildberriesQuantityInWay": { "type": "integer", "format": "int32", "description": "Количество товаров на Вайлдбериз в пути", "readOnly": true }, "wildberriesNoSale": { "type": "boolean", "description": "Признак неликвидного товара на Вайлдбериз", "readOnly": true }, "lastStockChange": { "type": "string", "format": "date-time", "description": "Дата последнего изменения стока на Вайлдбериз по FBM", "readOnly": true }, "ozonOrderQuantity": { "type": "integer", "format": "int32", "description": "Количество заказов товара по FBO на Озон по FBM и FBS за 2 недели", "readOnly": true }, "ozonSupplyingQuantity": { "type": "integer", "format": "int32", "description": "Поставляемое количество товара на Озон по FBM", "readOnly": true }, "ozonProfit": { "type": "integer", "format": "int32", "description": "Чистая маржа продажи товара на Озон по FBM", "readOnly": true }, "instockQuantity": { "type": "integer", "format": "int32", "description": "Остатки товара на складах клиента", "readOnly": true }, "calculatedInStockQuantity": { "type": "integer", "format": "int32", "description": "Рассчитанный остаток", "readOnly": true }, "ozonFbsSku": { "type": "integer", "format": "int64", "description": "Идентификатор товара в Озон по FBS", "readOnly": true }, "ozonFboSku": { "type": "integer", "format": "int64", "description": "Идентификатор товара в Озон по FBO", "readOnly": true }, "sellerSku": { "type": "string", "description": "Идентификатор товара на Amazon" }, "clientId": { "type": "integer", "format": "int64", "description": "Идентификатор клиента", "readOnly": true }, "organizationId": { "type": "integer", "format": "int64", "description": "Идентификатор организации" }, "productViewId": { "type": "integer", "format": "int64", "description": "Идентификатор цвета", "readOnly": true }, "view": { "$ref": "#/components/schemas/ProductView", "description": "Информация о цвете товара", "readOnly": true }, "suzId": { "type": "string", "description": "GTIN товара" }, "cisType": { "type": "string", "description": "Тип в национальном каталоге", "enum": [ "UNIT", "BUNDLE", "GROUP", "SET", "ATK" ] }, "notChangedStock": { "type": "integer", "format": "int32", "description": "Количество дней, в течении которых не менялся остаток товара", "readOnly": true }, "nationalCatalogFeedId": { "type": "integer", "format": "int64", "description": "Идентификатор создания карточки в национальном каталоге", "readOnly": true }, "wildberriesStatus": { "type": "string", "description": "Статус создания карточки товара в Вайлдбериз", "enum": [ "UNKNOWN", "CREATING", "CREATED", "SUCCESS", "ERROR", "UPDATING", "EXCEPTION", "SIGN", "MODERATION" ], "readOnly": true }, "wildberriesMessage": { "type": "string", "description": "Ошибка создания карточки товара в Вайлдбериз", "readOnly": true }, "wildberriesMessageParams": { "type": "string", "description": "JSON параметров ошибки создания карточки товара в Вайлдбериз", "readOnly": true }, "nationalCatalogStatus": { "type": "string", "description": "Статус создания карточки товара в Национальном каталоге", "enum": [ "UNKNOWN", "CREATING", "CREATED", "SUCCESS", "ERROR", "UPDATING", "EXCEPTION", "SIGN", "MODERATION" ], "readOnly": true }, "nationalCatalogGoodId": { "type": "integer", "format": "int64", "description": "Идентификатор товара в национальном каталоге", "readOnly": true }, "nationalCatalogMessage": { "type": "string", "description": "Ошибка создания карточки товара в Национальном каталоге", "readOnly": true }, "nationalCatalogMessageParams": { "type": "string", "description": "Параметры ошибки создания карточки товара в Национальном каталоге", "readOnly": true }, "ozonStatus": { "type": "string", "description": "Статус создания карточки товара в Озон", "enum": [ "UNKNOWN", "CREATING", "CREATED", "SUCCESS", "ERROR", "UPDATING", "EXCEPTION", "SIGN", "MODERATION" ], "readOnly": true }, "ozonMessage": { "type": "string", "description": "Ошибка создания карточки товара в Озон", "readOnly": true }, "ozonMessageParams": { "type": "string", "description": "JSON параметры ошибки создания карточки товара в Озон", "readOnly": true }, "ozonTaskId": { "type": "integer", "format": "int64", "description": "Идентификатор задания по обновления или созданию карточки в Озон", "readOnly": true }, "wildberriesFbsOrdersQuantity": { "type": "integer", "format": "int32", "description": "Кол-во заказанных товаров на данной карточке WB по FBS за 2 недели", "readOnly": true }, "ozonFbsOrdersQuantity": { "type": "integer", "format": "int32", "description": "Кол-во заказанных товаров на данной карточке на Ozon по FBS за 2 недели", "readOnly": true }, "ymarketFbsOrdersQuantity": { "type": "integer", "format": "int32", "description": "Кол-во заказанных товаров на данной карточке на Яндекс Маркете по FBS за 2 недели", "readOnly": true }, "totalSupplyingQuantity": { "type": "integer", "format": "int32", "description": "Кол-во заказанных товаров на данной карточке за 2 недели", "readOnly": true }, "skuId": { "type": "integer", "format": "int64", "description": "Идентификатор единицы хранения товара на складе. Проставляется автоматически", "readOnly": true }, "sku": { "$ref": "#/components/schemas/Sku" }, "barcodes": { "type": "array", "description": "Штрих-коды товара", "items": { "$ref": "#/components/schemas/ProductBarcode" } }, "params": { "type": "string", "description": "JSON значений параметров для данного размера/характеристик" }, "values": { "type": "array", "description": "Значения параметров карточки. Отдаются при запросе модели, если передать params=true", "items": { "$ref": "#/components/schemas/ParamValue" } }, "group": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Product" }, "description": "Группа карточек. Используется на списке товаров, чтобы объединить разные размеры в одну строку", "readOnly": true }, "duplicates": { "type": "array", "description": "Дубликаты карточки по остаткам. Отдаются только на списке товаров, если включена галочка Объединять дубликаты", "items": { "$ref": "#/components/schemas/Product" }, "readOnly": true }, "hasChanges": { "type": "boolean", "description": "Признак наличия изменений в товаре и ее нужно обновить при сохранении" }, "ignoreDuplicate": { "type": "boolean", "description": "Признак игнорирования дубликатов при создании" }, "yandexMarketSku": { "type": "integer", "format": "int64", "description": "Идентификатор карточки товара на Yandex.Market", "readOnly": true }, "yandexMarketStockCount": { "type": "integer", "format": "int64", "description": "Остаток товара на складах Yandex.Market", "readOnly": true }, "yandexMarketProductId": { "type": "integer", "format": "int64", "description": "Идентификатор карточки товара на Yandex.Market", "readOnly": true }, "yandexMarketShopSku": { "type": "string", "description": "SKU товара на Yandex.Market" }, "groupId": { "type": "integer", "format": "int64", "description": "ID групповой карточки" }, "yandexMarketStatus": { "type": "string", "description": "Статус создания карточки товара на яндекс маркет", "enum": [ "UNKNOWN", "CREATING", "CREATED", "SUCCESS", "ERROR", "UPDATING", "EXCEPTION", "SIGN", "MODERATION" ], "readOnly": true }, "yandexMarketMessage": { "type": "string", "description": "Сообщение при ошибке создания карточки товара на яндекс маркет", "readOnly": true }, "yandexMarketMessageParams": { "type": "string", "description": "Параметры сообщения при создании товара в Яндекс.Маркет", "readOnly": true }, "sberArticle": { "type": "string", "description": "Артикул товара на СберМегаМаркет" }, "siteArticle": { "type": "string", "description": "артикул товара на сайте" }, "siteId": { "type": "string", "description": "айди товара на сайте" }, "leroyMerlinArticle": { "type": "string", "description": "Артикул товара на Леруа Мерлен" }, "ebayArticle": { "type": "string", "description": "Артикул товара на Ebay" }, "lamodaArticle": { "type": "string", "description": "Артикул товара на Lamoda" }, "lamodaSku": { "type": "string", "description": "SKU товара на Lamoda" }, "leroyMerlinId": { "type": "string", "description": "Номер карточки на Леруа Мерлен" }, "duplicate": { "type": "boolean", "description": "Признак, что карточка является дубликатом. Отдается не для всех методов", "readOnly": true }, "ozonHasPhoto": { "type": "boolean", "description": "Признак наличия фото на Ozon", "readOnly": true }, "aliexpressSku": { "type": "string", "description": "SKU на Aliexpress" }, "aliexpressStatus": { "type": "string", "description": "Статус создания товара на Aliexpress", "enum": [ "UNKNOWN", "CREATING", "CREATED", "SUCCESS", "ERROR", "UPDATING", "EXCEPTION", "SIGN", "MODERATION" ], "readOnly": true }, "aliexpressMessage": { "type": "string", "description": "Сообщение при создании товара на Aliexpress", "readOnly": true }, "aliexpressMessageParams": { "type": "string", "description": "Параметры сообщения при создании товара на Aliexpress", "readOnly": true }, "moySkladId": { "type": "string", "description": "ID товара в сервисе Мой Склад", "readOnly": true }, "moySkladType": { "type": "string", "description": "Тип товара в сервисе Мой Склад", "readOnly": true }, "avitoId": { "type": "integer", "format": "int64", "description": "ID товара в сервисе Avito", "readOnly": true }, "moySkladLinkId": { "type": "string", "description": "ID для ссылки на Мой Склад", "readOnly": true }, "moySkladStatus": { "type": "string", "description": "Статус создания карточки товара в МойСклад", "enum": [ "UNKNOWN", "CREATING", "CREATED", "SUCCESS", "ERROR", "UPDATING", "EXCEPTION", "SIGN", "MODERATION" ], "readOnly": true }, "avitoStatus": { "type": "string", "description": "Статус обьявления на Авито", "enum": [ "UNKNOWN", "CREATING", "CREATED", "SUCCESS", "ERROR", "UPDATING", "EXCEPTION", "SIGN", "MODERATION" ], "readOnly": true }, "moySkladMessage": { "type": "string", "description": "Ошибка создания карточки товара в МойСклад", "readOnly": true }, "moySkladMessageParams": { "type": "string", "description": "Параметры ошибки создания карточки товара в МойСклад", "readOnly": true }, "oneCId": { "type": "string", "description": "Идентификатор товара в 1С" }, "removeFbsStockOzon": { "type": "boolean", "description": "Не передавать остатки товара по FBS на озон" }, "removeFbsStockWb": { "type": "boolean", "description": "Не передавать остатки товара по FBS на Wildberries" }, "removeFbsStockAli": { "type": "boolean", "description": "Не передавать остатки товара по FBS на Aliepress" }, "removeFbsStockYm": { "type": "boolean", "description": "Не передавать остатки товара по FBS на Яндекс.Маркет" }, "removeFbsStockSber": { "type": "boolean", "description": "Не передавать остатки товара по FBS на СберМегаМаркет" }, "quantity": { "type": "integer", "format": "int32", "description": "Количество товара в заказах. Возвращается только в методах income/getProductsFromOrders или wms/findStock", "readOnly": true }, "incomeQuantity": { "type": "integer", "format": "int32", "description": "Количество товара в закупке без разделения по маркетплейсам" }, "orderMinDate": { "type": "string", "format": "date-time", "description": "Минимальная дата заказа. Возвращается только в методах income/getProductsFromOrders", "readOnly": true }, "expiredDate": { "type": "string", "format": "date-time", "description": "Cрок годности товара - возвращается только в методах, wms/findStock", "readOnly": true }, "productionDate": { "type": "string", "format": "date-time", "description": "Дата производства", "readOnly": true }, "stock": { "type": "integer", "format": "int32", "description": "Остаток товара на определенном складе - возвращается только в методах, wms/fetchStock", "readOnly": true }, "stocks": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ProductStock" }, "description": "Остатки товара на складах - возвращается только в методах, wms/fetchStock", "readOnly": true }, "cell": { "$ref": "#/components/schemas/Cell", "description": "Ячейка хранения товара на определенном складе - возвращается только в методах, wms/fetchStock", "readOnly": true }, "reserved": { "type": "integer", "format": "int32", "description": "Остаток товара на определенном складе - возвращается только в методах, wms/fetchStock", "readOnly": true }, "calculatedStock": { "type": "integer", "format": "int32", "description": "Остаток наборов на определенном складе - возвращается только в методах, wms/fetchStock, product/findProduct, supply/findProductForOrder", "readOnly": true }, "price": { "type": "number", "format": "double", "description": "Розничная цена товара" }, "updatedPrice": { "type": "number", "format": "double", "description": "Новая общая цена товара со скидкой. Только для методов обновления цены" }, "priceWithoutDiscount": { "type": "number", "format": "double", "description": "Розничная цена товара без учета скидки" }, "updatedPriceWithoutDiscount": { "type": "number", "format": "double", "description": "Измененная розничная цена товара без учета скидки. Принимается только в методах обновления цены" }, "updatedDeliveryCost": { "type": "number", "format": "double", "description": "Измененные прочие расходы товара Принимается только в методах обновления цены" }, "updatedPurchasePrice": { "type": "number", "format": "double", "description": "Измененная закупочная цена товара Принимается только в методах обновления цены" }, "purchasePrice": { "type": "number", "format": "double", "description": "Закупочная цена товара в руб." }, "isPurchasePriceUpdated": { "type": "boolean", "description": "Признак, была ли изменена закупочная цена" }, "isDeliveryCostUpdated": { "type": "boolean", "description": "Признак, изменения прочих расходов на товар." }, "wholesalePrice": { "type": "number", "format": "double", "description": "Оптовая цена товара" }, "deliveryCost": { "type": "number", "format": "double", "description": "Дополнительные расходы на доставку товара в руб. Добавляются к закупочной цене" }, "strategyId": { "type": "integer", "format": "int64", "description": "Идентификатор стратегии ценообразования" }, "ozonAverageExpenses": { "type": "number", "format": "double", "description": "Расходы по продаже товара на Ozon", "readOnly": true }, "wildberriesAverageExpenses": { "type": "number", "format": "double", "description": "Расходы по продаже товара на Wildberries", "readOnly": true }, "yandexMarketAverageExpenses": { "type": "number", "format": "double", "description": "Расходы по продаже товара на ЯМ", "readOnly": true }, "wildberriesSale": { "type": "integer", "format": "int32", "description": "Скидка товара на Вайлдбериз", "readOnly": true }, "minPrice": { "type": "number", "format": "double", "description": "Минимальная цена товара. Ниже этой цены нельзя выставлять цену на товар.Используется для Ozon при участии товара в акциях" }, "ozonPromotionPrice": { "type": "number", "format": "double", "description": "Текущая акционная цена товара на Озон", "readOnly": true }, "ozonAcquiringPercent": { "type": "number", "format": "double", "description": "Максимальная комиссия за эквайринг OZON", "readOnly": true }, "ozonComisson": { "type": "number", "format": "double", "description": "Комиссия товара на Озон FBM", "readOnly": true }, "sberMegaMarketSupplyingQuantity": { "type": "integer", "format": "int32", "description": "Поставляемое количество товара на СберМегаМаркет по FBM заказам", "readOnly": true }, "yandexMarketSupplyingQuantity": { "type": "integer", "format": "int32", "description": "Поставляемое количество товара на Яндекс.Маркет по FBM заказам", "readOnly": true }, "oneCArticle": { "type": "string", "description": "Уникальный артикул товара для 1c", "maxLength": 255 }, "salesExpensesOnMpPercent": { "type": "number", "format": "double", "description": "Расходы по продажам на маркетплейсе, %" }, "salesCountCoefficient": { "type": "number", "format": "double", "description": "Коэффициент пересчета продаж и возвратов в товарной аналитике" }, "measureUnitId": { "type": "integer", "format": "int32", "description": "Единица измерения товара (ID единицы измерения)" }, "taxeRate": { "type": "number", "format": "double", "description": "Установленый процент налога на товар, %" }, "desiredMarginalityPercent": { "type": "number", "format": "double", "description": "Желаемый % маржинальности" }, "desiredProfitRub": { "type": "number", "format": "double", "description": "Желаемая прибыль, руб." }, "additionalCost": { "type": "number", "format": "double", "description": "Доп. расходы на товар без записи в Финансовую аналитику, руб." }, "sberMegaMarketId": { "type": "integer", "format": "int64", "description": "Карточка СберМегаМаркет" }, "packWidth": { "type": "integer", "format": "int32", "description": "Ширина в упаковке мм. Имеет больший приоритет, чем значение в модели или категории, отдается на маркетплейсы" }, "packHeight": { "type": "integer", "format": "int32", "description": "Высота в упаковке мм. Имеет больший приоритет, чем значение в модели или категории, отдается на маркетплейсы" }, "packDepth": { "type": "integer", "format": "int32", "description": "Длина/глубина в упаковке мм. Имеет больший приоритет, чем значение в модели или категории, отдается на маркетплейсы" }, "packWeight": { "type": "integer", "format": "int32", "description": "Вес в упаковке гр. Имеет больший приоритет, чем значение в модели или категории, отдается на маркетплейсы" }, "numOfPiecesInBox": { "type": "integer", "format": "int32", "description": "Количество штук в коробе" }, "lastWildberriesSaleDate": { "type": "string", "format": "date-time", "description": "Дата последней продажи на Wildberries" }, "lastWildberriesOrderDate": { "type": "string", "format": "date-time", "description": "Дата последнего заказа на Wildberries" }, "lastOzonSaleDate": { "type": "string", "format": "date-time", "description": "Дата последней продажи на OZON" }, "lastOzonOrderDate": { "type": "string", "format": "date-time", "description": "Дата последнего заказа на OZON" }, "totalOrdersCount": { "type": "integer", "format": "int32", "description": "Кол-во заказанных товаров на данной карточке по МП OZON + WB", "readOnly": true }, "totalFbsOrdersCount": { "type": "integer", "format": "int32", "description": "Кол-во заказанных товаров на данной карточке по FBS за 2 недели", "readOnly": true }, "wildberriesTotalOrdersCount": { "type": "integer", "format": "int32", "description": "Кол-во заказанных товаров на данной карточке по МП WB", "readOnly": true }, "ignoreFbsWarehouses": { "type": "string", "description": "Список идентификаторов складов маркетплейсов через запятую - на которые не отправлять остатки по FBS" }, "fbsWarehouses": { "type": "string", "description": "Список идентификаторов складов маркетплейсов через запятую - на которые не отправлять остатки по FBS" }, "minFbsStock": { "type": "integer", "format": "int32", "description": "Минимальный остаток - если меньше, то ставим 0" }, "maxFbsStock": { "type": "integer", "format": "int32", "description": "Максимальный остаток - если больше, то ставим его" }, "wildberriesSaleLogistic": { "type": "number", "format": "double", "description": "Логистика WB, руб." }, "wildberriesReturnLogistic": { "type": "number", "format": "double", "description": "Обратная логистика WB, руб." }, "wildberriesTotalLogistics": { "type": "number", "format": "double", "description": "Логистика WB итого, руб." }, "wildberriesWarehouseRatio": { "type": "number", "format": "double", "description": "Коэффициент склада WB в %" }, "wildberriesComission": { "type": "number", "format": "double", "description": "Комиссия WB, %" }, "ozonSaleLogistic": { "type": "number", "format": "double", "description": "Логистика Ozon, руб." }, "ozonReturnLogistic": { "type": "number", "format": "double", "description": "Обратная логистика Ozon, руб." }, "ozonCommission": { "type": "number", "format": "double", "description": "Комиссия Ozon, %" }, "maxDeliveryToPickupPoint": { "type": "number", "format": "double", "description": "Максимальная стоимость доставки до места выдачи, руб." }, "ozonPurchasePercent": { "type": "number", "format": "double", "description": "Процент выкупа Ozon, %" }, "wildberriesPurchasePercent": { "type": "number", "format": "double", "description": "Процент выкупа WB, %" }, "minMarginality": { "type": "number", "format": "double", "description": "Настройки репрайсера Min % маржинальности" }, "maxMarginality": { "type": "number", "format": "double", "description": "Настройки репрайсера Max % маржинальности" }, "minProfit": { "type": "number", "format": "double", "description": "Настройки репрайсера Min прибыль, руб." }, "maxProfit": { "type": "number", "format": "double", "description": "Настройки репрайсера Max прибыль, руб." }, "minPriceWithDiscount": { "type": "number", "format": "double", "description": "Настройки репрайсера Min цена со скидкой, руб." }, "maxPriceWithDiscount": { "type": "number", "format": "double", "description": "Настройки репрайсера Max цена со скидкой, руб." }, "oldWildberriesPriceWithDiscount": { "type": "number", "format": "double", "description": "При установки через репрайсер скидку, заполняется, после удаление скидки, возвращает как основная цена и значение затирается" }, "oldWildberriesSale": { "type": "integer", "format": "int32", "description": "Скидка товара на Вайлдбериз до установки новой по репрайсеру, при возврате нужно проставлять null" }, "wildberriesPromoProfit": { "type": "number", "format": "double", "description": "Расчетный профит по акциям WB нужен для определения какая акция выгодная" }, "wildberriesMarginality": { "type": "number", "format": "double", "description": "Расчетная маржинальность по WB" }, "wildberriesPromoId": { "type": "integer", "format": "int64", "description": "Идентификатор акции на ВБ" }, "oldWildberriesPromoSalePercent": { "type": "number", "format": "double", "description": "Расчетная маржинальность по WB" }, "oldWildberriesPromoPriceWithDiscount": { "type": "number", "format": "double", "description": "Расчетная маржинальность по WB" }, "endWildberriesPriceWithSppConfig": { "type": "number", "format": "double", "description": "Цена для пользователя конечная с СПП. " }, "ozonFbsCommission": { "type": "number", "format": "double", "description": "Комиссия ОЗОН ФБС " }, "ozonFboCommission": { "type": "number", "format": "double", "description": "Комиссия ОЗОН ФБО " }, "wbTotalSalesCount": { "type": "integer", "format": "int64", "description": "Общее кол-во продажи - возвраты, начиная с подсчета процента выкупа по ВБ" }, "ozonTotalSalesCount": { "type": "integer", "format": "int64", "description": "Общее кол-во продажи - возвраты, начиная с подсчета процента выкупа по OZON" }, "sberTotalSalesCount": { "type": "integer", "format": "int64", "description": "Общее кол-во продажи - возвраты, начиная с подсчета процента выкупа по SBER" }, "yandexTotalSalesCount": { "type": "integer", "format": "int64", "description": "Общее кол-во продажи - возвраты, начиная с подсчета процента выкупа по YANDEX" }, "ozonRaiting": { "type": "number", "format": "double", "description": "Рейтинг товара на Ozon", "readOnly": true }, "ozonFeedbackCount": { "type": "integer", "format": "int32", "description": "Количество отзывов на товар на Ozon", "readOnly": true }, "fboStockCount": { "type": "integer", "format": "int64", "description": "Остаток ФБО по выбранным складам/регионам" }, "fbsStockCount": { "type": "integer", "format": "int64", "description": "Остаток ФБC для планирования поставок)" }, "stockCoverageDays": { "type": "integer", "format": "int64", "description": "На сколько дней хватит текущего остатка ФБО на складе" }, "fboSupplyQuantity": { "type": "integer", "format": "int64", "description": "Количество поставляемого товара по выбранным складам/регионам" }, "fboSales": { "type": "integer", "format": "int64", "description": "Кол-во продаж FBO по складам/регионам для планирования поставок" }, "fbsSales": { "type": "integer", "format": "int64", "description": "Кол-во продаж FBS по складам/регионам для планирования поставок" }, "fboOrders": { "type": "integer", "format": "int64", "description": "Кол-во заказов FBO по складам/регионам для планирования поставок" }, "fbsOrders": { "type": "integer", "format": "int64", "description": "Кол-во заказов FBS по складам/регионам для планирования поставок" }, "recommendPlan": { "type": "number", "format": "double", "description": "Кол-во товара для добавления к заказу" }, "skipDaysCount": { "type": "integer", "format": "int32", "description": "Кол-во пропущенных дней в учёте планирования поставок" }, "organizationShortName": { "type": "string" }, "contractorName": { "type": "string" }, "supplyPlanBarcode": { "type": "string" }, "planCorrectionFactor": { "type": "number", "format": "double", "description": "Коэффициент коррекции для планирования поставок. На это значение умножается рассчитанное количество товара для поставки" }, "orderBefore": { "type": "integer", "format": "int32", "description": "До какого времени должен быть сделан заказ от 1 до 24" }, "daysBeforeSupply": { "type": "integer", "format": "int32", "description": "Кол-во дней до поставки. Через сколько дней с момента заказа ориентировочно будет поставка товаров" }, "supplyPlanDays": { "type": "integer", "format": "int32", "description": "На сколько дней планировать остаток" }, "warehouseIdForSupplyReport": { "type": "integer", "format": "int64", "description": "Id склада на который нужно поставить рассчитанные товары. Используется только в планировании поставок", "readOnly": true }, "warehouseNameForSupplyReport": { "type": "string", "description": "Название склада на который нужно поставить рассчитанные товары. Используется только в планировании поставок", "readOnly": true }, "wbCanBox": { "type": "boolean", "description": "Можно ли отгружать товар на склад WB в коробах", "readOnly": true }, "wbCanMonopallet": { "type": "boolean", "description": "Можно ли отгружать товар на склад WB в монопаллете", "readOnly": true }, "wbCanSupersafe": { "type": "boolean", "description": "Можно ли отгружать товар на склад WB в Supersafe", "readOnly": true }, "wbCanBoxOnPallet": { "type": "boolean", "description": "Можно ли отгружать товар на склад WB в коробах на паллете", "readOnly": true }, "manager": { "type": "string", "description": "Поле менеджера" }, "cellId": { "type": "integer", "format": "int32" }, "drrPercent": { "type": "integer", "format": "int32", "description": "ДРР% - доля рекламных расходов" }, "percentForParticipationPromoOrAdvertising": { "type": "integer", "format": "int32", "description": "Закладываемый % для участия в акциях или рекламе" }, "selsupLink": { "type": "string" }, "tempId": { "type": "integer", "format": "int64", "description": "Временный id используется для быстрого импорта" }, "category": { "$ref": "#/components/schemas/Category" }, "walmartSku": { "type": "string", "description": "SKU товара на Walmart" }, "walmartId": { "type": "string", "description": "Id товара на Walmart (WPID)" }, "findirTips": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Советы задачника (тип задачи - текст совета)" }, "woocomSku": { "type": "string", "description": "SKU товара на WooCommerce" }, "woocomId": { "type": "integer", "format": "int64", "description": "Id товара на WooCommerce" }, "woocomPermalink": { "type": "string", "description": "Ссылка на товар в WooCommerce" }, "commissions": { "type": "string", "description": "JSON с комиссиями из разных маркетплейсов" }, "lowStockAlerts": { "type": "string", "description": "JSON для уведомлений о заканчивающихся остатках по маркетплейсов" }, "inputVat": { "type": "number", "format": "double", "description": "Входящий НДС, руб." }, "outputVat": { "type": "number", "format": "double", "description": "Исходящий НДС, руб." }, "finalVat": { "type": "number", "format": "double", "description": "Итоговый НДС (исходящий - входящий), руб." }, "incomeTax": { "type": "number", "format": "double", "description": "Налог на прибыль, руб." }, "totalTax": { "type": "number", "format": "double", "description": "Общий налог (НДС + налог на прибыль), руб." }, "woocomStatus": { "type": "string", "description": "Статус создания карточки товара в WooCommerce", "enum": [ "UNKNOWN", "CREATING", "CREATED", "SUCCESS", "ERROR", "UPDATING", "EXCEPTION", "SIGN", "MODERATION" ], "readOnly": true }, "woocomParentId": { "type": "integer", "format": "int64", "description": "ID родительского товара в WooCommerce (для вариаций)" }, "opencartSku": { "type": "string", "description": "SKU товара в OpenCart" }, "opencartId": { "type": "integer", "format": "int64", "description": "Id товара в OpenCart" }, "dateStartSeason1": { "type": "string", "format": "date", "description": "Дата начала сезона 1 " }, "dateEndSeason1": { "type": "string", "format": "date", "description": "Дата окончания сезона 1 " }, "dateStartSeason2": { "type": "string", "format": "date", "description": "Дата начала сезона 2 " }, "dateEndSeason2": { "type": "string", "format": "date", "description": "Дата окончания сезона 2 " }, "dateStartSeason3": { "type": "string", "format": "date", "description": "Дата начала сезона 3 " }, "dateEndSeason3": { "type": "string", "format": "date", "description": "Дата окончания сезона 3 " }, "dateStartSeason4": { "type": "string", "format": "date", "description": "Дата начала сезона 4 " }, "dateEndSeason4": { "type": "string", "format": "date", "description": "Дата окончания сезона 4 " }, "currentGrossProfit": { "type": "object", "additionalProperties": { "type": "number", "format": "double" }, "description": "Текущая валовая прибыль. Для таблицы цены" }, "plannedGrossProfit": { "type": "object", "additionalProperties": { "type": "number", "format": "double" }, "description": "Новая валовая прибыль. Для таблицы цены" }, "magnitId": { "type": "string", "description": "Id товара на Magnit" }, "magnitArticle": { "type": "string", "description": "Артикль товара на Magnit" }, "detmirId": { "type": "string", "description": "Id товара на сайте Детского мира (для ссылки на карточку)" }, "detmirArticle": { "type": "string", "description": "Артикул товара на Детском мире (productCode / SAP)" }, "magnitSku": { "type": "string", "description": "SKU товара на Magnit" }, "mvideoArticle": { "type": "string", "description": "Артикул товара на M.Video" }, "takealotSku": { "type": "string", "description": "SKU товара на Takealot" }, "position": { "type": "integer", "format": "int32", "description": "позиция продукта" }, "site": { "type": "string" }, "anyArticle": { "type": "string" }, "anyLink": { "type": "string" }, "emptyBarcodes": { "type": "boolean" }, "minPriceForAllMarketplace": { "type": "number", "format": "double", "writeOnly": true }, "calculatedInstockQuantity": { "type": "integer", "format": "int32", "writeOnly": true }, "wildberriesPrice": { "type": "number", "format": "double", "description": "Текущая цена товара на Вайлдбериз со скидкой", "readOnly": true }, "wildberriesUpdatedPrice": { "type": "number", "format": "double", "description": "Новая цена товара на Вайлдбериз со скидкой.Только для методов изменения цены" }, "wildberriesPriceWithoutDiscount": { "type": "number", "format": "double", "description": "Текущая цена товара на Вайлдбериз без скидки", "readOnly": true }, "wildberriesUpdatedPriceWithoutDiscount": { "type": "number", "format": "double", "description": "Новая цена товара на Вайлдбериз без скидки.Только для методов изменения цены" }, "aliexpressPrice": { "type": "number", "format": "double", "description": "Текущая цена на Aliexpress со скидкой", "readOnly": true }, "aliexpressPriceWithoutDiscount": { "type": "number", "format": "double", "description": "Текущая цена на Aliexpress без скидки." }, "aliexpressUpdatedPrice": { "type": "number", "format": "double", "description": "Новая цена со скидкой на Aliexpress. Только для методов обновления цены" }, "aliexpressUpdatedPriceWithoutDiscount": { "type": "number", "format": "double", "description": "Новая цена без скидки на Aliexpress. Только для методов обновления цены" }, "ozonPrice": { "type": "number", "format": "double", "description": "Текущая цена товара на Озон со скидкой", "readOnly": true }, "ozonUpdatedPrice": { "type": "number", "format": "double", "description": "Новая цена товара на Озон со скидкой.Только для методов изменения цены" }, "ozonPriceWithoutDiscount": { "type": "number", "format": "double", "description": "Текущая цена товара на Озон без скидки.", "readOnly": true }, "ozonUpdatedPriceWithoutDiscount": { "type": "number", "format": "double", "description": "Новая цена Озон без скидки.Только для методов изменения цены" }, "leroyMerlinPrice": { "type": "number", "format": "double", "description": "Текущая цена товара на LeroyMerlin" }, "leroyMerlinUpdatedPrice": { "type": "number", "format": "double", "description": "Новая цена товара на LeroyMerlin.Только для методов изменения цены" }, "avitoPrice": { "type": "number", "format": "double", "description": "Текущая цена товара на Avito" }, "avitoUpdatedPrice": { "type": "number", "format": "double", "description": "Новая цена товара на Avito.Только для методов изменения цены" }, "sberMegaMarketPrice": { "type": "number", "format": "double", "description": "Текущая цена на СберМегаМаркет со скидкой", "readOnly": true }, "sberMegaMarketUpdatedPrice": { "type": "number", "format": "double", "description": "Новая цена со скидкой на СберМегаМаркет. Только для методов изменения цены" }, "yandexMarketPrice": { "type": "number", "format": "double", "description": "Текущая цена на Яндекс.Маркет со скидкой", "readOnly": true }, "yandexMarketPriceWithoutDiscount": { "type": "number", "format": "double", "description": "Текущая цена на Яндекс.Маркет без скидки", "readOnly": true }, "yandexMarketUpdatedPrice": { "type": "number", "format": "double", "description": "Новая цена со скидкой на Яндекс.Маркет. Только для методов изменения цены" }, "yandexMarketUpdatedPriceWithoutDiscount": { "type": "number", "format": "double", "description": "Новая цена без скидки на Яндекс.Маркет. Только для методов изменения цены" }, "stockRules": { "$ref": "#/components/schemas/ProductStockRules", "description": "Правила отправки остатков на маркетплейсы" } }, "required": [ "name", "organizationId" ] }, "ProductBarcode": { "type": "object", "description": "Штрих-код товара. У товара может быть несколько штрих-кодов, некоторые из них могут получаться и использовать только для определенных маркетплейсов", "properties": { "id": { "type": "integer", "format": "int64" }, "barcode": { "type": "string" }, "organizationId": { "type": "integer", "format": "int64", "description": "Организация, если client.barcodeUniqForOrg = false, то проставляется 0. Поле включено в уникальный ключ" }, "clientId": { "type": "integer", "format": "int64" }, "productId": { "type": "integer", "format": "int64" }, "useInWildberries": { "type": "boolean", "description": "Применим ли данный штрих-код для Вайлдбериз" }, "useInOzon": { "type": "boolean", "description": "Применим ли данный штрих-код для Озон" }, "useInYandexMarket": { "type": "boolean", "description": "Применим ли данный штрих-код для Yandex.Market" }, "useInAliexpress": { "type": "boolean", "description": "Применим ли данный штрих-код для Aliexpress" }, "useInSberMegamarket": { "type": "boolean", "description": "Применим ли данный штрих-код для Sber.MegaMarket" }, "useInWoocom": { "type": "boolean", "description": "Применим ли данный штрих-код для WooCommerce" }, "format": { "type": "string" } } }, "ProductHandOnPulseReport": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "ID записи отчета", "example": 12345 }, "clientId": { "type": "integer", "format": "int64", "description": "ID клиента", "example": 6789 }, "productId": { "type": "integer", "format": "int64", "description": "ID товара", "example": 54321 }, "service": { "type": "string", "description": "Сервис, из которого получены данные (например, Ozon, WB, Яндекс.Маркет)", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] }, "organizationId": { "type": "integer", "format": "int64", "description": "ID организации", "example": 1001 }, "productViewId": { "type": "integer", "format": "int64", "description": "ID представления товара (product_view_id)", "example": 2222 }, "productModelId": { "type": "integer", "format": "int64", "description": "ID модели товара", "example": 3333 }, "date": { "type": "string", "format": "date", "description": "Дата отчета", "example": "2025.10" }, "profitFact": { "type": "number", "format": "double", "description": "Фактическая прибыль по товару", "example": 15300.75 }, "grossProfit": { "type": "number", "format": "double" }, "profitPlan": { "type": "number", "format": "double", "description": "Плановая прибыль по товару", "example": 20000 }, "priceWithSpp": { "type": "number", "format": "double", "description": "Цена с учетом СПП (скидки постоянного покупателя)", "example": 990 }, "price": { "type": "number", "format": "double", "description": "Цена без СПП", "example": 1100 }, "spp": { "type": "number", "format": "double", "description": "СПП Wildberries", "example": 15.5 }, "campaignBudgetPlan": { "type": "number", "format": "double", "description": "Плановый бюджет кампании", "example": 5000 }, "campaignBudgetFact": { "type": "number", "format": "double", "description": "Фактический бюджет кампании", "example": 4500 }, "promotionBudget": { "type": "number", "format": "double", "description": "Бюджет на продвижение (ручное продвижение)", "example": 2000 }, "autoPromotionBudget": { "type": "number", "format": "double", "description": "Бюджет на авто-продвижение", "example": 1500 }, "campaignCtrPercent": { "type": "number", "format": "double", "description": "CTR рекламной кампании, %", "example": 4.5 }, "drrPercent": { "type": "number", "format": "double", "description": "DRR (затраты/выручка) в процентах", "example": 8.2 }, "viewsCount": { "type": "integer", "format": "int32", "description": "Количество просмотров, шт", "example": 90 }, "clicksCount": { "type": "integer", "format": "int32", "description": "Количество кликов, шт", "example": 90 }, "skuProfit": { "type": "number", "format": "double", "description": "Прибыль по SKU", "example": 1234.56 }, "skuCostPrice": { "type": "number", "format": "double", "description": "Себестоимость SKU", "example": 870 }, "marginPercent": { "type": "number", "format": "double", "description": "Маржинальность в процентах", "example": 29.5 }, "abcRevenueGroup": { "type": "string", "description": "ABC-группа по выручке", "enum": [ "A", "B", "C" ] }, "abcGrossProfitGroup": { "type": "string", "description": "ABC-группа по валовой прибыли", "enum": [ "A", "B", "C" ] }, "salesAmountFact": { "type": "number", "format": "double", "description": "Фактическая сумма продаж", "example": 50000 }, "salesCountFact": { "type": "integer", "format": "int32", "description": "Фактическое количество продаж", "example": 120 }, "salesCountPlan": { "type": "integer", "format": "int32", "description": "Плановое количество продаж", "example": 150 }, "sizes": { "type": "string", "description": "Размеры товара (если применимо)", "example": "S,M,L,XL" }, "turnover": { "type": "number", "format": "double", "description": "Оборачиваемость товара", "example": 1.8 }, "daysBeforeSeasonEnd": { "type": "integer", "format": "int32", "description": "Количество дней до конца сезона", "example": 45 }, "daysBeforeSeasonStart": { "type": "integer", "format": "int32", "description": "Количество дней до начала сезона", "example": 12 }, "sortPlan": { "type": "number", "format": "double", "description": "План сортировки (обновления ассортимента)", "example": 1 }, "fbsCount": { "type": "integer", "format": "int32", "description": "Количество продаж по схеме FBS", "example": 80 }, "openCardCount": { "type": "integer", "format": "int32", "description": "Количество открытий карточки товара", "example": 3500 }, "addToCartCount": { "type": "integer", "format": "int32", "description": "Количество добавлений в корзину", "example": 500 }, "addToCartPercent": { "type": "number", "format": "double", "description": "Процент добавлений в корзину относительно просмотров", "example": 14.3 }, "ordersCount": { "type": "integer", "format": "int32", "description": "Количество заказов", "example": 200 }, "cancelCount": { "type": "integer", "format": "int32", "description": "Количество отмен", "example": 200 }, "ordersPercent": { "type": "number", "format": "double", "description": "Конверсия в заказы, %", "example": 5.7 }, "buyoutsCount": { "type": "integer", "format": "int32", "description": "Количество выкупов", "example": 180 }, "buyoutsPercent": { "type": "number", "format": "double", "description": "Конверсия в выкуп, %", "example": 90 }, "rating": { "type": "number", "format": "double", "description": "Рейтинг товара", "example": 4.8 }, "reviewCount": { "type": "integer", "format": "int32", "description": "Количество отзывов", "example": 350 }, "comment": { "type": "string", "description": "Комментарий", "example": "Уменьшили цену для увеличения продаж" }, "userUpdates": { "type": "string", "description": "Изменения пользователя в JSON", "example": {} }, "product": { "$ref": "#/components/schemas/Product", "description": "Информация о товаре" }, "article": { "type": "string", "description": "Артикул" }, "warehouseStocks": { "type": "array", "description": "Остатки по складам", "items": { "$ref": "#/components/schemas/WarehouseStock" } }, "warehouseFboStocksJson": { "type": "string", "description": "Подготовленные остатки по складам JSON" }, "dateTruncated": { "type": "string", "description": "Дата отчета для отображения на фронте", "example": "2025.10 для месяца, 2025.10.25 для дня" }, "period": { "type": "string", "description": "Тип отчета - дневной или месячный", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ], "example": "DAY/MONTH" }, "position": { "type": "integer", "format": "int32", "description": "позиция продукта" }, "serviceId": { "type": "integer", "format": "int32", "writeOnly": true } } }, "ProductImage": { "type": "object", "description": "Изображение товара", "properties": { "id": { "type": "integer", "format": "int64", "description": "Идентификатор изображения. Проставляется автоматически.", "readOnly": true }, "url": { "type": "string", "description": "Ссылка на файл изображения", "readOnly": true }, "position": { "type": "integer", "format": "int32", "description": "Позиция изображения. Используется для выдачи по порядку на маркетплейсы и для отображения в интерфейсе" }, "productViewId": { "type": "integer", "format": "int64", "description": "Связь с цветом", "readOnly": true }, "wildberriesImgUUID": { "type": "string", "description": "Связь с идентификатором изображения WB. Сейчас не используется", "readOnly": true }, "services": { "type": "array", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] }, "uniqueItems": true }, "clientId": { "type": "integer", "format": "int64" }, "angleName": { "type": "string", "description": "Название ракурса для фотографии" } } }, "ProductModel": { "type": "object", "description": "Модель товара - объединяет товары, различающиеся цветом и некоторыми характеристиками (например размер в одежде)", "properties": { "article": { "type": "string", "description": "Уникальный артикул модели" }, "organizationId": { "type": "integer", "format": "int64", "description": "Организация для товара" }, "category": { "$ref": "#/components/schemas/Category", "description": "Категория товара", "readOnly": true }, "categoryId": { "type": "integer", "format": "int32", "description": "Идентификатор категории товара", "writeOnly": true }, "manufacturer": { "$ref": "#/components/schemas/Manufacturer", "description": "Производитель товара", "readOnly": true }, "manufacturerId": { "type": "integer", "format": "int32", "description": "Идентификатор производителя товара", "writeOnly": true }, "brand": { "$ref": "#/components/schemas/Brand", "description": "Торговая марка", "readOnly": true }, "brandId": { "type": "integer", "format": "int32", "description": "Идентификатор бренда для товара", "writeOnly": true }, "id": { "type": "integer", "format": "int64", "description": "Идентификатор модели. Проставляется автоматически" }, "name": { "type": "string", "description": "Название модели внутренее", "maxLength": 200 }, "promoName": { "type": "string", "description": "Название модели для продвижения товара. Используется в качестве названия на Wildberries", "maxLength": 200 }, "title": { "type": "string", "description": "Название модели для печати и автоматического формирования названий товаров", "maxLength": 255 }, "wildberriesImtId": { "type": "integer", "format": "int64", "description": "Идентификатор карточки товара Wildberries", "readOnly": true }, "description": { "type": "string", "description": "Описание товара", "maxLength": 60000 }, "gender": { "type": "string", "description": "Пол для товара", "enum": [ "MALE", "BOYS", "FEMALE", "GIRLS", "UNISEX", "KIDS", "CHILDREN" ] }, "packWidth": { "type": "integer", "format": "int32", "description": "Ширина упаковки товара в мм" }, "packHeight": { "type": "integer", "format": "int32", "description": "Высота упаковки товара в мм" }, "packDepth": { "type": "integer", "format": "int32", "description": "Глубина упаковки товара в мм" }, "packWeight": { "type": "integer", "format": "int32", "description": "Вес упаковки товара в гр" }, "season": { "type": "string", "description": "Сезон товара. Используется для фильтрации товара в заказах поставщикам", "enum": [ "ANY", "WINTER", "SUMMER", "SPRING", "AUTUMN", "SPRING_AUTUMN" ] }, "materials": { "type": "string", "description": "Состав товара, нужен для одежды и обуви" }, "laundry": { "type": "string", "description": "Правила ухода за вещами для одежды и обуви. Через запятую необходимо перечислить возможные значения" }, "versionId": { "type": "integer", "format": "int64", "description": "Поле нужно передавать при изменении,для предотвращения одновременной перезаписи" }, "clientId": { "type": "integer", "format": "int64", "description": "Идентификатор клиента", "readOnly": true }, "deleted": { "type": "boolean", "description": "Признак удаления модели", "readOnly": true }, "vat": { "type": "string", "description": "НДС", "enum": [ "NONE", "VAT_22", "COMMON", "HALF", "VAT_0", "VAT_5", "VAT_7", "VAT_12", "VAT_16", "VAT_18" ] }, "createdDate": { "type": "string", "format": "date-time", "description": "Дата создания модели", "readOnly": true }, "createdUser": { "type": "string", "description": "Пользователь, создавший модель", "readOnly": true }, "countryId": { "type": "integer", "format": "int32", "description": "Страна производства товара. По умолчанию проставляется из производителя" }, "countryName": { "type": "string", "description": "Название страны производства", "readOnly": true }, "keywords": { "type": "string", "description": "Ключевые слова для поиска" }, "favourite": { "type": "boolean", "description": "Пометка товара избранным для фильтрации" }, "params": { "type": "string", "description": "JSON со списком значений параметров для модели" }, "values": { "type": "array", "description": "Значения параметров карточки. Отдаются при запросе модели, если передать params=true", "items": { "$ref": "#/components/schemas/ParamValue" } }, "sourceModelId": { "type": "integer", "format": "int64", "description": "Модель из которой была создана данная модель как дубликат карточки" }, "additionalInfo": { "type": "string", "description": "Дополнительная информация о товаре" }, "createIndex": { "type": "integer", "format": "int32", "description": "Индекс создания карточки - для ограничения бесплатного тарифа", "readOnly": true }, "bulk": { "type": "boolean", "description": "Признак сборки товара по штрих-кодам, безуникальных кодов" }, "oneCId": { "type": "string", "description": "Идентификатор товара в 1С" }, "site": { "type": "string", "description": "Адрес сайта" }, "shelfLife": { "type": "integer", "format": "int32", "description": "Срок годности в единице измерения" }, "shelfLifeUnit": { "type": "string", "description": "Срок годности в единице измерения", "enum": [ "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ] }, "shelfLifeComment": { "type": "string", "description": "Комментарий срока годности" }, "lifeTime": { "type": "integer", "format": "int32", "description": "Срок службы в единице измерения" }, "lifeTimeUnit": { "type": "string", "description": "Срок службы в единице измерения", "enum": [ "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ] }, "lifeTimeComment": { "type": "string", "description": "Комментарий срока службы" }, "modelGuarantee": { "type": "integer", "format": "int32", "description": "Гарантийный срок в единице измерения" }, "modelGuaranteeUnit": { "type": "string", "description": "Единица гарантийного срока", "enum": [ "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ] }, "modelGuaranteeComment": { "type": "string", "description": "Комментарий гарантийного срока" }, "hasChanges": { "type": "boolean", "description": "Признак изменения информации о модели и необходимости его обновить", "writeOnly": true }, "price": { "type": "number", "format": "double", "description": "Розничная цена товара. Прибавляется к закупочной цене. Используется только при создании модели из заказа поставщика, в самой моделе не хранится", "writeOnly": true }, "deliveryCost": { "type": "number", "format": "double", "description": "Стоимость доставки товара. Прибавляется к закупочной цене. Используется только при создании модели из заказа поставщика, в самой моделе не хранится", "writeOnly": true }, "wholesalePrice": { "type": "number", "format": "double", "description": "Потовая цена товара. Используется только при создании модели из заказа поставщика, в самой моделе не хранится", "writeOnly": true }, "purchasePrice": { "type": "number", "format": "double", "description": "Закупочная цена товара. Используется только при создании модели из заказа поставщика, в самой моделе не хранится", "writeOnly": true }, "purchaseCurrency": { "type": "string", "description": "Валюта закупочной цены товара. Используется только при создании модели из заказа поставщика, в самой моделе не хранится", "enum": [ "RUB", "USD", "EUR", "AUD", "AZN", "GBP", "AMD", "BYN", "BGN", "BRL", "HUF", "VND", "HKD", "GEL", "DKK", "AED", "EGP", "INR", "IDR", "KZT", "CAD", "QAR", "KGS", "CNY", "MDL", "NZD", "NOK", "PLN", "RON", "XDR", "SGD", "TJS", "THB", "TRY", "TMT", "UZS", "UAH", "CZK", "SEK", "CHF", "RSD", "ZAR", "KRW", "JPY" ], "writeOnly": true }, "deliveryCostInCurrency": { "type": "number", "format": "double", "description": "Прочие расходы в валюте. Используется только при создании модели из заказа поставщика, в самой моделе не хранится", "writeOnly": true }, "purchasePriceInCurrency": { "type": "number", "format": "double", "description": "Закупочная цена товара в валюье. Используется только при создании модели из заказа поставщика, в самой моделе не хранится", "writeOnly": true }, "priceWithoutDiscount": { "type": "number", "format": "double", "description": "Цена без скидки. Используется только при создании модели из заказа поставщика, в самой моделе не хранится", "writeOnly": true }, "views": { "type": "array", "description": "Список цветов модели", "items": { "$ref": "#/components/schemas/ProductView" }, "writeOnly": true }, "services": { "type": "array", "description": "Список сервисов в которых создать карточки товара", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] }, "writeOnly": true }, "contractors": { "type": "array", "description": "Список поставщиков товара", "items": { "$ref": "#/components/schemas/Contractor" }, "writeOnly": true }, "sourceIncomeItemId": { "type": "integer", "format": "int64", "description": "Товар из заказа поставщика, из которого была создана модель. Используется только при создании модели из заказа поставщика, в самой моделе не хранится", "writeOnly": true }, "costPrice": { "type": "number", "format": "double", "description": "Себестоимость считается автоматически по формуле: закупочная цена + дополнительные расходы на товар, поэтому Вам нужно заполнить эти параметры или просто закупочную цену", "writeOnly": true }, "aliexpressGroupId": { "type": "string", "description": "Идентификатор группы по которому можно посмотерть статус создания/обновления", "readOnly": true }, "aliexpressId": { "type": "string", "description": "Карточка aliexpress", "readOnly": true }, "simpleImport": { "type": "boolean", "description": "Показатель что карточка создана с помощью быстрого импорта" }, "selectedProducts": { "type": "array", "description": "Используется при обновлении модели для выборочной отправки на МП", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true } }, "required": [ "article", "brandId", "categoryId", "manufacturerId", "organizationId", "views" ] }, "ProductStock": { "type": "object", "properties": { "stock": { "type": "integer", "format": "int32" }, "cell": { "$ref": "#/components/schemas/Cell" }, "reserved": { "type": "integer", "format": "int32" }, "calculatedStock": { "type": "integer", "format": "int32" }, "expiredDate": { "type": "string", "format": "date-time" } } }, "ProductStockRules": { "type": "object", "description": "Настройки отправки остатков", "properties": { "minFbsStock": { "type": "integer", "format": "int32", "description": "Минимальный остаток - если меньше, то ставим 0" }, "maxFbsStock": { "type": "integer", "format": "int32", "description": "Максимальный остаток - если больше, то ставим его" }, "subtractFromStock": { "type": "integer", "format": "int32", "description": "Вычитаемое значение из остатка перед отправкой на маркетплейс" } } }, "ProductVideo": { "type": "object", "description": "Видео товара", "properties": { "id": { "type": "integer", "format": "int64", "description": "Идентификатор Видео. Проставляется автоматически.", "readOnly": true }, "url": { "type": "string", "description": "Ссылка на файл", "readOnly": true }, "position": { "type": "integer", "format": "int32", "description": "Позиция видео. Используется для выдачи по порядку на маркетплейсы и для отображения в интерфейсе" }, "productViewId": { "type": "integer", "format": "int64", "description": "Связь с цветом", "readOnly": true }, "productId": { "type": "integer", "format": "int64", "description": "Связь с размером", "readOnly": true }, "videoUrls": { "type": "string", "description": "Ссылка на видео", "readOnly": true }, "services": { "type": "array", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] }, "uniqueItems": true } } }, "ProductView": { "type": "object", "description": "Цвет товара", "properties": { "color": { "type": "string", "description": "Артикул цвета" }, "wbArticle": { "type": "string", "description": "Артикул карточки Wildberries" }, "needKiz": { "type": "boolean", "description": "Требуется ли обязательная маркировка по данным Wildberries" }, "id": { "type": "integer", "format": "int64", "description": "Идентификатор цвета. Проставляется автоматически" }, "images": { "type": "array", "description": "Список изображений товара", "items": { "$ref": "#/components/schemas/ProductImage" } }, "videos": { "type": "array", "description": "Список видео товара", "items": { "$ref": "#/components/schemas/ProductVideo" } }, "productModelId": { "type": "integer", "format": "int64", "description": "Идентификатор модели", "readOnly": true }, "model": { "$ref": "#/components/schemas/ProductModel", "description": "Модель, к которой относится цвет", "readOnly": true }, "actual": { "type": "boolean", "description": "Актуальность цвета - нужно ли его показывать в заказах поставщикам" }, "mainImage": { "$ref": "#/components/schemas/ProductImage", "description": "Основное изображение товара", "readOnly": true }, "mainImageId": { "type": "integer", "format": "int64" }, "mainImageUrl": { "type": "string", "description": "Ссылка на основное изображение на маркетплейсе", "readOnly": true }, "imageUrls": { "type": "string", "description": "Ссылка на изображения", "readOnly": true }, "imagesUpdatedAt": { "type": "string", "format": "date-time", "description": "Дата/время последнего изменения фотографий", "readOnly": true }, "image360Urls": { "type": "string", "description": "Ссылка на изображения 360", "readOnly": true }, "wildberriesId": { "type": "integer", "format": "int64", "description": "Числовой идентификатор номенклатуры Wildberries, nmId" }, "createdDate": { "type": "string", "format": "date-time", "description": "Дата создания цвета", "readOnly": true }, "createdUser": { "type": "string", "description": "Пользователь, создавший цвет", "readOnly": true }, "versionId": { "type": "integer", "format": "int64", "description": "Поле нужно передавать при изменении,для предотвращения одновременной перезаписи" }, "clientId": { "type": "integer", "format": "int64", "description": "Идентификатор клиента", "readOnly": true }, "deleted": { "type": "boolean", "description": "Признак удаления цвета", "readOnly": true }, "keywords": { "type": "string", "description": "Ключевые слова - сейчас не используется, перенесены в модель" }, "wildberriesRating": { "type": "number", "format": "double", "description": "Рейтинг карточки на Вайлдбериз", "readOnly": true }, "wildberriesFeedbacks": { "type": "integer", "format": "int32", "description": "Количество отзывов на карточке на Вайлдбериз", "readOnly": true }, "wbRaiting": { "type": "number", "format": "double", "description": "Рейтинг карточки на Вайлдбериз", "readOnly": true }, "wbFeedbackCount": { "type": "integer", "format": "int32", "description": "Количество отзывов на карточке на Вайлдбериз", "readOnly": true }, "wbSpp": { "type": "number", "format": "double", "description": "СПП карточки на Вайлдбериз", "readOnly": true }, "wildberriesCardDoesNotOpen": { "type": "boolean", "description": "Признак, что карточка не открывается на Вайлдбериз", "readOnly": true }, "wildberriesHasPhoto": { "type": "boolean", "description": "Признак наличия фото на Wildberries", "readOnly": true }, "organizationId": { "type": "integer", "format": "int64", "description": "Организация карточки", "readOnly": true }, "params": { "type": "string", "description": "JSON со значениями параметров цвета" }, "values": { "type": "array", "description": "Значения параметров карточки. Отдаются при запросе модели, если передать params=true", "items": { "$ref": "#/components/schemas/ParamValue" } }, "viewSourceId": { "type": "integer", "format": "int64", "description": "Оригинал цвета по SKU", "readOnly": true }, "sizes": { "type": "array", "description": "Список размеров для цвета", "items": { "$ref": "#/components/schemas/Product" }, "writeOnly": true }, "hasChanges": { "type": "boolean", "description": "Признак изменения информации о цвете и необходимости его обновить", "writeOnly": true }, "viewWbArticle": { "$ref": "#/components/schemas/ProductView", "writeOnly": true }, "viewVersionId": { "type": "integer", "format": "int64", "writeOnly": true } }, "required": [ "sizes" ] }, "Region": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int32" }, "countryId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "regionSynonyms": { "type": "array", "items": { "$ref": "#/components/schemas/RegionSynonym" } } } }, "RegionSynonym": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "regionId": { "type": "integer", "format": "int64" }, "synonym": { "type": "string" }, "service": { "type": "string" } } }, "Sku": { "type": "object", "description": "Stock Keeping Unit - Единица хранения товара на складе. Может быть связана с несколькими карточками товаров Product.id. При первом создании товара SKU создается автоматически, далее можно привязать несколько товаров - имеющих разный бренд/организацию на маркетплейсах к одному SKU.", "properties": { "id": { "type": "integer", "format": "int64" }, "product": { "description": "Первый товар из которого был создан SKU", "required": [ "name", "organizationId" ] }, "productId": { "type": "integer", "format": "int64" } } }, "Tnved": { "type": "object", "description": "Код ТНВЭД", "properties": { "id": { "type": "integer", "format": "int64", "description": "Идентификатор кода ТНВЭД без нулей в начале" }, "name": { "type": "string", "description": "Название кода ТНВЭД" }, "deleted": { "type": "boolean" }, "type": { "type": "string", "description": "Тип", "enum": [ "SECTION", "GROUP", "PRODUCT", "MAIN" ] }, "categoryClass": { "type": "string", "description": "Информационное поле, чтобы автоматически заполнять значение в категории,при выборе ТНВЭД, но никогда не используется в документах", "enum": [ "SHOES", "LIGHT", "DRUGS", "CAMERA", "TYRES", "MILK", "WATER", "TOBACCO", "FURS", "BEER", "BICYCLES", "PERFUMES", "ELECTRONIC", "OTHER", "NONE", "FOOD", "WHEELCHAIRS", "OTP", "NCP", "BIO", "ANTISEPTIC", "NABEER", "SOFTDRINKS", "PETFOOD", "SEAFOOD", "MEAT", "TOYS", "TITAN", "RADIO", "OPTIC_FIBER", "VEGETABLE_OIL", "CONSERVE", "VETPHARMA", "CHEMISTRY", "AUTOFLUIDS", "GROCERY", "BOOKS", "CONSTRUCTION", "FIRE", "HEATER", "CABLERAW", "POLYMER", "SWEETS" ] }, "parentId": { "type": "integer", "format": "int64", "description": "Родительский ТНВЭД" }, "keywords": { "type": "string", "description": "Ключевые слова для кода ТНВЭД" }, "description": { "type": "string", "description": "Описание кода ТНВЭД" }, "paramsTnvedId": { "type": "integer", "format": "int64", "description": "Идентификатор категории национального каталога (cat_id)" }, "isInParam": { "type": "boolean", "description": "Означает что ТНВЭД есть в параметре Вайлдбериз - их нужно выбирать в приоритете" }, "certification": { "type": "string", "description": "Необходимость сертификации товаров с этим ТНВЭД" }, "code": { "type": "string" }, "parentCode": { "type": "string" } } }, "Unit": { "type": "object", "description": "Единица измерения", "properties": { "name": { "type": "string", "description": "Название единицы измерения" }, "measureId": { "type": "integer", "format": "int32", "description": "Мера параметра" }, "id": { "type": "integer", "format": "int32" } } }, "WarehouseStock": { "type": "object", "properties": { "warehouseName": { "type": "string" }, "warehouseRegion": { "type": "string" }, "stockCount": { "type": "integer", "format": "int32" } } }, "WildberriesType": { "type": "object", "description": "Предмет Вайлдбериз", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "description": "Название" }, "published": { "type": "boolean", "description": "Опубликованность предмета Вайлдбериз" }, "hasSize": { "type": "boolean", "description": "Атрибут, указывающий наличие размера" }, "monoBoxMinQuantity": { "type": "integer", "format": "int32" }, "monoType": { "type": "string", "enum": [ "ALWAYS", "NEVER", "MONO_IF_MIN_PRICE" ] }, "monoMinPrice": { "type": "integer", "format": "int32" }, "hasParent": { "type": "boolean" }, "parentId": { "type": "integer", "format": "int64" }, "wildberriesId": { "type": "integer", "format": "int64", "description": "Идентификатор предмета на Вайлдбериз" }, "lastSyncDate": { "type": "string", "format": "date-time", "description": "Дата последней синхронизации предмета с Вайлдбериз" }, "notChangedDays": { "type": "integer", "format": "int32", "description": "Количество дней, в течение которых данные категории не менялась. Используется для того, чтобы сократить обновление категорий, которые не меняются" }, "commission": { "type": "number", "format": "double", "description": "Комиссия для товаров данного предмета в Вайлдбериз по FBM" }, "fbsCommission": { "type": "number", "format": "double", "description": "Комиссия для товаров данного предмета в Вайлдбериз по FBS" }, "fbwCommission": { "type": "number", "format": "double", "description": "Комиссия по тарифу FBW" }, "dbsCommission": { "type": "number", "format": "double", "description": "Комиссия по тарифу DBS" }, "edbsCommission": { "type": "number", "format": "double", "description": "Комиссия по тарифу EDBS" }, "cAndCCommission": { "type": "number", "format": "double", "description": "Комиссия по тарифу C&C" }, "bookingCommission": { "type": "number", "format": "double", "description": "Комиссия за бронирование" }, "logisticPrice": { "type": "integer", "format": "int32", "description": "Стоимость доставки товара к клиенту на Вайлдбериз" }, "storagePrice": { "type": "number", "format": "double", "description": "Стоимость хранения товара на складе Вайлдбериз за штуку в день" }, "acceptancePrice": { "type": "number", "format": "double", "description": "Стоимость приемки товара на складе Вайлдбериз за штуку" }, "needDimensions": { "type": "boolean", "description": "Атрибут обязательности габаритов товара, тк стоимость хранения рассчитывается на основе габаритов" }, "purchasePercentAvg": { "type": "number", "format": "double", "description": "Среднее значение процента выкупа. Используется в AI Финдире" }, "purchasePercentMin": { "type": "number", "format": "double", "description": "Минимально допустимое значение процента выкупа. Используется в AI Финдире" }, "photoAvg": { "type": "integer", "format": "int32", "description": "Среднее кол-во фотографий. Используется в AI Финдире" }, "photoMin": { "type": "integer", "format": "int32", "description": "Минимально допустимое кол-во фотографий. Используется в AI Финдире" }, "drrAvg": { "type": "number", "format": "double", "description": "Среднее значение ДРР. Используется в AI Финдире" }, "drrMin": { "type": "number", "format": "double", "description": "Минимально допустимое значение ДПП. Используется в AI Финдире" }, "marginAvg": { "type": "number", "format": "double", "description": "Среднее значение маржинальности. Используется в AI Финдире" }, "marginMin": { "type": "number", "format": "double", "description": "Минимально допустимое значение маржинальности. Используется в AI Финдире" }, "candCCommission": { "type": "number", "format": "double" } } }, "YandexMarketCategory": { "type": "object", "description": "Категория Яндекс.Маркета", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "description": "Название категории" }, "published": { "type": "boolean" }, "parentId": { "type": "integer", "format": "int64" }, "isLeaf": { "type": "boolean", "description": "Признак листовой категории, в которой могут находиться товары" }, "lastSyncDate": { "type": "string", "format": "date-time", "description": "Дата последней синхронизации категории с Озон" }, "notChangedDays": { "type": "integer", "format": "int32", "description": "Количество дней, в течение которых данные категории не менялась. Используется для того, чтобы сократить обновление категорий, которые не меняются" } }, "required": [ "name" ] }, "PlanSales": { "type": "object", "properties": { "shortName": { "type": "string", "description": "Сокращенное название организации." }, "categoryName": { "type": "string", "description": "Название категории." }, "brandName": { "type": "string", "description": "Название бренда." }, "name": { "type": "string", "description": "Название товара" }, "viewWildberriesId": { "type": "integer", "format": "int64", "description": "Карточка Wildberries" }, "article": { "type": "string", "description": "Артикул" }, "serviceArticle": { "type": "string", "description": "Артикул на маркетплейсе" }, "color": { "type": "string", "description": "Цвет товара." }, "size": { "type": "string", "description": "Размер товара." }, "barcode": { "type": "string", "description": "Шк товара." }, "purchasePrice": { "type": "number", "format": "double", "description": "Закупочная цена." }, "createdDate": { "type": "string", "format": "date-time", "description": "Дата создания карточки." }, "isDuplicate": { "type": "boolean", "description": "Признак дубликата карточки." }, "dateKey": { "type": "string", "description": "Ключ по дате." }, "id": { "type": "integer", "format": "int64" }, "clientId": { "type": "integer", "format": "int64" }, "organizationId": { "type": "integer", "format": "int64" }, "date": { "type": "string", "format": "date-time" }, "categoryId": { "type": "integer", "format": "int32" }, "viewId": { "type": "integer", "format": "int64" }, "productId": { "type": "integer", "format": "int64" }, "service": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] }, "planCount": { "type": "integer", "format": "int32" }, "planAmount": { "type": "number", "format": "double" }, "planProfit": { "type": "number", "format": "double", "description": "планируемая прибыль" }, "totalCount": { "type": "integer", "format": "int32" }, "month": { "type": "string" }, "year": { "type": "integer", "format": "int32" }, "week": { "type": "integer", "format": "int32" }, "factCount": { "type": "integer", "format": "int32" }, "factAmount": { "type": "number", "format": "double" }, "dateFrom": { "type": "string", "format": "date-time", "description": "Начало периода" }, "dateTo": { "type": "string", "format": "date-time", "description": "Конец периода" }, "timeZone": { "type": "integer", "format": "int32", "description": "Тайм зона" }, "period": { "type": "string", "description": "Период WEEK, Month", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] }, "serviceId": { "type": "integer", "format": "int64" }, "factAmountInPercent": { "type": "number", "format": "double", "description": "Выполнение плана в процентах" } } }, "TmsTask": { "type": "object", "description": "Фоновая задача SelSup. Возвращается в разных методах, которые можно выполнять асинхронно. Далее можно проверять статус задачи, вызывая метод /task/getTask?id=", "properties": { "id": { "type": "integer", "format": "int64", "description": "Идентификатор задачи", "readOnly": true }, "status": { "type": "string", "description": "Текущий статус задачи", "enum": [ "CREATED", "RUNNING", "FINISHED", "ERROR", "RESTARTING", "INTERRUPTING", "INTERRUPTED", "STOPPED", "EXCEPTION" ], "readOnly": true }, "type": { "type": "string", "description": "Тип задачи", "enum": [ "WILDBERRIES_CREATE_CARD", "NATIONAL_CATALOG_CREATE_CARD", "OZON_CREATE_CARD", "OZON_CARDS_IMPORT", "IMPORT_FBS_ORDERS", "UPLOAD_PHOTOGRAPHY", "WILDBERRIES_UPDATE_PRICE", "WILDBERRIES_CARD_IMPORT", "WILDBERRIES_CARD_UPDATE", "SELSUP_STOCKS", "REFRESH_PHOTOGRAPHY", "SUPPLYING_QUANTITY_TASK", "EXPORT_PRICE", "OZON_UPDATE_PRICE", "WILDBERRIES_FILE_TASK", "YANDEX_MARKET_CARD_CREATE", "OZON_CARD_UPDATE_TASK", "OZON_IMPORT_STAT_TASK", "WILDBERRIES_PROFIT_STAT_TASK", "ALIEXPRESS_CREATE_CARD_TASK", "ALIEXPRESS_UPDATE_CARD_TASK", "PRICES_IMPORT_TASK", "WILDBERRIES_PRICES_TASK", "YANDEX_MARKET_CARD_IMPORT", "STOCKS_UPDATE", "WILDBERRIES_STOCKS_IMPORT_TASK", "WILDBERRIES_ORDERS_AND_SALES_TASK", "WILDBERRIES_INCOMES_IMPORT_TASK", "OZON_STOCKS_IMPORT_TASK", "TURNOVER_DOCUMENTS_TASK", "INTRODUCE_WMS_ITEMS_TASK", "PRODUCTS_FILE_TASK", "MODELS_FILE_TASK", "UPDATE_PRODUCT_CODES_TASK", "INTRODUCE_CODES_TASK", "PRODUCTS_IMPORT_TASK", "PRICES_FILE_TASK", "YANDEX_MARKET_UPDATE_PRICE_TASK", "IMPORT_STOCKS_TASK", "MOY_SKLAD_EXPORT_ORDERS", "MERGE_PRODUCTS_TASK", "PRODUCTS_WILDBERRIES_EXCEL_IMPORT_TASK", "MOY_SKLAD_CREATE_CARD", "IMPORT_FBO_STOCKS_FROM_FILE", "CREATE_WMS_ITEMS", "MOY_SKLAD_CARDS_IMPORT", "PROMOTION_FILE", "UNUSED_1", "UNUSED", "PRODUCT_ANALYTICS_FILE_TASK", "PROMOTION_RESET_FILE", "MOY_SKLAD_IMPORT_ORDERS", "FINANCE_REPORT_FILE_TASK", "YML_FILE_EXPORT", "PRODUCT_BALANCE_REPORT_FILE_TASK", "CURRENT_PRODUCT_BALANCE_FILE_TASK", "IMPORT_TRANSACTIONS", "MATCH_UNREGISTERED_PROFIT_REPORT_TASK", "UPDATE_AVERAGE_SERVICE_EXPENSES_TASK", "YANDEX_MARKET_ORDER_IMPORT_STAT_TASK", "ABC_REPORT_FILE_TASK", "MODEL_CONTRACTORS_IMPORT", "MODEL_CONTRACTORS_EXPORT", "BANK_TRANSACTION_IMPORT_FILE_TASK", "YML_IMPORT_TASK", "SALES_DYNAMIC_REPORT_FILE_TASK", "UPDATE_FBS_ORDERS", "EXPORT_TRANSACTION_IN_EXCEL_FILE_TASK", "IMPORT_TRANSACTION_FROM_EXCEL_FILE_TASK", "EXPORT_PROFIT_REPORT_FILE_TASK", "IMPORT_PROFIT_REPORT_FROM_EXCEL_FILE_TASK", "IMPORT_REALIZATION_REPORT_TASK", "STOCK_RECONCILIATION", "ORDER_REPORT_FILE_TASK", "GET_WB_FBO_ORDER_FROM_PROFIT_REPORT_TASK", "TO_QUANTITY_STORAGE_METHOD", "APPLY_RECONCILIATION", "OZON_IMPORT_FBO_ORDERS_TASK", "UPDATE_PURCHASE_PRICE_IN_PROFIT_REPORT_TASK", "FBS_LABELS", "MERGE_PRODUCT_STOCKS", "CREATE_ORDER_FROM_FILE", "ALIEXPRESS_CARD_IMPORT", "PRICE_LIST_IMPORT", "WB_STOCK_REPORT_FILE", "CONTRACTORS_REPORT_FILE", "PRODUCTS_SBER_MEGA_MARKET_EXCEL_IMPORT_TASK", "EXPORT_PROBLEMATIC_PRODUCT_REPORT", "PLAN_SUPPLY_REPORT_TASK", "PLAN_FACT_SALES_REPORT_FILE", "IMPORT_PLAN_SALES_FROM_EXCEL_FILE_TASK", "EXPORT_PLAN_SALES_EXCEL_FILE_TASK", "ORDERS_TO_BUY_FILE_TASK", "MERGE_PRICE_ON_OTHER_MP_TASK", "MATCH_PRODUCT_LAST_OPERATION_DATE_TASK", "PROBLEMATIC_PRODUCT_PRICE_FILE_TASK", "CATEGORIES_IMPORT_EXCEL_TASK", "AVITO_CARD_IMPORT", "UPDATE_OLD_WB_ORDER_STATUSES_TASK", "PRESTA_SHOP_IMPORT_TASK", "PRODUCTS_AVITO_EXCEL_IMPORT_TASK", "FBO_STOCK_RECONCILIATION_TASK", "APPLY_FBO_RECONCILIATION_TASK", "EXPORT_REPRICE_PRODUCT_CONFIG_TASK", "IMPORT_REPRICE_PRODUCT_CONFIG_TASK", "OZON_CASH_FLOW_STATEMENT_IMPORT_TASK", "IMPORT_PROMOTION_STRATEGY_FILE_TASK", "UPDATE_ORDER_DELIVERY_INFO_TASK", "BILLING_OPERATION_TASK", "SET_PURCHASE_PERCENT_TASK", "REMOVE_PRODUCT_IMAGES_TASK", "STRUCTURE_TURNOVER_TASK", "OZON_NEW_UPDATE_PRICE", "REPLACE_PRODUCT_IMAGE_TASK", "UPDATE_OZON_PROMOTION_DATA_TASK", "WILDBERRIES_IMPORT_CAMPAIGN_TASK", "WILDBERRIES_STORAGE_REPORT_TASK", "WEBASYST_LINK_ARTICLE_TASK", "DELIVERY_SERVICE_LABELS", "HAND_ON_PULSE_FILE_TASK", "ITEMS_INCOME_EXCEL_TASK", "UPDATE_SETS_EXCEL_TASK", "DELETE_PROFIT_REPORTS_BY_FILE_HISTORY_IDS_TASK", "EXPORT_PRODUCT_SETS_TASK", "AMAZON_CARD_IMPORT", "IMPORT_ACCEPTED_PRODUCTS_TASK", "ADD_ORDER_PRODUCT_FROM_FILE_TASK", "EXPORT_ITEM_HISTORY_FILE_TASK", "WILDBERRIES_IMPORT_CAMPAIGN_BY_EXCEL_TASK", "REMOVE_CLIENT_ORGANIZATION", "EBAY_CARD_IMPORT_TASK", "PRODUCTS_IMPORT_FROM_ORGANIZATION_TASK", "IMPORT_FBO_ORDERS", "LAMODA_CARD_IMPORT", "UPDATE_WB_PROMOTION_DATA_TASK", "IMPORT_RETURNS_REPORT_TASK", "UPDATE_PROMOTION_DATA_TASK", "RESTORE_CLIENT_ORGANIZATION", "LEROY_MERLIN_CARD_IMPORT", "YANDEX_MARKET_STOCKS_IMPORT_TASK", "WILDBERRIES_IMPORT_NM_REPORT_TASK", "ORDER_ANALYTICS_FILE_TASK", "CLIENT_DATABASE_MOVE_TASK", "FAST_CARD_IMPORT", "EXPORT_PRODUCT_CODE", "INSALES_CARD_IMPORT_TASK", "REMOVE_PRODUCT_VIDEOS_TASK", "UPDATE_CARDS_TASK", "FIND_UNPROFITABLE_PRODUCTS_TASK", "FIND_UNPURCHASED_PRODUCTS_TASK", "WALMART_CARD_IMPORT", "PRODUCT_GROUPS_TASK", "CONTRACTOR_ARTICLE_EXPORT_TASK", "CONTRACTOR_ARTICLE_IMPORT_TASK", "CURRENCY_CONVERSION_TASK", "UPDATE_SUPPLY_PLAN_REPORT_TASK", "EXPORT_SUPPLY_PLAN_REPORT_FILE_TASK", "CHECK_STOCK_ORDER", "PHOTOGRAPHY_EXCEL", "PREPARE_FINDIR_DATA_TASK", "CARD_SPLITTING_TASK", "EXPORT_IMAGE_UPDATES_TEMPLATE_TASK", "IMPORT_IMAGE_UPDATES_TASK", "PREPARE_PRODUCT_HAND_ON_PULSE_TASK", "UPDATE_OZON_AVERAGE_DELIVERY_TIME", "UPDATE_COMMISSIONS_TASK", "WOOCOMMERCE_CARD_IMPORT", "UPDATE_FBS_STOCKS_HISTORY", "RETURNS_FILE_TASK", "FAST_PRODUCTS_IMPORT_TASK", "ANALYZE_PRODUCT_CARDS_TASK", "DETMIR_CARD_IMPORT", "MATCH_OZON_REALIZATION_REPORT_TASK", "MAGNIT_IMPORT_PRODUCTS_TASK", "UPDATE_PURCHASE_PRICE_FROM_STOCKS_IN_PROFIT_REPORT_TASK", "MOY_SKLAD_FBO_MP_DATES_FIX", "PRICE_HISTORY_FILE_TASK", "FBM_ORDERS_IMPORT_TASK", "UZUM_IMPORT_PRODUCTS_TASK", "OPENCART_CARD_IMPORT", "CARDS_IMPORT" ], "readOnly": true }, "name": { "type": "string", "description": "Данные задачи в json - могут быть пустыми" }, "clientId": { "type": "integer", "format": "int64" }, "entityId": { "type": "integer", "format": "int64", "description": "Сущность, к которой относится задача" }, "progress": { "type": "integer", "format": "int32", "description": "Прогресс выполнения задачи в процентах" }, "processedQuantity": { "type": "integer", "format": "int32", "description": "Количество обработанных записей задачи" }, "organizationId": { "type": "integer", "format": "int64", "description": "Организация задачи, может быть 0, если не зависит от организации" }, "priority": { "type": "integer", "format": "int32", "description": "Приоритет задачи - чем выше тем быстрее задача запустится" }, "properties": { "type": "string", "description": "Параметры задачи" }, "message": { "type": "string", "description": "Сообщение с результатом выполнения задачи" }, "messageParams": { "type": "string", "description": "Параметры сообщения с результатом выполнения задачи" }, "createdDate": { "type": "string", "format": "date-time", "description": "Дата добавления задачи в очередь" }, "startDate": { "type": "string", "format": "date-time", "description": "Дата запуска задачи" }, "finishDate": { "type": "string", "format": "date-time", "description": "Дата завершения задачи" }, "url": { "type": "string", "description": "Ссылка на скачивание файла с результатом задачи" }, "inputFileUrl": { "type": "string", "description": "Ссылка на загруженный файл" }, "retryNumber": { "type": "integer", "format": "int32", "description": "Счётчик перезапуска задачи." }, "userId": { "type": "integer", "format": "int32", "description": "Пользователь запустивший задачу" }, "retryDate": { "type": "string", "format": "date-time", "description": "Запланированная дата перезапуска" }, "debug": { "type": "boolean", "description": "Запуск задачи в режиме отладки с большим логированием" }, "forcedStart": { "type": "boolean", "description": "Ручной запуск задачи" }, "service": { "type": "string", "description": "Сервис в рамках которого выполняется задача", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] }, "lang": { "type": "string", "description": "Язык на котором сейчас запущена таска" } } }, "SalesFunnelReport": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "nmId": { "type": "integer", "format": "int64", "description": "Артикул Wildberries, он же wildberriesId у view", "example": [ 987654 ] }, "clientId": { "type": "integer", "format": "int64" }, "organizationId": { "type": "integer", "format": "int64" }, "serviceId": { "type": "integer", "format": "int32" }, "vendorCode": { "type": "string" }, "brandName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "objectName": { "type": "string" }, "stocksMp": { "type": "integer", "format": "int32" }, "stocksWb": { "type": "integer", "format": "int32" }, "periodBegin": { "type": "string" }, "periodEnd": { "type": "string" }, "viewsCount": { "type": "integer", "format": "int32", "description": "Кол-во показов карточки" }, "openCardCount": { "type": "integer", "format": "int32" }, "addToCartCount": { "type": "integer", "format": "int32" }, "ordersCount": { "type": "integer", "format": "int32" }, "ordersSumRub": { "type": "number", "format": "double" }, "buyoutsCount": { "type": "integer", "format": "int32" }, "buyoutsSumRub": { "type": "number", "format": "double" }, "cancelCount": { "type": "integer", "format": "int32" }, "cancelSumRub": { "type": "number", "format": "double" }, "avgPriceRub": { "type": "number", "format": "double" }, "avgOrdersCountPerDay": { "type": "number", "format": "double" }, "ctrPercent": { "type": "number", "format": "double" }, "addToCartPercent": { "type": "number", "format": "double" }, "cartToOrderPercent": { "type": "number", "format": "double" }, "buyoutsPercent": { "type": "number", "format": "double" }, "feedbackRating": { "type": "number", "format": "double", "description": "Оценка пользователей" }, "productRating": { "type": "number", "format": "double", "description": "Оценка карточки" }, "reportDate": { "type": "string", "format": "date", "description": "За какую дату данные по товару" } } }, "ComprehensiveFinanceAnalytics": { "type": "object", "properties": { "salesExpensesOnMarketplaces": { "$ref": "#/components/schemas/FindResponseRowStructureForFinanceTable" }, "costStructure": { "$ref": "#/components/schemas/GetFinanceStructureResult" }, "profitStructure": { "$ref": "#/components/schemas/GetFinanceStructureResult" }, "penaltyStructure": { "type": "array", "items": { "$ref": "#/components/schemas/RowStructureForFinanceTable" } }, "serviceStructure": { "type": "array", "items": { "$ref": "#/components/schemas/RowStructureForFinanceTable" } }, "financesReportByPeriod": { "$ref": "#/components/schemas/FindResponseFinanceReport", "description": "Финансовый отчёт по периодам, одна строка = один период (dateKey). Если выбрано несколько организаций, значения агрегируются по dateKey В конце может присутствовать итоговая строка по всему интервалу без dateKey" }, "previousFinancesReportByPeriod": { "$ref": "#/components/schemas/FindResponseFinanceReport" }, "financesReportByPeriodByOrg": { "type": "array", "description": "Разбивка финансового отчёта по организациям и периодам, одна строка = одна организация в одном периоде (dateKey + organizationId). Заполняется только когда выбрано несколько организаций. Итоговые строки здесь не добавляются", "items": { "$ref": "#/components/schemas/FinanceReport" } }, "previousFinancesReportByPeriodByOrg": { "type": "array", "items": { "$ref": "#/components/schemas/FinanceReport" } }, "financesReportTotalByOrg": { "type": "array", "description": "Итоги финансового отчёта по организациям за весь интервал. Одна строка = итог по одной организации за весь выбранный интервал. Заполняется только когда выбрано несколько организаций", "items": { "$ref": "#/components/schemas/FinanceReport" } }, "commonFixedOutlay": { "type": "number", "format": "double" } } }, "FinanceReport": { "type": "object", "description": "DTO для передачи данных по финансовой аналитике", "properties": { "shortName": { "type": "string", "description": "Сокращенное название организации." }, "categoryName": { "type": "string", "description": "Название категории." }, "brandName": { "type": "string", "description": "Название бренда." }, "name": { "type": "string", "description": "Название товара" }, "viewWildberriesId": { "type": "integer", "format": "int64", "description": "Карточка Wildberries" }, "article": { "type": "string", "description": "Артикул" }, "serviceArticle": { "type": "string", "description": "Артикул на маркетплейсе" }, "color": { "type": "string", "description": "Цвет товара." }, "size": { "type": "string", "description": "Размер товара." }, "barcode": { "type": "string", "description": "Шк товара." }, "purchasePrice": { "type": "number", "format": "double", "description": "Закупочная цена." }, "createdDate": { "type": "string", "format": "date-time", "description": "Дата создания карточки." }, "isDuplicate": { "type": "boolean", "description": "Признак дубликата карточки." }, "dateKey": { "type": "string", "description": "Ключ по дате." }, "salesCount": { "type": "integer", "format": "int64", "description": "Продажи в шт." }, "salesCountConventional": { "type": "number", "format": "double", "description": "Продажи в у.е." }, "returnsCount": { "type": "integer", "format": "int64", "description": "Возвраты в шт." }, "returnsCountConventional": { "type": "number", "format": "double", "description": "Возвраты в у.е." }, "totalSalesCount": { "type": "integer", "format": "int64", "description": "Разница между продажами и возвратами в шт. salesCount - returnsCount" }, "totalSalesCountConventional": { "type": "number", "format": "double", "description": "Разница между продажами и возвратами в у.е." }, "salesAmount": { "type": "number", "format": "double", "description": "Продажи в руб." }, "returnsAmount": { "type": "number", "format": "double", "description": "Возвраты в руб." }, "averageReturnsAmount": { "type": "number", "format": "double", "description": "Возвраты в руб. за 1 ед" }, "totalSalesAmount": { "type": "number", "format": "double", "description": "Разница между продажами и возвратами в руб. salesAmount - returnsAmount" }, "orderAmount": { "type": "number", "format": "double", "description": "Заказы в руб." }, "orderAmountWithoutCancel": { "type": "number", "format": "double", "description": "Заказы в руб. без отмен" }, "logistics": { "type": "number", "format": "double", "description": "Логистика в руб." }, "averageLogistics": { "type": "number", "format": "double", "description": "Средняя логистика в руб." }, "logisticsShare": { "type": "number", "format": "double", "description": "Доля логистики в структуре выручки, %" }, "commissions": { "type": "number", "format": "double", "description": "Комиссия в руб." }, "acquiring": { "type": "number", "format": "double", "description": "Эквайринг в руб." }, "averageCommissions": { "type": "number", "format": "double", "description": "Средняя комиссия в руб." }, "penalty": { "type": "number", "format": "double", "description": "Штрафы в руб." }, "additional": { "type": "number", "format": "double", "description": "Доплаты в руб." }, "refundsAndCancellations": { "type": "number", "format": "double", "description": "Возвраты и отмены в руб." }, "compensationAmount": { "type": "number", "format": "double", "description": "Компенсации в руб." }, "additionalAndDeduction": { "type": "number", "format": "double", "description": "Доплаты и удержания в руб. в файле финансах ячейка Доплаты" }, "services": { "type": "number", "format": "double", "description": "Услуги в руб." }, "drr": { "type": "number", "format": "double", "description": "ДРР, %" }, "totalToBePaid": { "type": "number", "format": "double", "description": "Итого к оплате. totalSalesAmount - logistics - commission - penalties - additional - services + otherAmount - costStorage - campaignCost" }, "averageToBePaid": { "type": "number", "format": "double", "description": "Итого к оплате за 1 товар." }, "productCount": { "type": "integer", "format": "int64", "description": "Товарный остаток FBS + FBO на текущий момент." }, "salesAmountInPurchasePrice": { "type": "number", "format": "double", "description": "Проданный товар в закупочных ценах, руб." }, "productAmount": { "type": "number", "format": "double", "description": "Сумма по товарному остатку purchasePrice * productCount" }, "averageSellingPrice": { "type": "number", "format": "double", "description": "Средняя фактическая цена продажи" }, "markUp": { "type": "number", "format": "double", "description": "Фактическая наценка totalToBePaid / (purchasePrice * totalSalesCount)" }, "margin": { "type": "number", "format": "double", "description": "Маржинальность" }, "grossProfit": { "type": "number", "format": "double", "description": "Валовая прибыль totalToBePaid - totalSalesCount * purchasePrice - selPayAmount" }, "averageGrossProfit": { "type": "number", "format": "double", "description": "Валовая прибыль за 1 ед." }, "ratioInIncome": { "type": "number", "format": "double", "description": "Доля в выручке" }, "rationInGrossProfit": { "type": "number", "format": "double", "description": "Доля в валовой прибыли в % grossProfit / SUM(grossProfit)" }, "ratioInProductCount": { "type": "number", "format": "double", "description": "Доля в товарном остатке в % productAmount / SUM(productAmount)" }, "efficiencyForIncome": { "type": "number", "format": "double", "description": "Эффективность по выручке ratioInIncome / ratioInProductCount" }, "grossProfitEfficiency": { "type": "number", "format": "double", "description": "Эффективность по валовой прибыли rationInGrossProfit / ratioInProductCount" }, "averageExpenses": { "type": "number", "format": "double", "description": "Средний расходов по продаже на МП на 1 ед товара, руб. все расходы в руб / продажи - возвраты в шт" }, "otherAmount": { "type": "number", "format": "double", "description": "Прочие начисления, руб." }, "percentRedemption": { "type": "number", "format": "double", "description": "Процент выкупа. Продажи/(Продажи+Возвраты)*100 только для ВБ" }, "orderCount": { "type": "integer", "format": "int64", "description": "Кол-во заказов в шт." }, "orderCountWithoutCancel": { "type": "integer", "format": "int64", "description": "Кол-во заказов в шт. без отмен" }, "nonPurchasePriceCount": { "type": "integer", "format": "int64", "description": "Кол-во profitRepot где не указана закупочная цена, шт." }, "selfPayCount": { "type": "integer", "format": "int64", "description": "Кол-во самовыкупов, шт." }, "selfPayAmount": { "type": "number", "format": "double", "description": "Сумма самовыкупов, руб." }, "costStorage": { "type": "number", "format": "double", "description": "Сумма за хранения товара на МП, получаем только по ВБ через импорт файла." }, "campaignCost": { "type": "number", "format": "double", "description": "Стоимость рекламы ВБ" }, "wbSpp": { "type": "number", "format": "double", "description": "Сумма скидки постоянного покупателя на ВБ" }, "wbTotalSalesByPriceWithDisc": { "type": "number", "format": "double", "description": "Сумма продажи ВБ, по цене со скидкой продажи - возвраты" }, "otherDeductions": { "type": "number", "format": "double", "description": "Прочие удержания WB" }, "averageExpensesOnMP": { "type": "number", "format": "double", "description": "Средний расход по продаже на МП на 1 ед товара(берутся все расходы на МП по товару)" }, "compensationForLostItemOnWb": { "type": "number", "format": "double", "description": "Компенсация за утерянный товар от WB" }, "productAmountSum": { "type": "number", "format": "double" }, "totalSalesAmountPositiveSum": { "type": "number", "format": "double" }, "grossProfitPositiveSum": { "type": "number", "format": "double" }, "acceptance": { "type": "number", "format": "double", "description": "Платная приёмка" }, "cancelsCount": { "type": "integer", "format": "int64", "description": "Количество отмен" }, "ymBonus": { "type": "number", "format": "double", "description": "Баллы YM" }, "id": { "type": "integer", "format": "int64", "description": "Идентификатор" }, "orgName": { "type": "string", "description": "Название организации" }, "organizationId": { "type": "integer", "format": "int64", "description": "Идентификатор организации" }, "organizationIds": { "type": "string", "description": "ID организаций через запятую (заполняется при агрегации нескольких организаций)" }, "orgNames": { "type": "string", "description": "Названия организаций через запятую (заполняется при агрегации нескольких организаций)" }, "reportNumber": { "type": "string", "description": "Номер отчета" }, "dateStart": { "type": "string", "format": "date-time", "description": "Дата начала отчета по реализации" }, "dateEnd": { "type": "string", "format": "date-time", "description": "Дата конца отчета по реализации" }, "logisticToClientAmount": { "type": "number", "format": "double", "description": "Стоимость логистики к клиенту в руб." }, "logisticFromClientAmount": { "type": "number", "format": "double", "description": "Стоимость логистики от клиента в руб." }, "salesCommission": { "type": "number", "format": "double", "description": "Комиссия от продажи в руб." }, "returnsCommission": { "type": "number", "format": "double", "description": "Возврат комиссии в руб." }, "profit": { "type": "number", "format": "double", "description": "Чистая прибыль в руб. grossProfit - fixedOutlay - taxes + income" }, "profitClear": { "type": "number", "format": "double", "description": "Чистая прибыль без учета постоянных расходов и доп. доходов в руб. grossProfit - taxes" }, "bankPayment": { "type": "number", "format": "double", "description": "Оплата по банку в руб." }, "costPrice": { "type": "number", "format": "double", "description": "Себестоимость товара в руб. purchasePrice * salesCount" }, "fixedOutlay": { "type": "number", "format": "double", "description": "Постоянные расходы в руб.(Расходы за весь интервал / кол-во дней в месяце)*на выбранный интервал, если период захватывает больше одного месяца, будет вычисляться для каждого месяца, а после складываться, в случае нескольких отчетах для организации, то будет по каждому отчету браться по коэфициенту продаж" }, "taxes": { "type": "number", "format": "double", "description": "Налоги в руб." }, "sellingCosts": { "type": "number", "format": "double", "description": "Затраты по продаже на МП. getLogistics() + getCommissions() + getPenalty() + getServices() - getAdditionalAndDeduction() - getOtherAmount() + getCostStorage()" }, "rentability": { "type": "number", "format": "double", "description": "Рентабельность. (profit / totalSalesAmount) * 100" }, "taxRate": { "type": "number", "format": "double", "description": "Процентная ставка налога" }, "taxType": { "type": "string", "description": "Тип налогообложения", "enum": [ "YSN", "YSN_CONSUMPTION", "OSNO", "SELF_EMPLOYED" ] }, "totalCampaignCost": { "type": "number", "format": "double", "description": "Стоимость рекламы сумма" }, "ozonCampaignCost": { "type": "number", "format": "double", "description": "Реклама Озон" }, "ozonBonus": { "type": "number", "format": "double", "description": "Баллы Ozon" }, "basicExpenses": { "type": "number", "format": "double", "description": "Сумма основных расходов: комиссия + логистика + себестоимость" }, "otherExpenses": { "type": "number", "format": "double", "description": "Сумма прочих расходов: платная приемка + прочие удержания + прочие начисления + хранения + доплаты" }, "additionalExpenses": { "type": "number", "format": "double", "description": "Сумма дополнительных расходов: реклама + услуги + штрафы + сумма прочих расходов" }, "ozonDeliveryReturn": { "type": "number", "format": "double", "description": "Перечисление за доставку от покупателя, должно идти в прибыль" }, "emptyPurchaseAmount": { "type": "integer", "format": "int64", "description": "Сумма продаж, для которых не указана закупочная цена" }, "totalSalesAmountWithSpp": { "type": "number", "format": "double", "description": "Сумма продаж, если учитывать СPP (до SPP)" }, "sellingCostsWithSpp": { "type": "number", "format": "double", "description": "Сумма расходов на МП если учитывать СPP (до SPP)" }, "inputVat": { "type": "number", "format": "double", "description": "Входящий НДС, руб." }, "outputVat": { "type": "number", "format": "double", "description": "Исходящий НДС, руб." }, "finalVat": { "type": "number", "format": "double", "description": "Итоговый НДС (исходящий - входящий), руб." }, "incomeTax": { "type": "number", "format": "double", "description": "Налог на прибыль, руб." }, "totalTax": { "type": "number", "format": "double", "description": "Общий налог (НДС + налог на прибыль), руб." }, "income": { "type": "number", "format": "double", "description": "Прочие доходы" }, "serviceId": { "type": "integer", "format": "int32" } } }, "FindResponseFinanceReport": { "type": "object", "properties": { "rows": { "type": "array", "description": "Строки с результатом поиска", "items": { "$ref": "#/components/schemas/FinanceReport" } }, "total": { "type": "integer", "format": "int32", "description": "Общее количество найденных записей. Возвращается только, когда count = true" }, "page": { "type": "integer", "format": "int32", "description": "Номер запрошенной страницы" }, "hasNextPage": { "type": "boolean", "description": "Есть ли следующая страница" }, "emptyPurchase": { "type": "integer", "format": "int64", "description": "Показатель пустой закупочной цены" } } }, "FindResponseRowStructureForFinanceTable": { "type": "object", "properties": { "rows": { "type": "array", "description": "Строки с результатом поиска", "items": { "$ref": "#/components/schemas/RowStructureForFinanceTable" } }, "total": { "type": "integer", "format": "int32", "description": "Общее количество найденных записей. Возвращается только, когда count = true" }, "page": { "type": "integer", "format": "int32", "description": "Номер запрошенной страницы" }, "hasNextPage": { "type": "boolean", "description": "Есть ли следующая страница" }, "emptyPurchase": { "type": "integer", "format": "int64", "description": "Показатель пустой закупочной цены" } } }, "GetFinanceStructureResult": { "type": "object", "properties": { "rows": { "type": "array", "description": "Строки с результатом поиска", "items": { "$ref": "#/components/schemas/RowStructureForFinanceTable" } }, "total": { "type": "integer", "format": "int32", "description": "Общее количество найденных записей. Возвращается только, когда count = true" }, "page": { "type": "integer", "format": "int32", "description": "Номер запрошенной страницы" }, "hasNextPage": { "type": "boolean", "description": "Есть ли следующая страница" }, "emptyPurchase": { "type": "integer", "format": "int64", "description": "Показатель пустой закупочной цены" }, "fixedOutlay": { "type": "number", "format": "double" } } }, "RowStructureForFinanceTable": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "cost": { "type": "number", "format": "double" }, "totalSales": { "type": "number", "format": "double" }, "percent": { "type": "number", "format": "double" }, "absPercent": { "type": "number", "format": "double" }, "costWithoutSpp": { "type": "number", "format": "double" }, "totalSalesWithoutSpp": { "type": "number", "format": "double" }, "percentWithoutSpp": { "type": "number", "format": "double" } } }, "Tip": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "WARN", "INFO", "ACHIEVEMENTS", "REVENUE", "PROFIT", "LOGISTICS", "PENALTY", "PROBLEMATIC", "LOW_PURCHASE_PERCENT", "UNPROFITABLE_PRODUCTS", "LOW_MARGIN", "NEGATIVE_MARGIN", "FBO_LOW_STOCK", "LOW_PHOTO_COUNT", "CLOTHING_WITHOUT_MODEL", "PHOTO_RECOMMENDATIONS", "PRODUCT_PHOTO_ANALYZED", "HIGH_DRR", "LOW_CTR", "EMPTY_VIDEO", "CONVERSION_TO_ORDER_OR_CART_DECREASED", "LOW_RATING" ] }, "title": { "type": "string" }, "description": { "type": "string" }, "value": { "type": "number", "format": "double" } } }, "AnalyticsRequest": { "type": "object", "properties": { "period": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] }, "dateFrom": { "type": "string", "format": "date-time", "description": "Дата начала отчета" }, "dateTo": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" }, "services": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } }, "categories": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "format": "int64" } }, "brands": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "format": "int64" } }, "clientOrganizationId": { "type": "integer", "format": "int64", "description": "Идентификатор организации, для которой отдать данные" }, "organizations": { "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "ids": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "format": "int64" } }, "type": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "types": { "type": "array", "description": "Типы заказа", "items": { "type": "string", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "uniqueItems": true }, "status": { "type": "string", "description": "Фильтр по статусу заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] }, "timeZone": { "type": "integer", "format": "int32", "description": "Часовой пояс клиента по UTC" }, "previousDateFrom": { "type": "string", "format": "date-time", "description": "Дата начала периода для сравнения" }, "clientOrganizationIds": { "type": "array", "description": "Идентификаторы организаций, для которых отдать данные", "items": { "type": "integer", "format": "int64" } }, "ignoreCredit": { "type": "boolean", "description": "Не учитывать кредит в прочих удержаниях" }, "productAnalyticField": { "type": "string", "description": "Агрегировать данные по сущности", "enum": [ "BARCODE", "COLOR", "ARTICLE", "BRAND", "CATEGORY" ] }, "query": { "type": "string", "description": "Поисковый запрос для фильтрации аналитики" }, "withDuplicate": { "type": "boolean", "description": "Отдавать аналитику по дубликатам товаров" }, "withOzonBonus": { "type": "boolean", "description": "Учитывать баллы Ozon и YM в выручке и налогах по старой логике" }, "limit": { "type": "integer", "format": "int32", "description": "Количество записей в ответе" }, "page": { "type": "integer", "format": "int32", "description": "Страница для навигации по страницам, начиная с 1" }, "sortBy": { "type": "string", "description": "Поле сортировки" }, "ascending": { "type": "boolean", "description": "Сортировать по возрастанию по полю sortBy" }, "id": { "type": "integer", "format": "int64" }, "isMarketPlaceStructure": { "type": "boolean", "description": "Идентификатор, получать данные только по маркетплейсу или по всем." }, "isDashboard": { "type": "boolean", "description": "Идентификатор, запрос с дашборда или нет." }, "analyticsField": { "type": "string", "description": "Агрегировать данные по model/product/view", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] }, "planDayCount": { "type": "integer", "format": "int32", "description": "Кол-во дней для отчетов" }, "daysToSupply": { "type": "integer", "format": "int32", "description": "Через сколько дней ожидается поставка" }, "plannedSupplyDate": { "type": "string", "format": "date-time", "description": "Планируемая дата поставки" }, "groupByView": { "type": "boolean", "description": "Сгруппировать по цвету" }, "warehouses": { "type": "array", "description": "Список идентификаторов складов", "items": { "type": "integer", "format": "int64" } }, "regions": { "type": "array", "description": "Список регионов", "items": { "type": "string" } }, "group": { "type": "boolean", "description": "Сгруппировать данные" }, "calculationByOrders": { "type": "boolean", "description": "Делать расчет по заказанному количеству" }, "sourceReport": { "type": "string", "description": "Операция по которой выводить данные", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] }, "skipDayWithoutStocks": { "type": "boolean", "description": "Пропускать дни без остатков" }, "replaceSetsByComponents": { "type": "boolean", "description": "Раскрывать комплекты по компонентам" }, "distributeFbsByWarehouse": { "type": "boolean", "description": "Распределять FBS по складам пропорционально FBO" }, "isSaleStructure": { "type": "boolean", "description": "Идентификатор, что нужно получить структуру по продажам" }, "isAveragePerOneUnit": { "type": "boolean", "description": "Идентификатор, получить среднее за 1 единицу" }, "updateDate": { "type": "boolean", "description": "Обновлять даты" }, "useWeightedGroup": { "type": "boolean", "description": "Использовать группы по весу" }, "isFindirRequest": { "type": "boolean", "description": "Является ли запрос - запросом для Задачника" }, "brandIds": { "type": "array", "description": "Фильтр по идентификаторам брендов (список)", "items": { "type": "integer", "format": "int64" } }, "categoryIds": { "type": "array", "description": "Фильтр по идентификаторам категорий (список)", "items": { "type": "integer", "format": "int64" } }, "articles": { "type": "array", "description": "Фильтр по артикулу (список)", "items": { "type": "string" } }, "colors": { "type": "array", "description": "Фильтр по цвету (список)", "items": { "type": "string" } }, "sizes": { "type": "array", "description": "Фильтр по размеру (список)", "items": { "type": "string" } }, "barcodes": { "type": "array", "description": "Фильтр по штрих-коду (список)", "items": { "type": "string" } }, "penaltyFrom": { "type": "number", "format": "double", "description": "Фильтр по штрафам (от)" }, "penaltyTo": { "type": "number", "format": "double", "description": "Фильтр по штрафам (до)" }, "logisticsFrom": { "type": "number", "format": "double", "description": "Фильтр по логистике (от)" }, "logisticsTo": { "type": "number", "format": "double", "description": "Фильтр по логистике (до)" }, "marginFrom": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (от)" }, "marginTo": { "type": "number", "format": "double", "description": "Фильтр по маржинальности (до)" }, "salesAmountFrom": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (от)" }, "salesAmountTo": { "type": "number", "format": "double", "description": "Фильтр по сумме продаж (до)" }, "totalSalesAmountFrom": { "type": "number", "format": "double", "description": "Фильтр по выручке (от)" }, "totalSalesAmountTo": { "type": "number", "format": "double", "description": "Фильтр по выручке (до)" }, "grossProfitFrom": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (от)" }, "grossProfitTo": { "type": "number", "format": "double", "description": "Фильтр по валовой прибыли (до)" }, "taxNds": { "type": "integer", "format": "int32", "description": "Налог ндс" }, "useOsno": { "type": "boolean", "description": "Тип налогообложения осно" }, "unmatch": { "type": "boolean" } }, "required": [ "dateFrom", "dateTo", "productAnalyticField" ] }, "OrderFrequencyPoint": { "type": "object", "properties": { "orders": { "type": "integer", "format": "int32", "description": "Число покупок" }, "percent": { "type": "number", "format": "double", "description": "Процент покупателей" } } }, "RepeatSalesReport": { "type": "object", "properties": { "uniqueCustomers": { "type": "integer", "format": "int32", "description": "Количество уникальных покупателей" }, "repeatCustomers": { "type": "integer", "format": "int32", "description": "Количество повторных покупателей (2 и более заказов" }, "orderFrequencyPoints": { "type": "array", "description": "Покупок на покупателя", "items": { "$ref": "#/components/schemas/OrderFrequencyPoint" } } } }, "FindResponseProductHandOnPulseReport": { "type": "object", "properties": { "rows": { "type": "array", "description": "Строки с результатом поиска", "items": { "$ref": "#/components/schemas/ProductHandOnPulseReport" } }, "total": { "type": "integer", "format": "int32", "description": "Общее количество найденных записей. Возвращается только, когда count = true" }, "page": { "type": "integer", "format": "int32", "description": "Номер запрошенной страницы" }, "hasNextPage": { "type": "boolean", "description": "Есть ли следующая страница" }, "emptyPurchase": { "type": "integer", "format": "int64", "description": "Показатель пустой закупочной цены" } } }, "FindResponseProductAnalytics": { "type": "object", "properties": { "rows": { "type": "array", "description": "Строки с результатом поиска", "items": { "$ref": "#/components/schemas/ProductAnalytics" } }, "total": { "type": "integer", "format": "int32", "description": "Общее количество найденных записей. Возвращается только, когда count = true" }, "page": { "type": "integer", "format": "int32", "description": "Номер запрошенной страницы" }, "hasNextPage": { "type": "boolean", "description": "Есть ли следующая страница" }, "emptyPurchase": { "type": "integer", "format": "int64", "description": "Показатель пустой закупочной цены" } } }, "ProductAnalytics": { "type": "object", "description": "DTO для передачи данных по товарной аналитике", "properties": { "shortName": { "type": "string", "description": "Сокращенное название организации." }, "categoryName": { "type": "string", "description": "Название категории." }, "brandName": { "type": "string", "description": "Название бренда." }, "name": { "type": "string", "description": "Название товара" }, "viewWildberriesId": { "type": "integer", "format": "int64", "description": "Карточка Wildberries" }, "article": { "type": "string", "description": "Артикул" }, "serviceArticle": { "type": "string", "description": "Артикул на маркетплейсе" }, "color": { "type": "string", "description": "Цвет товара." }, "size": { "type": "string", "description": "Размер товара." }, "barcode": { "type": "string", "description": "Шк товара." }, "purchasePrice": { "type": "number", "format": "double", "description": "Закупочная цена." }, "createdDate": { "type": "string", "format": "date-time", "description": "Дата создания карточки." }, "isDuplicate": { "type": "boolean", "description": "Признак дубликата карточки." }, "dateKey": { "type": "string", "description": "Ключ по дате." }, "salesCount": { "type": "integer", "format": "int64", "description": "Продажи в шт." }, "salesCountConventional": { "type": "number", "format": "double", "description": "Продажи в у.е." }, "returnsCount": { "type": "integer", "format": "int64", "description": "Возвраты в шт." }, "returnsCountConventional": { "type": "number", "format": "double", "description": "Возвраты в у.е." }, "totalSalesCount": { "type": "integer", "format": "int64", "description": "Разница между продажами и возвратами в шт. salesCount - returnsCount" }, "totalSalesCountConventional": { "type": "number", "format": "double", "description": "Разница между продажами и возвратами в у.е." }, "salesAmount": { "type": "number", "format": "double", "description": "Продажи в руб." }, "returnsAmount": { "type": "number", "format": "double", "description": "Возвраты в руб." }, "averageReturnsAmount": { "type": "number", "format": "double", "description": "Возвраты в руб. за 1 ед" }, "totalSalesAmount": { "type": "number", "format": "double", "description": "Разница между продажами и возвратами в руб. salesAmount - returnsAmount" }, "orderAmount": { "type": "number", "format": "double", "description": "Заказы в руб." }, "orderAmountWithoutCancel": { "type": "number", "format": "double", "description": "Заказы в руб. без отмен" }, "logistics": { "type": "number", "format": "double", "description": "Логистика в руб." }, "averageLogistics": { "type": "number", "format": "double", "description": "Средняя логистика в руб." }, "logisticsShare": { "type": "number", "format": "double", "description": "Доля логистики в структуре выручки, %" }, "commissions": { "type": "number", "format": "double", "description": "Комиссия в руб." }, "acquiring": { "type": "number", "format": "double", "description": "Эквайринг в руб." }, "averageCommissions": { "type": "number", "format": "double", "description": "Средняя комиссия в руб." }, "penalty": { "type": "number", "format": "double", "description": "Штрафы в руб." }, "additional": { "type": "number", "format": "double", "description": "Доплаты в руб." }, "refundsAndCancellations": { "type": "number", "format": "double", "description": "Возвраты и отмены в руб." }, "compensationAmount": { "type": "number", "format": "double", "description": "Компенсации в руб." }, "additionalAndDeduction": { "type": "number", "format": "double", "description": "Доплаты и удержания в руб. в файле финансах ячейка Доплаты" }, "services": { "type": "number", "format": "double", "description": "Услуги в руб." }, "drr": { "type": "number", "format": "double", "description": "ДРР, %" }, "totalToBePaid": { "type": "number", "format": "double", "description": "Итого к оплате. totalSalesAmount - logistics - commission - penalties - additional - services + otherAmount - costStorage - campaignCost" }, "averageToBePaid": { "type": "number", "format": "double", "description": "Итого к оплате за 1 товар." }, "productCount": { "type": "integer", "format": "int64", "description": "Товарный остаток FBS + FBO на текущий момент." }, "salesAmountInPurchasePrice": { "type": "number", "format": "double", "description": "Проданный товар в закупочных ценах, руб." }, "productAmount": { "type": "number", "format": "double", "description": "Сумма по товарному остатку purchasePrice * productCount" }, "averageSellingPrice": { "type": "number", "format": "double", "description": "Средняя фактическая цена продажи" }, "markUp": { "type": "number", "format": "double", "description": "Фактическая наценка totalToBePaid / (purchasePrice * totalSalesCount)" }, "margin": { "type": "number", "format": "double", "description": "Маржинальность" }, "grossProfit": { "type": "number", "format": "double", "description": "Валовая прибыль totalToBePaid - totalSalesCount * purchasePrice - selPayAmount" }, "averageGrossProfit": { "type": "number", "format": "double", "description": "Валовая прибыль за 1 ед." }, "ratioInIncome": { "type": "number", "format": "double", "description": "Доля в выручке" }, "rationInGrossProfit": { "type": "number", "format": "double", "description": "Доля в валовой прибыли в % grossProfit / SUM(grossProfit)" }, "ratioInProductCount": { "type": "number", "format": "double", "description": "Доля в товарном остатке в % productAmount / SUM(productAmount)" }, "efficiencyForIncome": { "type": "number", "format": "double", "description": "Эффективность по выручке ratioInIncome / ratioInProductCount" }, "grossProfitEfficiency": { "type": "number", "format": "double", "description": "Эффективность по валовой прибыли rationInGrossProfit / ratioInProductCount" }, "averageExpenses": { "type": "number", "format": "double", "description": "Средний расходов по продаже на МП на 1 ед товара, руб. все расходы в руб / продажи - возвраты в шт" }, "otherAmount": { "type": "number", "format": "double", "description": "Прочие начисления, руб." }, "percentRedemption": { "type": "number", "format": "double", "description": "Процент выкупа. Продажи/(Продажи+Возвраты)*100 только для ВБ" }, "orderCount": { "type": "integer", "format": "int64", "description": "Кол-во заказов в шт." }, "orderCountWithoutCancel": { "type": "integer", "format": "int64", "description": "Кол-во заказов в шт. без отмен" }, "nonPurchasePriceCount": { "type": "integer", "format": "int64", "description": "Кол-во profitRepot где не указана закупочная цена, шт." }, "selfPayCount": { "type": "integer", "format": "int64", "description": "Кол-во самовыкупов, шт." }, "selfPayAmount": { "type": "number", "format": "double", "description": "Сумма самовыкупов, руб." }, "costStorage": { "type": "number", "format": "double", "description": "Сумма за хранения товара на МП, получаем только по ВБ через импорт файла." }, "campaignCost": { "type": "number", "format": "double", "description": "Затраты на рекламу, получаем только по ВБиз импорта статистики по рекламным кампаниям" }, "wbSpp": { "type": "number", "format": "double", "description": "Сумма скидки постоянного покупателя на ВБ" }, "wbTotalSalesByPriceWithDisc": { "type": "number", "format": "double", "description": "Сумма продажи ВБ, по цене со скидкой продажи - возвраты" }, "otherDeductions": { "type": "number", "format": "double", "description": "Прочие удержания WB" }, "averageExpensesOnMP": { "type": "number", "format": "double", "description": "Средний расход по продаже на МП на 1 ед товара(берутся все расходы на МП по товару)" }, "compensationForLostItemOnWb": { "type": "number", "format": "double", "description": "Компенсация за утерянный товар от WB" }, "productAmountSum": { "type": "number", "format": "double" }, "totalSalesAmountPositiveSum": { "type": "number", "format": "double" }, "grossProfitPositiveSum": { "type": "number", "format": "double" }, "acceptance": { "type": "number", "format": "double", "description": "Платная приёмка" }, "cancelsCount": { "type": "integer", "format": "int64", "description": "Количество отмен" }, "ymBonus": { "type": "number", "format": "double", "description": "Баллы Яндекс Маркета" }, "id": { "type": "integer", "format": "int64", "description": "Идентификатор" }, "productId": { "type": "integer", "format": "int64", "description": "Идентификатор товара" }, "productViewId": { "type": "integer", "format": "int64", "description": "Идентификатор цвета товара" }, "productModelId": { "type": "integer", "format": "int64", "description": "Идентификатор модели товара" }, "brandId": { "type": "integer", "format": "int64", "description": "Идентификатор бренда товара" }, "categoryId": { "type": "integer", "format": "int64", "description": "Идентификатор категории товара" }, "deleted": { "type": "boolean", "description": "Товар удален?" }, "totalCount": { "type": "integer", "format": "int32", "description": "Всего найдено строк для отчетов" }, "instockQuantity": { "type": "integer", "format": "int64", "description": "Кол-во остатков на складе FBS" }, "fboQuantity": { "type": "integer", "format": "int64", "description": "Количество остатков на складах FBO" }, "ozonStockCount": { "type": "integer", "format": "int32", "description": "Количество остатков на складах Ozon" }, "wildberriesStockCount": { "type": "integer", "format": "int32", "description": "Количество остатков на складах Wildberries" }, "yandexMarketStockCount": { "type": "integer", "format": "int32", "description": "Количество остатков на складах Yandex.Market" }, "ozonArticle": { "type": "string", "description": "Уникальный артикул товара для озон" }, "wbArticle": { "type": "string", "description": "Название на Wildberries" }, "yandexMarketShopSku": { "type": "string", "description": "SKU товара на Yandex.Market" }, "aliexpressSku": { "type": "string", "description": "SKU на Aliexpress" }, "sberArticle": { "type": "string", "description": "Артикул товара на СберМегаМаркет" }, "oneCArticle": { "type": "string", "description": "Уникальный артикул товара для 1c" }, "lastWildberriesSaleDate": { "type": "string", "format": "date-time", "description": "Дата последней продажи WB" }, "lastWildberriesOrderDate": { "type": "string", "format": "date-time", "description": "Дата последнего заказа на WB" }, "lastOzonSaleDate": { "type": "string", "format": "date-time", "description": "Дата последней продажи Ozon" }, "lastOzonOrderDate": { "type": "string", "format": "date-time", "description": "Дата последнего заказа на Ozon" }, "service": { "type": "string", "description": "Выбранный в запросе МП", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] }, "orgTaxRate": { "type": "number", "format": "double", "description": "Процентная ставка налога организации" }, "prodTaxRate": { "type": "number", "format": "double", "description": "Процентная ставка налога товара" }, "taxType": { "type": "string", "description": "Тип налогообложения", "enum": [ "YSN", "YSN_CONSUMPTION", "OSNO", "SELF_EMPLOYED" ] }, "netProfitRub": { "type": "number", "format": "double", "description": "Чистая прибыль" }, "netProfitRubPerUnit": { "type": "number", "format": "double", "description": "Чистая прибыль за 1ед." }, "otherExpenses": { "type": "number", "format": "double", "description": "Дополнительныеы расходы на проданный товар, руб." }, "strategyId": { "type": "integer", "format": "int64", "description": "Идентификатор стратегии ценообразования" }, "inputVat": { "type": "number", "format": "double", "description": "Входящий НДС, руб." }, "outputVat": { "type": "number", "format": "double", "description": "Исходящий НДС, руб." }, "finalVat": { "type": "number", "format": "double", "description": "Итоговый НДС (исходящий - входящий), руб." }, "incomeTax": { "type": "number", "format": "double", "description": "Налог на прибыль, руб." }, "totalTax": { "type": "number", "format": "double", "description": "Общий налог (НДС + налог на прибыль), руб." }, "ozonDeliveryReturn": { "type": "number", "format": "double", "description": "Перечисление за доставку от покупателя, должно идти в прибыль" }, "paidServiceCommissionPercentOzon": { "type": "number", "format": "double", "description": "Процент комиссии платных услуг Ozon" }, "paidServiceCommissionPercentWildberries": { "type": "number", "format": "double", "description": "Процент комиссии платных услуг Wildberries" }, "paidServiceCommissionPercent": { "type": "number", "format": "double", "description": "Суммарный процент комиссий платных услуг" }, "paidServiceCommissionAmount": { "type": "number", "format": "double", "description": "Сумма комиссий платных услуг, руб." }, "managerWb": { "type": "string", "description": "Менеджер WB" }, "managerYandex": { "type": "string", "description": "Менеджер Yandex" }, "managerOzon": { "type": "string", "description": "Менеджер Ozon" }, "managerMain": { "type": "string", "description": "Менеджер Основной" }, "organizationId": { "type": "integer", "format": "int64", "description": "Идентификатор организации" }, "mainImageUrl": { "type": "string", "description": "Ссылка на основное изображение товара" }, "params": { "type": "string", "description": "JSON параметров товара из productModel.params" }, "serviceId": { "$ref": "#/components/schemas/ProductAnalytics", "writeOnly": true } } }, "FindResponseSalesFunnelReport": { "type": "object", "properties": { "rows": { "type": "array", "description": "Строки с результатом поиска", "items": { "$ref": "#/components/schemas/SalesFunnelReport" } }, "total": { "type": "integer", "format": "int32", "description": "Общее количество найденных записей. Возвращается только, когда count = true" }, "page": { "type": "integer", "format": "int32", "description": "Номер запрошенной страницы" }, "hasNextPage": { "type": "boolean", "description": "Есть ли следующая страница" }, "emptyPurchase": { "type": "integer", "format": "int64", "description": "Показатель пустой закупочной цены" } } }, "UserInfo": { "type": "object", "properties": { "name": { "type": "string" }, "key": { "type": "string" } } }, "UsersStat": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserInfo" } }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } } }, "Turnover": { "type": "object", "description": "DTO - для передачи данных по взаиморасчетам с поставщиками.", "properties": { "id": { "type": "integer", "format": "int64", "description": "Идентификатор позиции." }, "title": { "type": "string", "description": "Название позиции" }, "debit": { "type": "number", "format": "double", "description": "Сумма Дебет(Нам должны)" }, "credit": { "type": "number", "format": "double", "description": "Сумма Кредит(Мы должны)" } } }, "FindResponsePlanSales": { "type": "object", "properties": { "rows": { "type": "array", "description": "Строки с результатом поиска", "items": { "$ref": "#/components/schemas/PlanSales" } }, "total": { "type": "integer", "format": "int32", "description": "Общее количество найденных записей. Возвращается только, когда count = true" }, "page": { "type": "integer", "format": "int32", "description": "Номер запрошенной страницы" }, "hasNextPage": { "type": "boolean", "description": "Есть ли следующая страница" }, "emptyPurchase": { "type": "integer", "format": "int64", "description": "Показатель пустой закупочной цены" } } }, "Taxes": { "type": "object", "description": "DTO для передачи данных по налогу", "properties": { "id": { "type": "integer", "format": "int64", "description": "Идентификатор записи" }, "taxesAmount": { "type": "number", "format": "double", "description": "Сумма налога" }, "salesAmount": { "type": "number", "format": "double", "description": "Сумма продаж(продажи - возвраты)" }, "years": { "type": "integer", "format": "int32", "description": "Год" }, "quarter": { "type": "integer", "format": "int32", "description": "Квартал" }, "title": { "type": "string", "description": "Описание" } } }, "FindResponsePaymentStructure": { "type": "object", "properties": { "rows": { "type": "array", "description": "Строки с результатом поиска", "items": { "$ref": "#/components/schemas/PaymentStructure" } }, "total": { "type": "integer", "format": "int32", "description": "Общее количество найденных записей. Возвращается только, когда count = true" }, "page": { "type": "integer", "format": "int32", "description": "Номер запрошенной страницы" }, "hasNextPage": { "type": "boolean", "description": "Есть ли следующая страница" }, "emptyPurchase": { "type": "integer", "format": "int64", "description": "Показатель пустой закупочной цены" } } }, "PaymentStructure": { "type": "object", "description": "DTO для передачи данных по оплатам в разделе взаиморасчеты с поставщиками", "properties": { "id": { "type": "integer", "format": "int64", "description": "Идентификатор" }, "documentNumber": { "type": "integer", "format": "int64", "description": "Номер поступления(ID)" }, "operationType": { "type": "string", "description": "Тип операции" }, "contractor": { "$ref": "#/components/schemas/Contractor", "description": "Контрагент" }, "debit": { "type": "number", "format": "double", "description": "Дебит" }, "credit": { "type": "number", "format": "double", "description": "Кредит" }, "date": { "type": "string", "format": "date-time", "description": "Дата операции" }, "incomeId": { "type": "integer", "format": "int64", "description": "Номер закупки" }, "transactionId": { "type": "integer", "format": "int64", "description": "Идентификатор транзакции" }, "comment": { "type": "string", "description": "Назначение платежа" } } }, "MeasureUnitStat": { "type": "object", "description": "Статистика заказов/продаж в разрезе единицы измерения", "properties": { "unit": { "type": "string", "description": "Название единицы измерения" }, "count": { "type": "integer", "format": "int64", "description": "Количество заказов/продаж в данной единице измерения" } } }, "ProductStats": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "convUnits": { "type": "array", "description": "Разбивка заказов/продаж по единицам измерения", "items": { "$ref": "#/components/schemas/MeasureUnitStat" } } } }, "SalesReportForGraphic": { "type": "object", "description": "DTO для передачи данных по продажам и возвратам по сервису.", "properties": { "serviceName": { "type": "string" }, "salesAmount": { "type": "number", "format": "double" }, "returnsAmount": { "type": "number", "format": "double" } } }, "FindResponseProfitReportFileHistory": { "type": "object", "properties": { "rows": { "type": "array", "description": "Строки с результатом поиска", "items": { "$ref": "#/components/schemas/ProfitReportFileHistory" } }, "total": { "type": "integer", "format": "int32", "description": "Общее количество найденных записей. Возвращается только, когда count = true" }, "page": { "type": "integer", "format": "int32", "description": "Номер запрошенной страницы" }, "hasNextPage": { "type": "boolean", "description": "Есть ли следующая страница" }, "emptyPurchase": { "type": "integer", "format": "int64", "description": "Показатель пустой закупочной цены" } } }, "ProfitReportFileHistory": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Идентификатор в коллекции при выборке, для фронта" }, "fileHistoryId": { "type": "integer", "format": "int64", "description": "Идентификатор истории загрузки профит репортов из файла" }, "serviceId": { "type": "integer", "format": "int32", "description": "Идентификатор маркетплейса" }, "organizationId": { "type": "integer", "format": "int64", "description": "Идентификатор организации" }, "clientId": { "type": "integer", "format": "int64", "description": "Идентификатор клиента" }, "createdDate": { "type": "string", "format": "date-time", "description": "Дата записи" }, "dateFrom": { "type": "string", "format": "date-time", "description": "Дата начало отчета" }, "dateTo": { "type": "string", "format": "date-time", "description": "Дата окончания отчета" }, "fileName": { "type": "string", "description": "Название загружаемого файла" }, "userName": { "type": "string", "description": "Кто загружал" }, "rowCount": { "type": "integer", "format": "int64", "description": "Кол-во строк загруженных" }, "taskId": { "type": "integer", "format": "int64", "description": "Идентификатор таски" }, "service": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] } } }, "GetProductBalanceResult": { "type": "object", "properties": { "rows": { "type": "array", "description": "Строки с результатом поиска", "items": { "$ref": "#/components/schemas/ProductBalance" } }, "total": { "type": "integer", "format": "int32", "description": "Общее количество найденных записей. Возвращается только, когда count = true" }, "page": { "type": "integer", "format": "int32", "description": "Номер запрошенной страницы" }, "hasNextPage": { "type": "boolean", "description": "Есть ли следующая страница" }, "emptyPurchase": { "type": "integer", "format": "int64", "description": "Показатель пустой закупочной цены" } } }, "ProductBalance": { "type": "object", "description": "DTO для передачи данных по остаткам на текущий момент", "properties": { "id": { "type": "integer", "format": "int64", "description": "Идентификатор" }, "organizationName": { "type": "string", "description": "Название организации" }, "shortName": { "type": "string", "description": "Сокращенное название организации" }, "categoryName": { "type": "string", "description": "Название категории" }, "brandName": { "type": "string", "description": "Название бренда" }, "article": { "type": "string", "description": "Артикул" }, "color": { "type": "string", "description": "Цвет" }, "size": { "type": "string", "description": "Размер" }, "barcode": { "type": "string", "description": "Штрих-код" }, "purchasePrice": { "type": "number", "format": "double", "description": "Закупочная цена" }, "fbsStockCount": { "type": "integer", "format": "int32", "description": "Остаток на складе" }, "fbsStockAmount": { "type": "number", "format": "double", "description": "Сумма цены товаров на складе" }, "fbsAdditionalAmount": { "type": "number", "format": "double", "description": "Дополнительные услуги" }, "wildberriesStockCount": { "type": "integer", "format": "int32", "description": "Остаток на складе ВБ" }, "wildberriesStockAmount": { "type": "number", "format": "double", "description": "Сумма цены товаров на складе ВБ" }, "wildberriesQuantityInWayFromClient": { "type": "integer", "format": "int32", "description": "От клиента, шт" }, "wildberriesQuantityInWayToClient": { "type": "integer", "format": "int32", "description": "К клиенту, шт" }, "wildberriesFinalStockCount": { "type": "integer", "format": "int32", "description": "Итого остаток FBS ВБ, шт" }, "ozonStockCount": { "type": "integer", "format": "int32", "description": "Остаток на складе ОЗОН" }, "ozonStockAmount": { "type": "number", "format": "double", "description": "Сумма цены товаров на складе ОЗОН" }, "ozonBetweenWarehousesCount": { "type": "integer", "format": "int32", "description": "между складами, шт" }, "ozonFinalStockCount": { "type": "integer", "format": "int32", "description": "Итого остаток FBS ОЗОН, шт" }, "totalBalance": { "type": "integer", "format": "int32", "description": "Всего на балансе" }, "calculatedInstockQuantity": { "type": "integer", "format": "int32", "description": "Рассчитанный остаток" }, "totalBalanceAmount": { "type": "number", "format": "double", "description": "Сумма цены по товарам на балансе" }, "salesCount": { "type": "integer", "format": "int32", "description": "Кол-во продаж" }, "forecast": { "type": "integer", "format": "int32", "description": "На сколько хватит остатка, дн." }, "isDuplicate": { "type": "boolean", "description": "Дубликат?" }, "createdDate": { "type": "string", "format": "date-time", "description": "Дата создания карточки" }, "viewWildberriesId": { "type": "integer", "format": "int64" }, "mainImageId": { "type": "integer", "format": "int64" }, "mainImageUrl": { "type": "string", "description": "URL обложки товара" }, "productName": { "type": "string", "description": "Название продукта" } } }, "FindResponseOrderReport": { "type": "object", "properties": { "rows": { "type": "array", "description": "Строки с результатом поиска", "items": { "$ref": "#/components/schemas/OrderReport" } }, "total": { "type": "integer", "format": "int32", "description": "Общее количество найденных записей. Возвращается только, когда count = true" }, "page": { "type": "integer", "format": "int32", "description": "Номер запрошенной страницы" }, "hasNextPage": { "type": "boolean", "description": "Есть ли следующая страница" }, "emptyPurchase": { "type": "integer", "format": "int64", "description": "Показатель пустой закупочной цены" } } }, "OrderReport": { "type": "object", "description": "Позиция заказа для передачи отчета по заказам", "properties": { "id": { "type": "integer", "format": "int64", "description": "Идентификатор" }, "orderId": { "type": "integer", "format": "int64", "description": "Идентификатор заказа" }, "shortOrgName": { "type": "string", "description": "Сокращенное название организации." }, "service": { "type": "string", "description": "Маркетплейс.", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] }, "mainImageUrl": { "type": "string", "description": "Ссылка на основное изображение товара на маркетплейсе" }, "orderType": { "type": "string", "description": "Тип заказа.", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "brandName": { "type": "string", "description": "Бренд." }, "categoryName": { "type": "string", "description": "Категория Selsup." }, "productName": { "type": "string", "description": "Название товара." }, "orderStatus": { "type": "string", "description": "Статус заказа.", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] }, "orderDate": { "type": "string", "format": "date-time", "description": "Дата заказа." }, "orderCollectedDate": { "type": "string", "format": "date-time", "description": "Дата сборки заказа." }, "collectUserId": { "type": "integer", "format": "int32", "description": "ID пользователя, собравшего заказ" }, "orderStartCollectDate": { "type": "string", "format": "date-time", "description": "Дата начала сборки заказа." }, "saleDate": { "type": "string", "format": "date-time", "description": "Дата покупки." }, "countDaysInRoad": { "type": "integer", "format": "int64", "description": "Дней в пути." }, "orderRegion": { "type": "string", "description": "Регион заказа." }, "salesAmount": { "type": "number", "format": "double", "description": "Цена продажи." }, "costPrice": { "type": "number", "format": "double", "description": "Себестоимость." }, "commission": { "type": "number", "format": "double", "description": "Комиссия в руб." }, "logistics": { "type": "number", "format": "double", "description": "Логистика." }, "totalSellingExpenses": { "type": "number", "format": "double", "description": "Итого расходы по продаже на МП." }, "grossProfit": { "type": "number", "format": "double", "description": "Валовая прибыль." }, "orderNumber": { "type": "string", "description": "Номер заказа." }, "sticker": { "type": "string", "description": "Стикер." }, "deliveryNumber": { "type": "string", "description": "Номер поставки." }, "ozonId": { "type": "string", "description": "Идентификатор товара на озоне." }, "wildberriesId": { "type": "string", "description": "Идентификатор товара на WB." }, "productLink": { "type": "string", "description": "Ссылка на карточку товара на маркетплейсе." }, "modelArticle": { "type": "string", "description": "Артикул." }, "article": { "type": "string", "description": "Артикул." }, "color": { "type": "string", "description": "Цвет товара." }, "size": { "type": "string", "description": "Размер товара." }, "barcode": { "type": "string", "description": "Штрихкод." }, "ozonArticle": { "type": "string", "description": "Уникальный артикул товара для озон" }, "wbArticle": { "type": "string", "description": "Артикул на Wildberries" }, "yandexMarketShopSku": { "type": "string", "description": "SKU товара на Yandex.Market" }, "aliexpressSku": { "type": "string", "description": "SKU на Aliexpress" }, "externalArticle": { "type": "string", "description": "Внешний артикул" }, "sberArticle": { "type": "string", "description": "Артикул товара на СберМегаМаркет" }, "oneCArticle": { "type": "string", "description": "Уникальный артикул товара для 1c" }, "siteArticle": { "type": "string", "description": "Артикул на сайте" }, "serviceWarehouse": { "type": "string", "description": "Склад отгрузки" }, "quantity": { "type": "integer", "format": "int64", "description": "Количество данного товара в заказе" }, "ozonPostingNumber": { "type": "string", "description": "Номер поставки OZON" }, "wildberriesRid": { "type": "string", "description": "Номер заказа WB" }, "params": { "type": "string", "description": "JSON параметров товара из productModel.params" }, "price": { "type": "number", "format": "double", "description": "Розничная цена товара" }, "bonusPrice": { "type": "number", "format": "double", "description": "Цена с бонусами продавца" }, "productPrice": { "type": "number", "format": "double", "description": "Цена в товаре" }, "purchasePrice": { "type": "number", "format": "double" }, "deliveryCost": { "type": "number", "format": "double", "description": "Дополнительные расходы на доставку товара в руб. Добавляются к закупочной цене" }, "priceWithoutDiscount": { "type": "number", "format": "double", "description": "Розничная цена товара без учета скидки" }, "wildberriesPrice": { "type": "number", "format": "double", "description": "Текущая цена товара на Вайлдбериз со скидкой", "readOnly": true }, "ozonPrice": { "type": "number", "format": "double", "description": "Текущая цена товара на Озон со скидкой", "readOnly": true }, "leroyMerlinPrice": { "type": "number", "format": "double", "description": "Текущая цена товара на LeroyMerlin" }, "avitoPrice": { "type": "number", "format": "double", "description": "Текущая цена товара на Avito" }, "sberMegaMarketPrice": { "type": "number", "format": "double", "description": "Текущая цена на СберМегаМаркет со скидкой", "readOnly": true }, "yandexMarketPrice": { "type": "number", "format": "double", "description": "Текущая цена на Яндекс.Маркет со скидкой", "readOnly": true }, "returnQuantity": { "type": "integer", "format": "int32", "description": "Количество возвращённого товара.", "readOnly": true }, "blacklisted": { "type": "boolean", "description": "Покупатель заказа в чёрном списке", "readOnly": true } } }, "FindResponseHandOnPulseReport": { "type": "object", "properties": { "rows": { "type": "array", "description": "Строки с результатом поиска", "items": { "$ref": "#/components/schemas/HandOnPulseReport" } }, "total": { "type": "integer", "format": "int32", "description": "Общее количество найденных записей. Возвращается только, когда count = true" }, "page": { "type": "integer", "format": "int32", "description": "Номер запрошенной страницы" }, "hasNextPage": { "type": "boolean", "description": "Есть ли следующая страница" }, "emptyPurchase": { "type": "integer", "format": "int64", "description": "Показатель пустой закупочной цены" } } }, "HandOnPulseReport": { "type": "object", "properties": { "shortName": { "type": "string", "description": "Сокращенное название организации." }, "categoryName": { "type": "string", "description": "Название категории." }, "brandName": { "type": "string", "description": "Название бренда." }, "name": { "type": "string", "description": "Название товара" }, "viewWildberriesId": { "type": "integer", "format": "int64", "description": "Карточка Wildberries" }, "article": { "type": "string", "description": "Артикул" }, "serviceArticle": { "type": "string", "description": "Артикул на маркетплейсе" }, "color": { "type": "string", "description": "Цвет товара." }, "size": { "type": "string", "description": "Размер товара." }, "barcode": { "type": "string", "description": "Шк товара." }, "purchasePrice": { "type": "number", "format": "double", "description": "Закупочная цена." }, "createdDate": { "type": "string", "format": "date-time", "description": "Дата создания карточки." }, "isDuplicate": { "type": "boolean", "description": "Признак дубликата карточки." }, "dateKey": { "type": "string", "description": "Ключ по дате." }, "salesCount": { "type": "integer", "format": "int64", "description": "Продажи в шт." }, "salesCountConventional": { "type": "number", "format": "double", "description": "Продажи в у.е." }, "returnsCount": { "type": "integer", "format": "int64", "description": "Возвраты в шт." }, "returnsCountConventional": { "type": "number", "format": "double", "description": "Возвраты в у.е." }, "totalSalesCount": { "type": "integer", "format": "int64", "description": "Разница между продажами и возвратами в шт. salesCount - returnsCount" }, "totalSalesCountConventional": { "type": "number", "format": "double", "description": "Разница между продажами и возвратами в у.е." }, "salesAmount": { "type": "number", "format": "double", "description": "Продажи в руб." }, "returnsAmount": { "type": "number", "format": "double", "description": "Возвраты в руб." }, "averageReturnsAmount": { "type": "number", "format": "double", "description": "Возвраты в руб. за 1 ед" }, "totalSalesAmount": { "type": "number", "format": "double", "description": "Разница между продажами и возвратами в руб. salesAmount - returnsAmount" }, "orderAmount": { "type": "number", "format": "double", "description": "Заказы в руб." }, "orderAmountWithoutCancel": { "type": "number", "format": "double", "description": "Заказы в руб. без отмен" }, "logistics": { "type": "number", "format": "double", "description": "Логистика в руб." }, "averageLogistics": { "type": "number", "format": "double", "description": "Средняя логистика в руб." }, "logisticsShare": { "type": "number", "format": "double", "description": "Доля логистики в структуре выручки, %" }, "commissions": { "type": "number", "format": "double", "description": "Комиссия в руб." }, "acquiring": { "type": "number", "format": "double", "description": "Эквайринг в руб." }, "averageCommissions": { "type": "number", "format": "double", "description": "Средняя комиссия в руб." }, "penalty": { "type": "number", "format": "double", "description": "Штрафы в руб." }, "additional": { "type": "number", "format": "double", "description": "Доплаты в руб." }, "refundsAndCancellations": { "type": "number", "format": "double", "description": "Возвраты и отмены в руб." }, "compensationAmount": { "type": "number", "format": "double", "description": "Компенсации в руб." }, "additionalAndDeduction": { "type": "number", "format": "double", "description": "Доплаты и удержания в руб. в файле финансах ячейка Доплаты" }, "services": { "type": "number", "format": "double", "description": "Услуги в руб." }, "drr": { "type": "number", "format": "double", "description": "ДРР, %" }, "totalToBePaid": { "type": "number", "format": "double", "description": "Итого к оплате. totalSalesAmount - logistics - commission - penalties - additional - services + otherAmount - costStorage - campaignCost" }, "averageToBePaid": { "type": "number", "format": "double", "description": "Итого к оплате за 1 товар." }, "productCount": { "type": "integer", "format": "int64", "description": "Товарный остаток FBS + FBO на текущий момент." }, "salesAmountInPurchasePrice": { "type": "number", "format": "double", "description": "Проданный товар в закупочных ценах, руб." }, "productAmount": { "type": "number", "format": "double", "description": "Сумма по товарному остатку purchasePrice * productCount" }, "averageSellingPrice": { "type": "number", "format": "double", "description": "Средняя фактическая цена продажи" }, "markUp": { "type": "number", "format": "double", "description": "Фактическая наценка totalToBePaid / (purchasePrice * totalSalesCount)" }, "margin": { "type": "number", "format": "double", "description": "Маржинальность" }, "grossProfit": { "type": "number", "format": "double", "description": "Валовая прибыль totalToBePaid - totalSalesCount * purchasePrice - selPayAmount" }, "averageGrossProfit": { "type": "number", "format": "double", "description": "Валовая прибыль за 1 ед." }, "ratioInIncome": { "type": "number", "format": "double", "description": "Доля в выручке" }, "rationInGrossProfit": { "type": "number", "format": "double", "description": "Доля в валовой прибыли в % grossProfit / SUM(grossProfit)" }, "ratioInProductCount": { "type": "number", "format": "double", "description": "Доля в товарном остатке в % productAmount / SUM(productAmount)" }, "efficiencyForIncome": { "type": "number", "format": "double", "description": "Эффективность по выручке ratioInIncome / ratioInProductCount" }, "grossProfitEfficiency": { "type": "number", "format": "double", "description": "Эффективность по валовой прибыли rationInGrossProfit / ratioInProductCount" }, "averageExpenses": { "type": "number", "format": "double", "description": "Средний расходов по продаже на МП на 1 ед товара, руб. все расходы в руб / продажи - возвраты в шт" }, "otherAmount": { "type": "number", "format": "double", "description": "Прочие начисления, руб." }, "percentRedemption": { "type": "number", "format": "double", "description": "Процент выкупа. Продажи/(Продажи+Возвраты)*100 только для ВБ" }, "orderCount": { "type": "integer", "format": "int64", "description": "Кол-во заказов в шт." }, "orderCountWithoutCancel": { "type": "integer", "format": "int64", "description": "Кол-во заказов в шт. без отмен" }, "nonPurchasePriceCount": { "type": "integer", "format": "int64", "description": "Кол-во profitRepot где не указана закупочная цена, шт." }, "selfPayCount": { "type": "integer", "format": "int64", "description": "Кол-во самовыкупов, шт." }, "selfPayAmount": { "type": "number", "format": "double", "description": "Сумма самовыкупов, руб." }, "costStorage": { "type": "number", "format": "double", "description": "Сумма за хранения товара на МП, получаем только по ВБ через импорт файла." }, "campaignCost": { "type": "number", "format": "double", "description": "Затраты на рекламу, получаем только по ВБиз импорта статистики по рекламным кампаниям" }, "wbSpp": { "type": "number", "format": "double", "description": "Сумма скидки постоянного покупателя на ВБ" }, "wbTotalSalesByPriceWithDisc": { "type": "number", "format": "double", "description": "Сумма продажи ВБ, по цене со скидкой продажи - возвраты" }, "otherDeductions": { "type": "number", "format": "double", "description": "Прочие удержания WB" }, "averageExpensesOnMP": { "type": "number", "format": "double", "description": "Средний расход по продаже на МП на 1 ед товара(берутся все расходы на МП по товару)" }, "compensationForLostItemOnWb": { "type": "number", "format": "double", "description": "Компенсация за утерянный товар от WB" }, "productAmountSum": { "type": "number", "format": "double" }, "totalSalesAmountPositiveSum": { "type": "number", "format": "double" }, "grossProfitPositiveSum": { "type": "number", "format": "double" }, "acceptance": { "type": "number", "format": "double", "description": "Платная приёмка" }, "cancelsCount": { "type": "integer", "format": "int64", "description": "Количество отмен" }, "ymBonus": { "type": "number", "format": "double", "description": "Баллы Яндекс Маркета" }, "id": { "type": "integer", "format": "int64", "description": "Идентификатор" }, "productId": { "type": "integer", "format": "int64", "description": "Идентификатор товара" }, "productViewId": { "type": "integer", "format": "int64", "description": "Идентификатор цвета товара" }, "productModelId": { "type": "integer", "format": "int64", "description": "Идентификатор модели товара" }, "brandId": { "type": "integer", "format": "int64", "description": "Идентификатор бренда товара" }, "categoryId": { "type": "integer", "format": "int64", "description": "Идентификатор категории товара" }, "deleted": { "type": "boolean", "description": "Товар удален?" }, "totalCount": { "type": "integer", "format": "int32", "description": "Всего найдено строк для отчетов" }, "instockQuantity": { "type": "integer", "format": "int64", "description": "Кол-во остатков на складе FBS" }, "fboQuantity": { "type": "integer", "format": "int64", "description": "Количество остатков на складах FBO" }, "ozonStockCount": { "type": "integer", "format": "int32", "description": "Количество остатков на складах Ozon" }, "wildberriesStockCount": { "type": "integer", "format": "int32", "description": "Количество остатков на складах Wildberries" }, "yandexMarketStockCount": { "type": "integer", "format": "int32", "description": "Количество остатков на складах Yandex.Market" }, "ozonArticle": { "type": "string", "description": "Уникальный артикул товара для озон" }, "wbArticle": { "type": "string", "description": "Название на Wildberries" }, "yandexMarketShopSku": { "type": "string", "description": "SKU товара на Yandex.Market" }, "aliexpressSku": { "type": "string", "description": "SKU на Aliexpress" }, "sberArticle": { "type": "string", "description": "Артикул товара на СберМегаМаркет" }, "oneCArticle": { "type": "string", "description": "Уникальный артикул товара для 1c" }, "lastWildberriesSaleDate": { "type": "string", "format": "date-time", "description": "Дата последней продажи WB" }, "lastWildberriesOrderDate": { "type": "string", "format": "date-time", "description": "Дата последнего заказа на WB" }, "lastOzonSaleDate": { "type": "string", "format": "date-time", "description": "Дата последней продажи Ozon" }, "lastOzonOrderDate": { "type": "string", "format": "date-time", "description": "Дата последнего заказа на Ozon" }, "service": { "type": "string", "description": "Выбранный в запросе МП", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE", "MAGNIT", "OPENCART", "M_VIDEO", "TAKEALOT", "UZUM", "SHOPIFY" ] }, "orgTaxRate": { "type": "number", "format": "double", "description": "Процентная ставка налога организации" }, "prodTaxRate": { "type": "number", "format": "double", "description": "Процентная ставка налога товара" }, "taxType": { "type": "string", "description": "Тип налогообложения", "enum": [ "YSN", "YSN_CONSUMPTION", "OSNO", "SELF_EMPLOYED" ] }, "netProfitRub": { "type": "number", "format": "double", "description": "Чистая прибыль" }, "netProfitRubPerUnit": { "type": "number", "format": "double", "description": "Чистая прибыль за 1ед." }, "otherExpenses": { "type": "number", "format": "double", "description": "Дополнительныеы расходы на проданный товар, руб." }, "strategyId": { "type": "integer", "format": "int64", "description": "Идентификатор стратегии ценообразования" }, "inputVat": { "type": "number", "format": "double", "description": "Входящий НДС, руб." }, "outputVat": { "type": "number", "format": "double", "description": "Исходящий НДС, руб." }, "finalVat": { "type": "number", "format": "double", "description": "Итоговый НДС (исходящий - входящий), руб." }, "incomeTax": { "type": "number", "format": "double", "description": "Налог на прибыль, руб." }, "totalTax": { "type": "number", "format": "double", "description": "Общий налог (НДС + налог на прибыль), руб." }, "ozonDeliveryReturn": { "type": "number", "format": "double", "description": "Перечисление за доставку от покупателя, должно идти в прибыль" }, "paidServiceCommissionPercentOzon": { "type": "number", "format": "double", "description": "Процент комиссии платных услуг Ozon" }, "paidServiceCommissionPercentWildberries": { "type": "number", "format": "double", "description": "Процент комиссии платных услуг Wildberries" }, "paidServiceCommissionPercent": { "type": "number", "format": "double", "description": "Суммарный процент комиссий платных услуг" }, "paidServiceCommissionAmount": { "type": "number", "format": "double", "description": "Сумма комиссий платных услуг, руб." }, "managerWb": { "type": "string", "description": "Менеджер WB" }, "managerYandex": { "type": "string", "description": "Менеджер Yandex" }, "managerOzon": { "type": "string", "description": "Менеджер Ozon" }, "managerMain": { "type": "string", "description": "Менеджер Основной" }, "organizationId": { "type": "integer", "format": "int64", "description": "Идентификатор организации" }, "mainImageUrl": { "type": "string", "description": "Ссылка на основное изображение товара" }, "params": { "type": "string", "description": "JSON параметров товара из productModel.params" }, "planSalesCount": { "type": "integer", "format": "int64", "description": "План продаж в шт(Продажи - возвраты)" }, "articles": { "type": "string", "description": "Все артикулы МП которые есть у клиента по товару" }, "averageProfit": { "type": "number", "format": "double", "description": "Средняя прибыль за 1 единицу товара рублесы" }, "totalExpensesAmount": { "type": "number", "format": "double", "description": "Общий расход за период" }, "periodDateReport": { "type": "string", "format": "date", "description": "Период" }, "expenses": { "type": "number", "format": "double", "description": "Сумма за рекламу" }, "campaignOrderAmount": { "type": "number", "format": "double", "description": "Сумма заказов" }, "quantityAddCart": { "type": "integer", "format": "int32", "description": "Добавлений в корзину" }, "clicks": { "type": "integer", "format": "int64", "description": "Кол-во кликов" }, "views": { "type": "integer", "format": "int64", "description": "Кол-во показов" }, "planSales": { "type": "array", "description": "Список плана продаж", "items": { "$ref": "#/components/schemas/PlanSales" } }, "purchasePercent": { "type": "number", "format": "double", "description": "Средний процент выкупа по всем МП" }, "averageCostCampaignOnOneClick": { "type": "number", "format": "double", "description": "Средняя стоимость клика" }, "quantityProductOrdersInCampaign": { "type": "integer", "format": "int32", "description": "Количество заказанных товаров в рекламной кампании, шт." }, "serviceId": { "$ref": "#/components/schemas/ProductAnalytics", "writeOnly": true } } }, "FindResponsePlanFactSalesReport": { "type": "object", "properties": { "rows": { "type": "array", "description": "Строки с результатом поиска", "items": { "$ref": "#/components/schemas/PlanFactSalesReport" } }, "total": { "type": "integer", "format": "int32", "description": "Общее количество найденных записей. Возвращается только, когда count = true" }, "page": { "type": "integer", "format": "int32", "description": "Номер запрошенной страницы" }, "hasNextPage": { "type": "boolean", "description": "Есть ли следующая страница" }, "emptyPurchase": { "type": "integer", "format": "int64", "description": "Показатель пустой закупочной цены" } } }, "PlanFactSalesReport": { "type": "object", "description": "DTO для отчета план/факт продаж.", "properties": { "shortName": { "type": "string", "description": "Сокращенное название организации." }, "categoryName": { "type": "string", "description": "Название категории." }, "brandName": { "type": "string", "description": "Название бренда." }, "name": { "type": "string", "description": "Название товара" }, "viewWildberriesId": { "type": "integer", "format": "int64", "description": "Карточка Wildberries" }, "article": { "type": "string", "description": "Артикул" }, "serviceArticle": { "type": "string", "description": "Артикул на маркетплейсе" }, "color": { "type": "string", "description": "Цвет товара." }, "size": { "type": "string", "description": "Размер товара." }, "barcode": { "type": "string", "description": "Шк товара." }, "purchasePrice": { "type": "number", "format": "double", "description": "Закупочная цена." }, "createdDate": { "type": "string", "format": "date-time", "description": "Дата создания карточки." }, "isDuplicate": { "type": "boolean", "description": "Признак дубликата карточки." }, "dateKey": { "type": "string", "description": "Ключ по дате." }, "organizationId": { "type": "integer", "format": "int64", "description": "id организации" }, "totalStocksCount": { "type": "integer", "format": "int64", "description": "Остаток FBS + FBO." }, "totalFBOStocksCount": { "type": "integer", "format": "int64", "description": "Остаток FBO" }, "planSalesCount": { "type": "integer", "format": "int64", "description": "План продаж в шт(Продажи - возвраты)" }, "planSalesAmount": { "type": "number", "format": "double", "description": "План продаж в руб(Продажи - возвраты)" }, "salesCount": { "type": "integer", "format": "int64", "description": "Кол-во продаж в шт(Продажи - возвраты)" }, "salesAmount": { "type": "number", "format": "double", "description": "Сумма продаж в руб(Продажи - возвраты)" }, "date": { "type": "string", "format": "date-time", "description": "Дата" }, "lastDate": { "type": "string", "format": "date-time", "description": "Последняя дата с заполненным планом либо фактической продажей" }, "totalCount": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int64" }, "month": { "type": "string", "description": "Месяц" }, "year": { "type": "integer", "format": "int32", "description": "Год" }, "week": { "type": "integer", "format": "int32", "description": "Неделя" }, "dateFrom": { "type": "string", "format": "date-time", "description": "Начало периода" }, "dateTo": { "type": "string", "format": "date-time", "description": "Конец периода" }, "planSalesProfit": { "type": "number", "format": "double" }, "salesProfit": { "type": "number", "format": "double" } } }, "StockBalance": { "type": "object", "description": "DTO для передачи данных по остаткам на складе", "properties": { "fbsCount": { "type": "integer", "format": "int64" }, "fbsAmount": { "type": "number", "format": "double" }, "fboCount": { "type": "integer", "format": "int64" }, "fboAmount": { "type": "number", "format": "double" } } }, "ContractorsReport": { "type": "object", "description": "DTO для передачи отчета по поставщикам", "properties": { "shortName": { "type": "string", "description": "Сокращенное название организации." }, "categoryName": { "type": "string", "description": "Название категории." }, "brandName": { "type": "string", "description": "Название бренда." }, "name": { "type": "string", "description": "Название товара" }, "viewWildberriesId": { "type": "integer", "format": "int64", "description": "Карточка Wildberries" }, "article": { "type": "string", "description": "Артикул" }, "serviceArticle": { "type": "string", "description": "Артикул на маркетплейсе" }, "color": { "type": "string", "description": "Цвет товара." }, "size": { "type": "string", "description": "Размер товара." }, "barcode": { "type": "string", "description": "Шк товара." }, "purchasePrice": { "type": "number", "format": "double", "description": "Закупочная цена." }, "createdDate": { "type": "string", "format": "date-time", "description": "Дата создания карточки." }, "isDuplicate": { "type": "boolean", "description": "Признак дубликата карточки." }, "dateKey": { "type": "string", "description": "Ключ по дате." }, "salesCount": { "type": "integer", "format": "int64", "description": "Продажи в шт." }, "salesCountConventional": { "type": "number", "format": "double", "description": "Продажи в у.е." }, "returnsCount": { "type": "integer", "format": "int64", "description": "Возвраты в шт." }, "returnsCountConventional": { "type": "number", "format": "double", "description": "Возвраты в у.е." }, "totalSalesCount": { "type": "integer", "format": "int64", "description": "Разница между продажами и возвратами в шт. salesCount - returnsCount" }, "totalSalesCountConventional": { "type": "number", "format": "double", "description": "Разница между продажами и возвратами в у.е." }, "salesAmount": { "type": "number", "format": "double", "description": "Продажи в руб." }, "returnsAmount": { "type": "number", "format": "double", "description": "Возвраты в руб." }, "averageReturnsAmount": { "type": "number", "format": "double", "description": "Возвраты в руб. за 1 ед" }, "totalSalesAmount": { "type": "number", "format": "double", "description": "Разница между продажами и возвратами в руб. salesAmount - returnsAmount" }, "orderAmount": { "type": "number", "format": "double", "description": "Заказы в руб." }, "orderAmountWithoutCancel": { "type": "number", "format": "double", "description": "Заказы в руб. без отмен" }, "logistics": { "type": "number", "format": "double", "description": "Логистика в руб." }, "averageLogistics": { "type": "number", "format": "double", "description": "Средняя логистика в руб." }, "logisticsShare": { "type": "number", "format": "double", "description": "Доля логистики в структуре выручки, %" }, "commissions": { "type": "number", "format": "double", "description": "Комиссия в руб." }, "acquiring": { "type": "number", "format": "double", "description": "Эквайринг в руб." }, "averageCommissions": { "type": "number", "format": "double", "description": "Средняя комиссия в руб." }, "penalty": { "type": "number", "format": "double", "description": "Штрафы в руб." }, "additional": { "type": "number", "format": "double", "description": "Доплаты в руб." }, "refundsAndCancellations": { "type": "number", "format": "double", "description": "Возвраты и отмены в руб." }, "compensationAmount": { "type": "number", "format": "double", "description": "Компенсации в руб." }, "additionalAndDeduction": { "type": "number", "format": "double", "description": "Доплаты и удержания в руб. в файле финансах ячейка Доплаты" }, "services": { "type": "number", "format": "double", "description": "Услуги в руб." }, "drr": { "type": "number", "format": "double", "description": "ДРР, %" }, "totalToBePaid": { "type": "number", "format": "double", "description": "Итого к оплате. totalSalesAmount - logistics - commission - penalties - additional - services + otherAmount - costStorage - campaignCost" }, "averageToBePaid": { "type": "number", "format": "double", "description": "Итого к оплате за 1 товар." }, "productCount": { "type": "integer", "format": "int64", "description": "Товарный остаток FBS + FBO на текущий момент." }, "salesAmountInPurchasePrice": { "type": "number", "format": "double", "description": "Проданный товар в закупочных ценах, руб." }, "productAmount": { "type": "number", "format": "double", "description": "Сумма по товарному остатку purchasePrice * productCount" }, "averageSellingPrice": { "type": "number", "format": "double", "description": "Средняя фактическая цена продажи" }, "markUp": { "type": "number", "format": "double", "description": "Фактическая наценка totalToBePaid / (purchasePrice * totalSalesCount)" }, "margin": { "type": "number", "format": "double", "description": "Маржинальность" }, "grossProfit": { "type": "number", "format": "double", "description": "Валовая прибыль totalToBePaid - totalSalesCount * purchasePrice - selPayAmount" }, "averageGrossProfit": { "type": "number", "format": "double", "description": "Валовая прибыль за 1 ед." }, "ratioInIncome": { "type": "number", "format": "double", "description": "Доля в выручке" }, "rationInGrossProfit": { "type": "number", "format": "double", "description": "Доля в валовой прибыли в % grossProfit / SUM(grossProfit)" }, "ratioInProductCount": { "type": "number", "format": "double", "description": "Доля в товарном остатке в % productAmount / SUM(productAmount)" }, "efficiencyForIncome": { "type": "number", "format": "double", "description": "Эффективность по выручке ratioInIncome / ratioInProductCount" }, "grossProfitEfficiency": { "type": "number", "format": "double", "description": "Эффективность по валовой прибыли rationInGrossProfit / ratioInProductCount" }, "averageExpenses": { "type": "number", "format": "double", "description": "Средний расходов по продаже на МП на 1 ед товара, руб. все расходы в руб / продажи - возвраты в шт" }, "otherAmount": { "type": "number", "format": "double", "description": "Прочие начисления, руб." }, "percentRedemption": { "type": "number", "format": "double", "description": "Процент выкупа. Продажи/(Продажи+Возвраты)*100 только для ВБ" }, "orderCount": { "type": "integer", "format": "int64", "description": "Кол-во заказов в шт." }, "orderCountWithoutCancel": { "type": "integer", "format": "int64", "description": "Кол-во заказов в шт. без отмен" }, "nonPurchasePriceCount": { "type": "integer", "format": "int64", "description": "Кол-во profitRepot где не указана закупочная цена, шт." }, "selfPayCount": { "type": "integer", "format": "int64", "description": "Кол-во самовыкупов, шт." }, "selfPayAmount": { "type": "number", "format": "double", "description": "Сумма самовыкупов, руб." }, "costStorage": { "type": "number", "format": "double", "description": "Сумма за хранения товара на МП, получаем только по ВБ через импорт файла." }, "campaignCost": { "type": "number", "format": "double", "description": "Затраты на рекламу, получаем только по ВБиз импорта статистики по рекламным кампаниям" }, "wbSpp": { "type": "number", "format": "double", "description": "Сумма скидки постоянного покупателя на ВБ" }, "wbTotalSalesByPriceWithDisc": { "type": "number", "format": "double", "description": "Сумма продажи ВБ, по цене со скидкой продажи - возвраты" }, "otherDeductions": { "type": "number", "format": "double", "description": "Прочие удержания WB" }, "averageExpensesOnMP": { "type": "number", "format": "double", "description": "Средний расход по продаже на МП на 1 ед товара(берутся все расходы на МП по товару)" }, "compensationForLostItemOnWb": { "type": "number", "format": "double", "description": "Компенсация за утерянный товар от WB" }, "productAmountSum": { "type": "number", "format": "double" }, "totalSalesAmountPositiveSum": { "type": "number", "format": "double" }, "grossProfitPositiveSum": { "type": "number", "format": "double" }, "acceptance": { "type": "number", "format": "double", "description": "Платная приемка" }, "cancelsCount": { "type": "integer", "format": "int64", "description": "Количество отмен" }, "ymBonus": { "type": "number", "format": "double", "description": "Баллы Яндекс Маркета" }, "id": { "type": "integer", "format": "int64", "description": "Идентификатор" }, "contractorName": { "type": "string", "description": "Наименование поставщика" } } }, "FindResponseContractorsReport": { "type": "object", "properties": { "rows": { "type": "array", "description": "Строки с результатом поиска", "items": { "$ref": "#/components/schemas/ContractorsReport" } }, "total": { "type": "integer", "format": "int32", "description": "Общее количество найденных записей. Возвращается только, когда count = true" }, "page": { "type": "integer", "format": "int32", "description": "Номер запрошенной страницы" }, "hasNextPage": { "type": "boolean", "description": "Есть ли следующая страница" }, "emptyPurchase": { "type": "integer", "format": "int64", "description": "Показатель пустой закупочной цены" } } }, "CommonStat": { "type": "object", "properties": { "wildberriesGoodsCount": { "type": "integer", "format": "int32" }, "wildberriesStockPurchaseAmount": { "type": "integer", "format": "int32" }, "ozonGoodsCount": { "type": "integer", "format": "int32" }, "ozonStockPurchaseAmount": { "type": "integer", "format": "int32" }, "goodsCount": { "type": "integer", "format": "int32" }, "goodsPurchaseAmount": { "type": "integer", "format": "int32" } } }, "ClientProductsStat": { "type": "object", "properties": { "category": { "$ref": "#/components/schemas/Category" }, "ordersCount": { "type": "integer", "format": "int32" }, "ordersCountPercentage": { "type": "number", "format": "double" }, "ordersRubSum": { "type": "integer", "format": "int32" }, "ordersRubSumPercentage": { "type": "number", "format": "double" }, "salesCount": { "type": "integer", "format": "int32" }, "salesCountPercentage": { "type": "number", "format": "double" }, "salesRubSum": { "type": "integer", "format": "int32" }, "salesRubSumPercentage": { "type": "number", "format": "double" }, "productViewsOnStocks": { "type": "integer", "format": "int32" }, "productViewsOnStocksWithoutSales": { "type": "integer", "format": "int32" }, "productsOnStocks": { "type": "integer", "format": "int32" }, "productsOnStocksWithoutSales": { "type": "integer", "format": "int32" }, "productViewIncomeCount": { "type": "integer", "format": "int32" }, "productIncomeCount": { "type": "integer", "format": "int32" }, "productViewsHasLeftCount": { "type": "integer", "format": "int32" }, "productsHasLeftCount": { "type": "integer", "format": "int32" } } }, "AbcAnalysisResult": { "type": "object", "properties": { "fullStatByGroup": { "type": "array", "description": "Статистика по группам", "items": { "$ref": "#/components/schemas/AbcStatByGroup" } }, "rows": { "type": "array", "description": "Статистика по артикулам", "items": { "$ref": "#/components/schemas/AbcReport" } }, "totalCount": { "type": "integer", "format": "int32" } } }, "AbcReport": { "type": "object", "description": "ABC анализ по артикулу", "properties": { "id": { "type": "integer", "format": "int64" }, "article": { "type": "string" }, "orgUniqueArticle": { "type": "string" }, "color": { "type": "string" }, "modelView": { "type": "string" }, "orgUniqueModelView": { "type": "string" }, "productModelId": { "type": "integer", "format": "int64" }, "organizationName": { "type": "string" }, "organizationId": { "type": "integer", "format": "int64" }, "brandName": { "type": "string" }, "categoryName": { "type": "string" }, "categoryId": { "type": "integer", "format": "int32" }, "stocksCount": { "type": "integer", "format": "int32", "description": "Остаток FBS + FBO" }, "stocksPercent": { "type": "number", "format": "double", "description": "Доля в остатке в %" }, "profit": { "type": "number", "format": "double", "description": "Выручка или валовая прибыль" }, "profitPercent": { "type": "number", "format": "double", "description": "Доля в общей выручке или валовой прибыли в %" }, "collectPercent": { "type": "number", "format": "double", "description": "Накопленная доля по выручке или валовой прибыли %" }, "group": { "type": "string", "description": "Группа по выручке или валовой прибыли: A, B или C", "enum": [ "A", "B", "C" ] }, "groupWeighted": { "type": "string", "description": "Группа по выручке или валовой прибыли в нормализованном виде: A, B или C", "enum": [ "A", "B", "C" ] }, "product": { "$ref": "#/components/schemas/Product" } } }, "AbcStatByGroup": { "type": "object", "properties": { "group": { "type": "string" }, "productsCount": { "type": "integer", "format": "int32", "description": "Количество артикулов в данной группе по выручке или по валовой прибыли" }, "countPercent": { "type": "number", "format": "double", "description": "Доля артикулов от общего количества в % по выручке или по валовой прибыли" }, "profitSum": { "type": "number", "format": "double", "description": "Сумма валовой прибыли или выручки по артикулам группы" }, "profitSumPercent": { "type": "number", "format": "double", "description": "Доля выручки или валовой прибыли группы от общей суммы в %" } } }, "TipsResponse": { "type": "object", "properties": { "tips": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Tip" } } } }, "FindResponseRealizationReport": { "type": "object", "properties": { "rows": { "type": "array", "description": "Строки с результатом поиска", "items": { "$ref": "#/components/schemas/RealizationReport" } }, "total": { "type": "integer", "format": "int32", "description": "Общее количество найденных записей. Возвращается только, когда count = true" }, "page": { "type": "integer", "format": "int32", "description": "Номер запрошенной страницы" }, "hasNextPage": { "type": "boolean", "description": "Есть ли следующая страница" }, "emptyPurchase": { "type": "integer", "format": "int64", "description": "Показатель пустой закупочной цены" } } }, "RealizationReport": { "type": "object", "description": "ДТО для отчета по реализациям с МП", "properties": { "id": { "type": "integer", "format": "int64" }, "realizationReportId": { "type": "string", "description": "Номер отчета WB и идентификатор операции ozon и sbermarket" }, "currencyName": { "type": "string", "description": "Оригинальная валюта отчёта" }, "currentCurrency": { "type": "string", "description": "Валюта отчёта" }, "originalValues": { "type": "string", "description": "Суммы в первоначальной валюте отчёта" }, "dateFrom": { "type": "string", "format": "date-time", "description": "Дата начала отчетного периода" }, "dateTo": { "type": "string", "format": "date-time", "description": "Дата конца отчетного периода" }, "supplierContractCode": { "type": "string", "description": "Договор" }, "rid": { "type": "string", "description": "Уникальный идентификатор позиции заказа" }, "operationDate": { "type": "string", "format": "date-time", "description": "Дата операции" }, "createDate": { "type": "string", "format": "date-time", "description": "Дата формирования отчёта WB" }, "rrdId": { "type": "integer", "format": "int64", "description": "Номер строки" }, "giId": { "type": "integer", "format": "int64", "description": "Номер поставки" }, "subjectName": { "type": "string", "description": "Название товара(товаров) WB или ozon(Items.name)" }, "productCode": { "type": "string", "description": "Артикул WB(nm_id) или код SKU ozon(Items.sku) Артикул СМ(p.sber_article)" }, "brandName": { "type": "string", "description": "Бренд" }, "saName": { "type": "string", "description": "Артикул поставщика" }, "tsName": { "type": "string", "description": "Размер" }, "barcode": { "type": "string" }, "docTypeName": { "type": "string", "description": "Тип документа" }, "quantity": { "type": "integer", "format": "int64", "description": "Количество" }, "retailPrice": { "type": "number", "format": "double", "description": "Цена розничная" }, "retailAmount": { "type": "number", "format": "double", "description": "Сумма продаж(Возвратов), до вычетов." }, "salePercent": { "type": "number", "format": "double", "description": "Согласованная скидка" }, "commissionPercent": { "type": "number", "format": "double", "description": "Процент комиссии" }, "officeName": { "type": "string", "description": "Склад" }, "supplierOperName": { "type": "string", "description": "Обоснование для оплаты " }, "supplierOperNameId": { "type": "integer", "format": "int32", "description": "Идентификатор обоснования для оплаты " }, "orderType": { "type": "string", "description": "Тип заказа Wildberries" }, "orderDate": { "type": "string", "format": "date-time", "description": "Даты заказа WB и OZON" }, "saleDate": { "type": "string", "format": "date-time", "description": "Дата продажи" }, "shkId": { "type": "string", "description": "ШК" }, "retailPriceWithDiscRub": { "type": "number", "format": "double", "description": "Цена розничная с учетом согласованной скидки" }, "deliveryAmount": { "type": "integer", "format": "int64", "description": "Кол-во доставок" }, "returnAmount": { "type": "integer", "format": "int64", "description": "Кол-во возвратов" }, "returnFlag": { "type": "boolean", "description": "Маркер возврата sbermarket" }, "deliveryCharge": { "type": "number", "format": "double", "description": "Стоимость логистики" }, "giBoxTypeName": { "type": "string", "description": "Тип коробов" }, "productDiscountForReport": { "type": "string", "description": "Согласованный продуктовый дисконт" }, "supplierPromo": { "type": "string", "description": "Промокод" }, "ppvzSppPrc": { "type": "number", "format": "double", "description": "Скидка постоянного Покупателя (СПП)" }, "ppvzKvwPrcBase": { "type": "number", "format": "double", "description": "Размер кВВ без НДС, % Базовый" }, "ppvzKvwPrc": { "type": "number", "format": "double", "description": "Итоговый кВВ без НДС, %" }, "saleCommission": { "type": "number", "format": "double", "description": "Комиссия торговой площадки в рублях." }, "income": { "type": "number", "format": "double", "description": "К перечислению Продавцу за реализованный Товар WB(ppvz_for_pay).ozon(amount) уже вычитает комиссию и оплату своих сервисов." }, "ppvzReward": { "type": "number", "format": "double", "description": "Возмещение Расходов услуг поверенного" }, "ppvzVw": { "type": "number", "format": "double", "description": "Комиссия торговой площадки, без НДС" }, "ppvzVwNds": { "type": "number", "format": "double", "description": "НДС с Вознаграждения Вайлдберриз" }, "ppvzOfficeId": { "type": "integer", "format": "int64", "description": "Номер офиса WB или номер склада OZON" }, "ppvzOfficeName": { "type": "string", "description": "Наименование офиса доставки" }, "ppvzSupplierId": { "type": "string", "description": "Номер партнера" }, "ppvzSupplierName": { "type": "string", "description": "Партнер" }, "ppvzInn": { "type": "string", "description": "ИНН партнера" }, "clientId": { "type": "integer", "format": "int64" }, "organizationId": { "type": "integer", "format": "int64", "description": "Идентификатор организации, по которой" }, "productId": { "type": "integer", "format": "int64", "description": "Идентификатор товара, к которому относится операция" }, "productModelId": { "type": "integer", "format": "int64", "description": "Идентификатор модели товара, к которому относится операция" }, "productViewId": { "type": "integer", "format": "int64", "description": "Идентификатор цвета товара, к которому относится операция" }, "serviceId": { "type": "integer", "format": "int32", "description": "Тип сервиса для которого предназначен отчет." }, "ozonPostingNumber": { "type": "string", "description": "ozon номер отправления." }, "ozonReturnDeliveryCharge": { "type": "number", "format": "double", "description": "ozon плата за доставку возврата." }, "operationType": { "type": "string", "description": "Тип операции.", "enum": [ "CLIENT_RETURN_AGENT_OPERATION", "OPERATION_AGENT_DELIVERED_TO_CUSTOMER", "OPERATION_AGENT_DELIVERED_TO_CUSTOMER_CANCELED", "OPERATION_AGENT_STORNO_DELIVERED_TO_CUSTOMER", "OPERATION_ITEM_RETURN", "MARKETPLACE_MARKETING_ACTION_COST_OPERATION", "MARKETPLACE_SALE_REVIEWS_OPERATION", "MARKETPLACE_SELLER_COMPENSATION_OPERATION", "OPERATION_CLAIM", "OPERATION_CORRECTION_SELLER", "OPERATION_DEFECTIVE_WRITE_OFF", "OPERATION_LACK_WRITE_OFF", "OPERATION_MARKETPLACE_CROSS_DOCK_SERVICE_WRITE_OFF", "OPERATION_MARKETPLACE_SERVICE_STORAGE", "OPERATION_SET_OFF", "MARKETPLACE_SELLER_REEXPOSURE_DELIVERY_RETURN_OPERATION", "OPERATION_RETURN_GOODS_FB_SOF_RMS", "RETURN_AGENT_OPERATION_RFBS", "MARKETPLACE_SELLER_SHIPPING_COMPENSATION_RETURN_OPERATION", "OPERATION_MARKETPLACE_SERVICE_PREMIUM_CASHBACK", "OPERATION_MARKETPLACE_SERVICE_STOCK_DISPOSAL", "MARKETPLACE_SELLER_COMPENSATION_ITEM_OPERATION", "MARKETPLACE_SELLER_INSTALLMENT_OPERATION", "OPERATION_MARKETPLACE_SERVICE_PROCESSING_NOT_IDENTIFIED_SURPLUS", "MARKETPLACE_SELLER_CORRECTION_OPERATION", "MARKETPLACE_SHIPMENT_MOVING_OPERATION", "OPERATION_MARKETPLACE_SERVICE_PREMIUM_CASHBACK_INDIVIDUAL_POINTS", "OPERATION_CORRECTION_REALIZATION_REPORT_COMMISSION", "OPERATION_MARKETPLACE_WITHHOLDING_FOR_UNDELIVERABLE_GOODS", "MARKETPLACE_REDISTRIBUTION_OF_ACQUIRING_OPERATION", "DEFAULT", "MARKETPLACE_SERVICE_ITEM_OTHER_MARKET_AND_TECH_SERVICE", "CAMPAIGN_OPERATION", "ITEM_AGENT_SERVICE_STARS_MEMBERSHIP", "CAMPAIGN_OPERATION_FROM_SKU_REPORT" ] }, "operationTypeId": { "type": "integer", "format": "int32", "description": "Идентификатор типа операции." }, "operationTypeName": { "type": "string", "description": "Полное название типа операции." }, "operationTypeNameId": { "type": "integer", "format": "int32", "description": "Идентификатор типа операции." }, "transactionType": { "type": "string", "description": "Тип транзакции.", "enum": [ "ALL", "ORDERS", "RETURNS", "SERVICES", "COMPENSATION", "TRANSFER_DELIVERY", "OTHER", "DEPOSIT" ] }, "ozonCommission": { "type": "number", "format": "double", "description": "Вознаграждение ozon" }, "operationStatus": { "type": "string", "description": "Статус операции, <Продажа>, <Возврат> и т.д,", "enum": [ "DEFAULT", "SALES", "RETURNS", "PENALTIES", "LOGISTICS", "SERVICES", "COMPENSATION", "STORNO_SALES", "STORNO_RETURNS", "IS_CANCEL", "ONE_PENALTIES", "ONE_ADDITION_PAY", "ORDERS", "TRANSFER_DELIVERY", "OTHERS_AMOUNT", "ACQUIRING", "COST_STORAGE", "CAMPAIGN_OPERATION", "DEDUCTIONS", "COMPENSATION_FOR_LOST_ITEM_ON_WB", "LOGISTICS_CORRECTION", "ACCEPTANCE", "NEW_ACCEPTANCE", "OWN_DELIVERY", "MARKETPLACE_BONUS" ] }, "operationTypeTitle": { "type": "string", "description": "Название типа операции на ozon" }, "declarationNumber": { "type": "string", "description": "Номер таможенной декларации используется wildberries" }, "bonusTypeName": { "type": "string", "description": "Обоснование штрафов и доплат используется wildberries" }, "bonusTypeNameId": { "type": "integer", "format": "int32", "description": "Идентификатор обоснования штрафов и доплат используется wildberries" }, "wildberriesStickerId": { "type": "string", "description": "Идентификатор этикетки wildberries" }, "ozonBonus": { "type": "number", "format": "double", "description": "Баллы Ozon" }, "uniqueId": { "type": "string", "description": "Уникальный идентификатор" }, "sourceReport": { "type": "string", "description": "Идентификатор из какого импорта пришли данные: ORDER, SALES, PROFIT, OZON, SBER", "enum": [ "DEFAULT", "ORDER", "SALES", "PROFIT", "OZON", "YANDEX_MARKET", "WB_REALIZATION_FILE", "WB_DETAILED_REPORT_FILE", "OZON_REALIZATION_FILE", "OZON_REALIZATION_FILE_NEW", "OZON_COMPENSATIONS_FILE", "OZON_SERVICES_FILE", "OZON_CASH_FLOW_STATEMENT", "WB_CAMPAIGN", "SBER_MEGA_MARKET_FILES", "YANDEX_MARKET_FILE_DETAILS", "WB_RETURNS_REPORT", "OWN_DELIVERY", "OZON_CAMPAIGN_SKU_REPORT", "WB_PAID_STORAGE", "YANDEX_MARKET_NETTING" ] }, "penalty": { "type": "number", "format": "double", "description": "Штраф на WB" }, "additionalPayment": { "type": "number", "format": "double", "description": "Доплаты на WB" }, "sRid": { "type": "string", "description": "Уникальный идентификатор заказа" }, "siteCountry": { "type": "string", "description": "Страна назначения" }, "ozonProcessing": { "type": "number", "format": "double", "description": "OZON processing" }, "operationId": { "type": "integer", "format": "int64", "description": "Идентификатор операции" }, "yandexMarketStatusUpdateDate": { "type": "string", "format": "date-time", "description": "Дата и время, когда статус заказа на YandexMarket был изменен в последний раз. Отдает время +03:00" }, "yandexMarketPartnerOrderId": { "type": "string", "description": "Идентификатор заказа в YandexMarket, сохраняем через файл идентификатор магазина" }, "yandexMarketPaymentType": { "type": "string", "description": "Тип оплаты заказа YandexMarket" }, "sberOperationClass": { "type": "string", "description": "Тип операции сбера", "enum": [ "REWARD_INCENTIVE", "SELLER_PRODUCT", "DELIVERY_COMM", "LOGIC_COMM", "LOGIC_RETURN_COMM", "LOGIC_PROC_COMM", "SHORT_DELIVERY_COMM", "WAREHOUSE_PROC_SERVICE", "STORAGE_SERVICE", "REWARD_PL", "PRODUCT_CATEGORY_COMM", "TRANSACTION_COMM", "CANCEL_AFTER_ACCEPT", "DATE_CHANGE", "RETURN_BEFORE_ENTER_COMM", "SERVICE_ADVERTISER" ] }, "deliveryRegionId": { "type": "integer", "format": "int64", "description": "Идентификатор региона доставки." }, "deliveryRegionName": { "type": "string", "description": "Название региона доставки." }, "marketSku": { "type": "integer", "format": "int64", "description": "SKU на Маркете." }, "shopSku": { "type": "string", "description": "SHOP_SKU на Маркете." }, "purchasePrice": { "type": "number", "format": "double", "description": "Закупочная цена на момент заказа." }, "orderStatus": { "type": "string", "description": "Статус заказа.", "enum": [ "CANCELLED", "DELIVERED", "DELIVERY", "PICKUP", "PROCESSING", "UNPAID", "PENDING", "REJECTED", "CANCELLED_BEFORE_PROCESSING", "CANCELLED_IN_DELIVERY", "CANCELLED_IN_PROCESSING", "PARTIALLY_RETURNED", "PICKUP_SERVICE_RECEIVED", "RETURNED", "UNKNOWN", "PARTIALLY_DELIVERED", "RESERVED", "LOST" ] }, "wmsItemId": { "type": "integer", "format": "int64", "description": "Идентификатор информации о движение товара." }, "selfPay": { "type": "boolean", "description": "Самовыкуп" }, "otherExpenses": { "type": "number", "format": "double", "description": "Прочие расходы по товару." }, "campaignExpenses": { "type": "number", "format": "double", "description": "расходы на рекламу" }, "supRatingPrcUp": { "type": "number", "format": "double", "description": "Размер снижения кВВ из-за рейтинга, %" }, "isKgvpV2": { "type": "number", "format": "double", "description": "Размер снижения кВВ из-за акции, %" }, "rebillLogisticCost": { "type": "number", "format": "double", "description": "Возмещение издержек по перевозке.Поле будет в ответе при наличии значения" }, "rebillLogisticOrg": { "type": "string", "description": "Организатор перевозки.Поле будет в ответе при наличии значения." }, "acquiringFee": { "type": "number", "format": "double", "description": "Возмещение издержек по эквайрингу. Издержки WB за услуги эквайринга: вычитаются из вознаграждения WB и не влияют на доход продавца." }, "acquiringBank": { "type": "string", "description": "Наименование банка-эквайера" }, "kiz": { "type": "string", "description": "Код маркировки.Поле будет в ответе при наличии значения" }, "oblast": { "type": "string", "description": "Регион заказа" }, "warehouseId": { "type": "integer", "format": "int64", "description": "Идентификатор склада в селсап" }, "fileHistoryId": { "type": "integer", "format": "int64", "description": "Идентификатор ручной загрузки с файла" }, "storageFee": { "type": "number", "format": "double", "description": "Хранение" }, "deduction": { "type": "number", "format": "double", "description": "Удержание" }, "acceptance": { "type": "number", "format": "double", "description": "Платная приемка" }, "importDate": { "type": "string", "format": "date-time", "description": "Дата импорта" }, "productName": { "type": "string", "description": "Полное название продукта" }, "serviceName": { "type": "string", "description": "Название МП" }, "shortOrgName": { "type": "string", "description": "Организация" }, "article": { "type": "string", "description": "Артикул" }, "color": { "type": "string", "description": "Цвет" }, "size": { "type": "string", "description": "Размер" }, "barcodeSelsup": { "type": "string", "description": "ШК" }, "warehouseName": { "type": "string", "description": "Название склада в селсап" }, "warehouseRegion": { "type": "string", "description": "Регион склада в селсап" }, "externalOrderId": { "type": "string", "description": "Внутрений id заказа" }, "srid": { "type": "string" }, "stringNmId": { "type": "string" }, "exchangeRateDate": { "type": "string", "format": "date-time" }, "currencyOrDefault": { "type": "string" } } }, "CombinedAbcAnalysisResult": { "type": "object", "properties": { "revenueStatByGroup": { "type": "array", "items": { "$ref": "#/components/schemas/AbcStatByGroup" } }, "grossProfitStatByGroup": { "type": "array", "items": { "$ref": "#/components/schemas/AbcStatByGroup" } }, "revenueProfitPositiveSum": { "type": "number", "format": "double" }, "grossProfitProfitPositiveSum": { "type": "number", "format": "double" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/CombinedAbcReport" } }, "totalCount": { "type": "integer", "format": "int32" } } }, "CombinedAbcReport": { "type": "object", "description": "Объединённый ABC анализ по артикулу: выручка + валовая прибыль", "properties": { "id": { "type": "integer", "format": "int64" }, "article": { "type": "string" }, "orgUniqueArticle": { "type": "string" }, "color": { "type": "string" }, "modelView": { "type": "string" }, "orgUniqueModelView": { "type": "string" }, "productModelId": { "type": "integer", "format": "int64" }, "organizationName": { "type": "string" }, "organizationId": { "type": "integer", "format": "int64" }, "brandName": { "type": "string" }, "categoryName": { "type": "string" }, "categoryId": { "type": "integer", "format": "int32" }, "stocksCount": { "type": "integer", "format": "int32", "description": "Остаток FBS + FBO" }, "stocksPercent": { "type": "number", "format": "double", "description": "Доля в остатке в %" }, "product": { "$ref": "#/components/schemas/Product" }, "revenueProfit": { "type": "number", "format": "double", "description": "Выручка" }, "revenueProfitPercent": { "type": "number", "format": "double", "description": "Доля в общей выручке в %" }, "revenueCollectPercent": { "type": "number", "format": "double", "description": "Накопленная доля по выручке в %" }, "revenueGroup": { "type": "string", "description": "Группа по выручке: A, B или C", "enum": [ "A", "B", "C" ] }, "revenueGroupWeighted": { "type": "string", "description": "Группа по выручке в нормализованном виде: A, B или C", "enum": [ "A", "B", "C" ] }, "grossProfit": { "type": "number", "format": "double", "description": "Валовая прибыль" }, "grossProfitPercent": { "type": "number", "format": "double", "description": "Доля в общей валовой прибыли в %" }, "grossProfitCollectPercent": { "type": "number", "format": "double", "description": "Накопленная доля по валовой прибыли в %" }, "grossProfitGroup": { "type": "string", "description": "Группа по валовой прибыли: A, B или C", "enum": [ "A", "B", "C" ] }, "grossProfitGroupWeighted": { "type": "string", "description": "Группа по валовой прибыли в нормализованном виде: A, B или C", "enum": [ "A", "B", "C" ] }, "grossProfitHasPurchasePrice": { "type": "boolean", "description": "Есть ли у артикула закупочная цена" } } } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "name": "Authorization", "in": "header" } } } }