{ "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": "Методы для управления рекламой на маркетплейсах" } ], "paths": { "/api/campaign/updateStatusCampaign": { "post": { "tags": [ "Реклама" ], "summary": "Изменение статуса рекламной компании", "description": "Останавливает, запускает или ставит на паузу компанию по маркетплейсу", "operationId": "updateStatusCampaign", "parameters": [ { "name": "campaignId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DELETED", "READY", "FINISHED", "CANCELLED", "ACTIVE", "PAUSED", "UNKNOWN", "ARCHIVED" ] } }, { "name": "organizationId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/campaign/createCampaign": { "post": { "tags": [ "Реклама" ], "summary": "Создание рекламной компании", "description": "Создает новую рекламную компанию по маркетплейсу", "operationId": "createCampaign", "parameters": [ { "name": "organizationId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Campaign" } } } } } } }, "/api/campaign/updateCampaigns": { "get": { "tags": [ "Реклама" ], "summary": "Запуск задачи по обновлению/прогрузки рекламных кампаний", "description": "Возвращает задачу на старт", "operationId": "importCampaigns", "parameters": [ { "name": "organizationId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "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": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/campaign/getWildberriesSubjects": { "get": { "tags": [ "Реклама" ], "summary": "Получение информации о кампании с API маркетплейса", "description": "Возвращает кампанию по внешнему идентификатору", "operationId": "getWildberriesSubjects", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "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": { "type": "array", "items": { "$ref": "#/components/schemas/WildberriesType" } } } } } } } }, "/api/campaign/getTotalStatCampaigns": { "get": { "tags": [ "Реклама" ], "summary": "Суммарная статистику по рекламным кампаниям", "description": "Возвращает суммарную статистику по маркетплейсам", "operationId": "getTotalStatCampaigns", "parameters": [ { "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": "organizationId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "campaignStatus", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "DELETED", "READY", "FINISHED", "CANCELLED", "ACTIVE", "PAUSED", "UNKNOWN", "ARCHIVED" ] } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "dateTo", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "dateFrom", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "isStatCampaign", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "dateStart", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поисковый запрос. Может содержать external_id или часть названия медиакампании", "required": false, "schema": { "type": "string", "description": "Поисковый запрос. Может содержать external_id или часть названия медиакампании" } }, { "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": [ "EXTERNALID", "SERVICE", "CAMPAIGNNAME", "CAMPAIGNTYPE", "CATEGORYNAME", "VIEWS", "CLICKS", "RATIOCLICKSVIEWS", "AVERAGECOST", "EXPENSES", "QUANTITYADDCART", "QUANTITYORDERS", "RATIOORDERSOFVISITS", "QUANTITYPRODUCTORDERS", "ORDERSAMOUNT", "CREATEDATE", "STATUS" ] } }, { "name": "ascending", "in": "query", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка.", "required": false, "schema": { "type": "boolean", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка." } }, { "name": "topN", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/CampaignTotalStats" } } } } } } }, "/api/campaign/getStatCampaigns": { "get": { "tags": [ "Реклама" ], "summary": "Статистику по рекламным кампаниям", "description": "Возвращает статистику по маркетплейсам", "operationId": "getStatCampaigns", "parameters": [ { "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": "organizationId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "campaignStatus", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "DELETED", "READY", "FINISHED", "CANCELLED", "ACTIVE", "PAUSED", "UNKNOWN", "ARCHIVED" ] } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "dateTo", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "dateFrom", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "isStatCampaign", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "dateStart", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поисковый запрос. Может содержать external_id или часть названия медиакампании", "required": false, "schema": { "type": "string", "description": "Поисковый запрос. Может содержать external_id или часть названия медиакампании" } }, { "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": [ "EXTERNALID", "SERVICE", "CAMPAIGNNAME", "CAMPAIGNTYPE", "CATEGORYNAME", "VIEWS", "CLICKS", "RATIOCLICKSVIEWS", "AVERAGECOST", "EXPENSES", "QUANTITYADDCART", "QUANTITYORDERS", "RATIOORDERSOFVISITS", "QUANTITYPRODUCTORDERS", "ORDERSAMOUNT", "CREATEDATE", "STATUS" ] } }, { "name": "ascending", "in": "query", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка.", "required": false, "schema": { "type": "boolean", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка." } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/FindResponseStatCampaign" } } } } } } }, "/api/campaign/getCampaigns": { "get": { "tags": [ "Реклама" ], "summary": "Получение информации о заказе", "description": "Возвращает заказ по идентификатору", "operationId": "getCampaigns", "parameters": [ { "name": "organizationId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "campaignStatus", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "DELETED", "READY", "FINISHED", "CANCELLED", "ACTIVE", "PAUSED", "UNKNOWN", "ARCHIVED" ] } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "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": "dateTo", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "dateFrom", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "isStatCampaign", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "dateStart", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поисковый запрос. Может содержать external_id или часть названия медиакампании", "required": false, "schema": { "type": "string", "description": "Поисковый запрос. Может содержать external_id или часть названия медиакампании" } }, { "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": [ "EXTERNALID", "SERVICE", "CAMPAIGNNAME", "CAMPAIGNTYPE", "CATEGORYNAME", "VIEWS", "CLICKS", "RATIOCLICKSVIEWS", "AVERAGECOST", "EXPENSES", "QUANTITYADDCART", "QUANTITYORDERS", "RATIOORDERSOFVISITS", "QUANTITYPRODUCTORDERS", "ORDERSAMOUNT", "CREATEDATE", "STATUS" ] } }, { "name": "ascending", "in": "query", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка.", "required": false, "schema": { "type": "boolean", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка." } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/FindResponseCampaign" } } } } } } }, "/api/campaign/getCampaignBalance": { "get": { "tags": [ "Реклама" ], "summary": "Получение баланса по маркетплейсу", "description": "Отдает баланс на аккаунте для рекламных кампаний", "operationId": "getCampaignBalance", "parameters": [ { "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": "organizationId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/WbBalance" } } } } } } } }, "components": { "schemas": { "Campaign": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "externalId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "campaignName": { "type": "string" }, "type": { "type": "string", "enum": [ "IN_CATALOG", "IN_CARD", "IN_SEARCH", "IN_MAIN", "AUTO", "IN_SEARCH_AND_CATALOG", "BRAND_SHELF", "UNKNOWN" ] }, "statusType": { "type": "string", "enum": [ "DELETED", "READY", "FINISHED", "CANCELLED", "ACTIVE", "PAUSED", "UNKNOWN", "ARCHIVED" ] }, "productId": { "type": "integer", "format": "int64" }, "externalProductId": { "type": "integer", "format": "int64" }, "createDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" }, "sum": { "type": "integer", "format": "int64" }, "writeOffType": { "type": "string", "enum": [ "BALANCE", "NET", "BONUS" ] }, "onPause": { "type": "boolean" }, "clientId": { "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" ] }, "categoryId": { "type": "integer", "format": "int64" }, "categoryName": { "type": "string" }, "campaignType": { "type": "string" }, "dateStatImport": { "type": "string", "format": "date-time" }, "nms": { "type": "string" }, "paymentType": { "type": "string" } } }, "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": "Язык на котором сейчас запущена таска" } } }, "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" } } }, "CampaignStat": { "type": "object", "properties": { "campaign": { "type": "string" }, "value": { "type": "number", "format": "double" } } }, "CampaignTotalStats": { "type": "object", "properties": { "clicks": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignStat" } }, "views": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignStat" } }, "expenses": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignStat" } }, "averageCost": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignStat" } } } }, "FindResponseStatCampaign": { "type": "object", "properties": { "rows": { "type": "array", "description": "Строки с результатом поиска", "items": { "$ref": "#/components/schemas/StatCampaign" } }, "total": { "type": "integer", "format": "int32", "description": "Общее количество найденных записей. Возвращается только, когда count = true" }, "page": { "type": "integer", "format": "int32", "description": "Номер запрошенной страницы" }, "hasNextPage": { "type": "boolean", "description": "Есть ли следующая страница" }, "emptyPurchase": { "type": "integer", "format": "int64", "description": "Показатель пустой закупочной цены" } } }, "StatCampaign": { "type": "object", "properties": { "limit": { "type": "integer", "format": "int32", "description": "Ограничение на количество записей. Максимальное значение - 500" }, "page": { "type": "integer", "format": "int32", "description": "Номер страницы начиная с 1" }, "count": { "type": "boolean", "description": "Возвратить в ответе общее количество записей" }, "sortBy": { "type": "string", "description": "Поле сортировки записей. Работает только при получении списка." }, "ascending": { "type": "boolean", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка." }, "statCampaignId": { "type": "integer", "format": "int64", "description": "ID в базе" }, "views": { "type": "integer", "format": "int32", "description": "Количество просмотров." }, "clicks": { "type": "integer", "format": "int32", "description": "Количество кликов" }, "ratioClicksViews": { "type": "number", "format": "double", "description": "Отношение числа кликов к количеству показов. Выражается в процентах" }, "averageCost": { "type": "number", "format": "double", "description": "Средняя стоимость клика, ₽" }, "expenses": { "type": "number", "format": "double", "description": "Затраты, ₽" }, "quantityAddCart": { "type": "integer", "format": "int32", "description": "Количество добавлений товаров в корзину" }, "quantityOrders": { "type": "integer", "format": "int32", "description": "Количество заказов" }, "ratioOrdersOfVisits": { "type": "number", "format": "double", "description": "Отношение количества заказов к общему количеству посещений кампании" }, "quantityProductOrders": { "type": "integer", "format": "int32", "description": "Количество заказанных товаров, шт." }, "campaignId": { "type": "integer", "format": "int64", "description": "ID кампании" }, "campaignName": { "type": "string", "description": "Название кампании к которой относится статистика" }, "createDate": { "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" ] }, "campaignType": { "type": "string", "enum": [ "IN_CATALOG", "IN_CARD", "IN_SEARCH", "IN_MAIN", "AUTO", "IN_SEARCH_AND_CATALOG", "BRAND_SHELF", "UNKNOWN" ] }, "categoryName": { "type": "string" }, "externalId": { "type": "integer", "format": "int64" }, "productId": { "type": "integer", "format": "int64", "description": "Идентификатор размера" }, "productViewId": { "type": "integer", "format": "int64", "description": "Идентификатор цвета" }, "date": { "type": "string", "format": "date-time", "description": "Дата к которой относится статистика" }, "startDate": { "type": "string", "format": "date-time", "description": "Начало интервала к которому относится статистика Проставляется при импорте если статистика по дням недоступна" }, "endDate": { "type": "string", "format": "date-time", "description": "Конец интервала к которому относится статистика. Проставляется при импорте если статистика по дням недоступна" }, "importDate": { "type": "string", "format": "date-time", "description": "Дата импорта" }, "uniqueId": { "type": "string" }, "clientId": { "type": "integer", "format": "int64" }, "sum_price": { "type": "number", "format": "double", "description": "Заказов на сумму, ₽" } } }, "FindResponseCampaign": { "type": "object", "properties": { "rows": { "type": "array", "description": "Строки с результатом поиска", "items": { "$ref": "#/components/schemas/Campaign" } }, "total": { "type": "integer", "format": "int32", "description": "Общее количество найденных записей. Возвращается только, когда count = true" }, "page": { "type": "integer", "format": "int32", "description": "Номер запрошенной страницы" }, "hasNextPage": { "type": "boolean", "description": "Есть ли следующая страница" }, "emptyPurchase": { "type": "integer", "format": "int64", "description": "Показатель пустой закупочной цены" } } }, "WbBalance": { "type": "object", "properties": { "balance": { "type": "integer", "format": "int32" }, "net": { "type": "integer", "format": "int32" }, "bonus": { "type": "integer", "format": "int32" } } } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "name": "Authorization", "in": "header" } } } }