{"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":"http://localhost:9050/"}],"tags":[{"name":"Параметры","description":"Методы управления параметрами товаров в категориях"}],"paths":{"/api/param/":{"post":{"tags":["Параметры"],"summary":"Создание пользовательского параметра","description":"Создаёт глобальный пользовательский параметр, который привязан к клиенту. Чтобы параметр отображался в товарах, его нужно сначала привязать к категориям через linkCategoriesToParam","operationId":"postParam","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Param"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/Param"}}}}}}},"/api/param/{id}":{"get":{"tags":["Параметры"],"summary":"Получить параметр клиента","operationId":"param","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/Param"}}}}}}},"/api/param/preset/{service}/{organizationId}/{preset}":{"get":{"tags":["Параметры"],"summary":"Саджест для параметров","description":"Запрашивает данные о параметре доступном только через саджест","operationId":"getParamSuggestRequired","parameters":[{"name":"service","in":"path","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","MAKRO","YANDEX_KIT","BOB_SHOP","KASPI","DIADOC"]}},{"name":"preset","in":"path","required":true,"schema":{"type":"string","enum":["SUGGEST_REQUIRED"]}},{"name":"organizationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"attrId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"number","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/SuggestResponse"}}}}}}},"/api/param/find":{"get":{"tags":["Параметры"],"summary":"Поиск параметров","description":"Возвращает список всех заведенных параметров для категории озон, предмета Вайлдбериз или Национального каталога","operationId":"params","parameters":[{"name":"nationalCatalogId","in":"query","description":"ТНВЭД национального каталога для которого необходимо получить список значений","required":false,"schema":{"type":"integer","format":"int64","description":"ТНВЭД национального каталога для которого необходимо получить список значений"}},{"name":"wildberriesTypeId","in":"query","description":"Предмет Вайлдбериз для которой неободимо получить список значений","required":false,"schema":{"type":"integer","format":"int64","description":"Предмет Вайлдбериз для которой неободимо получить список значений"}},{"name":"wildberriesCategoryId","in":"query","description":"Категория Вайлдбериз для которой неободимо получить список значений","required":false,"schema":{"type":"integer","format":"int64","description":"Категория Вайлдбериз для которой неободимо получить список значений"}},{"name":"ozonCategoryId","in":"query","description":"Категория Озон для которой неободимо получить список значений","required":false,"schema":{"type":"integer","format":"int64","description":"Категория Озон для которой неободимо получить список значений"}},{"name":"ozonDescriptionCategoryId","in":"query","description":"Новая категория Озон для которой неободимо получить список значений","required":false,"schema":{"type":"integer","format":"int64","description":"Новая категория Озон для которой неободимо получить список значений"}},{"name":"aliexpressCategoryId","in":"query","description":"Категория Aliexpress для которой неободимо получить список значений","required":false,"schema":{"type":"integer","format":"int64","description":"Категория Aliexpress для которой неободимо получить список значений"}},{"name":"lamodaCategoryId","in":"query","description":"Категория Lamoda для которой необходимо получить список значений","required":false,"schema":{"type":"integer","format":"int64","description":"Категория Lamoda для которой необходимо получить список значений"}},{"name":"kaspiCategoryId","in":"query","description":"Код категории Kaspi для получения характеристик","required":false,"schema":{"type":"string","description":"Код категории Kaspi для получения характеристик"}},{"name":"avitoCategoryId","in":"query","description":"Категория Avito для которой неободимо получить список значений","required":false,"schema":{"type":"integer","format":"int64","description":"Категория Avito для которой неободимо получить список значений"}},{"name":"yandexMarketCategoryId","in":"query","description":"Категория Яндекс.Маркета для которой неободимо получить список значений","required":false,"schema":{"type":"integer","format":"int64","description":"Категория Яндекс.Маркета для которой неободимо получить список значений"}},{"name":"categoryId","in":"query","description":"Категория SelSup, используется только для параметров клиента вместе с clientId","required":false,"schema":{"type":"integer","format":"int32","description":"Категория SelSup, используется только для параметров клиента вместе с clientId"}},{"name":"useAllCategories","in":"query","description":"Используется только параметров клиента","required":false,"schema":{"type":"boolean","description":"Используется только параметров клиента"}},{"name":"useCategoryOption","in":"query","required":false,"schema":{"type":"boolean"}},{"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":{"type":"array","items":{"$ref":"#/components/schemas/Param"}}}}}}}},"/api/param/{paramId}":{"delete":{"tags":["Параметры"],"summary":"Удаление пользовательского параметра","description":"Удаляет глобальный пользовательский параметр клиента","operationId":"deleteParam","parameters":[{"name":"paramId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/hal+json":{"schema":{"type":"string"}}}}}}}},"components":{"schemas":{"CacheStringOption":{},"Measure":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"nationalCatalogId":{"type":"integer","format":"int64"},"wildberriesTypeId":{"type":"integer","format":"int64"},"aliexpressCategoryId":{"type":"integer","format":"int64"},"units":{"type":"array","items":{"$ref":"#/components/schemas/Unit"}},"unitsMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Unit"}},"measureId":{"type":"integer","format":"int32","writeOnly":true}}},"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}}},"Param":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"string"},"published":{"type":"boolean"},"visible":{"type":"boolean"},"serviceParam":{"type":"string","enum":["NAME","MODEL_NAME","MAIN_IMAGE_URL","TNVED","RICH_CONTENT","DESCRIPTION","TNVED_GROUP","MATERIALS","GENDER","IMAGES","BRAND","PACK_WEIGHT_GR","PACK_WEIGHT_KG","MADE_IN_COUNTRY","MARKING","WILDBERRIES_ARTICLE","WILDBERRIES_COLOR","WILDBERRIES_SIZE","REAL_SIZE","PACK_WIDTH","PACK_HEIGHT","PACK_DEPTH","PACK_LENGTH","MANUFACTURER","MEASURES","DOCUMENT_LINK","DOCUMENT_NAME","KEYWORDS","SEASON","ARTICLE","COLOR","SIZE","MATERIALS_WB","LAUNDRY"]},"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","MAKRO","YANDEX_KIT","BOB_SHOP","KASPI","DIADOC"]},"useCategoryOption":{"type":"boolean"},"valueType":{"type":"string","enum":["BOOLEAN","LONG","DOUBLE","ENUM","TEXT","DATE"]},"displayType":{"type":"string","enum":["SELECT","SUGGEST","TEXT","CHECKBOX","LONGTEXT"]},"required":{"type":"boolean","description":"Обязательность заполнения параметра"},"multiValueAllowed":{"type":"boolean","description":"Многозначный параметр - у которого может быть несколько значений"},"maxValuesCount":{"type":"integer","format":"int32","description":"Максимальное количество значений для многозначных параметров"},"useDictionary":{"type":"boolean"},"description":{"type":"string","description":"Описание параметра, как его заполнять и особенности заполнения"},"groupName":{"type":"string","description":"Название группировки параметров"},"groupId":{"type":"string","description":"Идентификатор группы параметров"},"ozonDictionaryId":{"type":"integer","format":"int64"},"dictionaryId":{"type":"integer","format":"int64"},"measureId":{"type":"integer","format":"int32"},"measure":{"$ref":"#/components/schemas/Measure","description":"Единица измерения параметра"},"defaultUnit":{"$ref":"#/components/schemas/Unit"},"ozonId":{"type":"integer","format":"int64"},"wildberriesId":{"type":"integer","format":"int64"},"ymId":{"type":"integer","format":"int64"},"lamodaId":{"type":"string"},"nationalCatalogId":{"type":"integer","format":"int64","description":"Связь с параметром национального каталога"},"categoryId":{"type":"integer","format":"int64"},"avitoIds":{"type":"array","items":{"type":"integer","format":"int64"}},"avitoOptionsXmlFileName":{"type":"string"},"clientId":{"type":"integer","format":"int64","description":"Заполняется для пользовательских параметров"},"createdDate":{"type":"string","format":"date-time"},"aliexpressId":{"type":"integer","format":"int64"},"preset":{"type":"string"},"dictionaryParamId":{"type":"integer","format":"int64"},"dictionaryKey":{"type":"string"},"level":{"type":"string","enum":["CATEGORY","MODEL","VIEW","PRODUCT"]},"gs1Class":{"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","CARPARTS","NATURAL_FUR","NICOTINDEV","GADGETS","FROZEN","FERTILIZERS","HOMEWARE","VETBIO","INDUSTRIAL","PYROTECHNICS"]},"useAllCategories":{"type":"boolean","description":"Используется для параметров клиента"},"oneCId":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/Option"}},"optionsCache":{"$ref":"#/components/schemas/CacheStringOption"},"lastRefreshOptions":{"type":"integer","format":"int64"},"optionsCount":{"type":"integer","format":"int32"},"isAnalytic":{"type":"boolean","description":"Использовать параметр в аналитических отчетах"},"analyticOrder":{"type":"integer","format":"int32","description":"Порядок отображения параметра в аналитических отчетах. NULL — параметр выводится после всех упорядоченных, в алфавитном порядке по имени"},"marketplaceService":{"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","MAKRO","YANDEX_KIT","BOB_SHOP","KASPI","DIADOC"]},"id":{"type":"integer","format":"int64"}}},"Unit":{"type":"object","description":"Единица измерения","properties":{"name":{"type":"string","description":"Название единицы измерения"},"measureId":{"type":"integer","format":"int32","description":"Мера параметра"},"id":{"type":"integer","format":"int32"}}},"SuggestParam":{"type":"object","properties":{"number":{"type":"string"}}},"SuggestResponse":{"type":"object","properties":{"apiversion":{"type":"integer","format":"int32"},"result":{"type":"array","items":{"$ref":"#/components/schemas/SuggestParam"}},"empty":{"type":"boolean"}}}},"securitySchemes":{"ApiKey":{"type":"apiKey","name":"Authorization","in":"header"}}}}