{
  "openapi": "3.0.1",
  "info": {
    "title": "Параметры: API",
    "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/param/": {
      "post": {
        "tags": [
          "Параметры"
        ],
        "summary": "Создание пользовательского параметра",
        "description": "Создаёт глобальный пользовательский параметр, который привязан к клиенту. Чтобы параметр отображался в товарах, его нужно сначала привязать к категориям через linkCategoriesToParam",
        "operationId": "postParam",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Param"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/Param"
                }
              }
            }
          }
        }
      }
    },
    "/api/param/{id}": {
      "get": {
        "tags": [
          "Параметры"
        ],
        "summary": "Получить параметр клиента по id",
        "operationId": "param",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/Param"
                }
              }
            }
          }
        }
      }
    },
    "/api/param/find": {
      "get": {
        "tags": [
          "Параметры"
        ],
        "summary": "Получение параметров",
        "description": "Возвращает список всех заведенных параметров для категории озон, предмета Вайлдбериз или Национального каталога",
        "operationId": "params",
        "parameters": [
          {
            "name": "nationalCatalogId",
            "in": "query",
            "description": "ТНВЭД национального каталога для которого необходимо получить список значений",
            "required": false,
            "schema": {
              "type": "string",
              "description": "ТНВЭД национального каталога для которого необходимо получить список значений"
            }
          },
          {
            "name": "wildberriesTypeId",
            "in": "query",
            "description": "Предмет Вайлдбериз для которой неободимо получить список значений",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Предмет Вайлдбериз для которой неободимо получить список значений"
            }
          },
          {
            "name": "wildberriesCategoryId",
            "in": "query",
            "description": "Категория Вайлдбериз для которой неободимо получить список значений",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Категория Вайлдбериз для которой неободимо получить список значений"
            }
          },
          {
            "name": "ozonCategoryId",
            "in": "query",
            "description": "Категория Озон для которой неободимо получить список значений",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Категория Озон для которой неободимо получить список значений"
            }
          },
          {
            "name": "ozonDescriptionCategoryId",
            "in": "query",
            "description": "Новая категория Озон для которой неободимо получить список значений",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Новая категория Озон для которой неободимо получить список значений"
            }
          },
          {
            "name": "aliexpressCategoryId",
            "in": "query",
            "description": "Категория Aliexpress для которой неободимо получить список значений",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Категория Aliexpress для которой неободимо получить список значений"
            }
          },
          {
            "name": "avitoCategoryId",
            "in": "query",
            "description": "Категория Avito для которой неободимо получить список значений",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Категория Avito для которой неободимо получить список значений"
            }
          },
          {
            "name": "yandexMarketCategoryId",
            "in": "query",
            "description": "Категория Яндекс.Маркета для которой неободимо получить список значений",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Категория Яндекс.Маркета для которой неободимо получить список значений"
            }
          },
          {
            "name": "categoryId",
            "in": "query",
            "description": "Категория SelSup, используется только для параметров клиента вместе с clientId",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Категория SelSup, используется только для параметров клиента вместе с clientId"
            }
          },
          {
            "name": "useAllCategories",
            "in": "query",
            "description": "Используется только параметров клиента",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Используется только параметров клиента"
            }
          },
          {
            "name": "useCategoryOption",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Ограничение на количество записей. Максимальное значение - 500",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Ограничение на количество записей. Максимальное значение - 500"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Номер страницы начиная с 1",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Номер страницы начиная с 1"
            }
          },
          {
            "name": "count",
            "in": "query",
            "description": "Возвратить в ответе общее количество записей",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Возвратить в ответе общее количество записей"
            }
          },
          {
            "name": "sortBy",
            "in": "query",
            "description": "Поле сортировки записей. Работает только при получении списка.",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Поле сортировки записей. Работает только при получении списка."
            }
          },
          {
            "name": "ascending",
            "in": "query",
            "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка.",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка."
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "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": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "CacheStringOption": {
        "type": "object"
      },
      "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
          }
        },
        "description": "Единица измерения параметра"
      },
      "Option": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Идентификатор значения, может отсутствовать",
            "format": "int64"
          },
          "name": {
            "type": "string",
            "description": "Название значения, лучше всегда передавать"
          },
          "paramId": {
            "type": "integer",
            "description": "Идентификатор значения параметра Param.id",
            "format": "int64"
          },
          "ozonId": {
            "type": "integer",
            "description": "Идентификатор значения параметра на Ozon",
            "format": "int64"
          },
          "wildberriesId": {
            "type": "integer",
            "description": "Признак того, что значение параметра WB",
            "format": "int64"
          },
          "ymId": {
            "type": "integer",
            "description": "Признак того, что значение параметра YM",
            "format": "int64"
          },
          "aliexpressId": {
            "type": "integer",
            "description": "Идентификатор значения параметра на Aliexpress",
            "format": "int64"
          },
          "clientId": {
            "type": "integer",
            "format": "int64"
          },
          "deleted": {
            "type": "boolean"
          },
          "oneCId": {
            "type": "string",
            "description": "Идентификатор значения параметра в 1С"
          },
          "dictionary": {
            "type": "boolean"
          },
          "optionId": {
            "$ref": "#/components/schemas/Option"
          }
        }
      },
      "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"
            ]
          },
          "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",
            "description": "Максимальное количество значений для многозначных параметров",
            "format": "int32"
          },
          "useDictionary": {
            "type": "boolean"
          },
          "description": {
            "type": "string",
            "description": "Описание параметра, как его заполнять и особенности заполнения"
          },
          "groupName": {
            "type": "string",
            "description": "Название группировки параметров"
          },
          "ozonDictionaryId": {
            "type": "integer",
            "format": "int64"
          },
          "dictionaryId": {
            "type": "integer",
            "format": "int64"
          },
          "measureId": {
            "type": "integer",
            "format": "int32"
          },
          "measure": {
            "$ref": "#/components/schemas/Measure"
          },
          "defaultUnit": {
            "$ref": "#/components/schemas/Unit"
          },
          "ozonId": {
            "type": "integer",
            "format": "int64"
          },
          "wildberriesId": {
            "type": "integer",
            "format": "int64"
          },
          "ymId": {
            "type": "integer",
            "format": "int64"
          },
          "nationalCatalogId": {
            "type": "integer",
            "description": "Связь с параметром национального каталога",
            "format": "int64"
          },
          "categoryId": {
            "type": "integer",
            "format": "int64"
          },
          "avitoIds": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int64"
            }
          },
          "avitoOptionsXmlFileName": {
            "type": "string"
          },
          "clientId": {
            "type": "integer",
            "description": "Заполняется для пользовательских параметров",
            "format": "int64"
          },
          "createdDate": {
            "type": "string",
            "format": "date-time"
          },
          "aliexpressId": {
            "type": "integer",
            "format": "int64"
          },
          "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"
            ]
          },
          "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"
          },
          "id": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "Unit": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Название единицы измерения"
          },
          "measureId": {
            "type": "integer",
            "description": "Мера параметра",
            "format": "int32"
          },
          "id": {
            "type": "integer",
            "format": "int32"
          }
        },
        "description": "Единица измерения"
      }
    },
    "securitySchemes": {
      "ApiKey": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    }
  }
}