SelSup Developers

Публичный API · API Reference

Параметры

Методы раздела «Параметры»: точные маршруты, параметры, тела запросов и раскрываемые структуры ответов.

5 методов/api/paramСтабильныйМашинное описание ↗
{ }

Страница собрана в отдельный редактируемый контракт. Перед операциями записи проверяйте примеры на тестовых данных.

/api/param

Готовые сценарии

Готовые сценарии

01

Начать работу с разделом «Параметры»

Используйте отдельный API-токен и сначала проверяйте операции чтения на тестовых данных.

  1. Сохраните токен на серверной стороне и передавайте его в заголовке Authorization.
  2. Проверьте обязательные параметры и раскройте структуру запроса или ответа.
  3. Обрабатывайте HTTP-статус и стабильное поле error в прикладных ошибках.

Модель данных

Структуры данных раздела

Модели перечислены отдельно и раскрываются также непосредственно у методов, где они используются.

CacheStringOption0 полей
Measure8 полей
idinteger · int32

Поле id.

namestring

Поле name.

nationalCatalogIdinteger · int64

Поле nationalCatalogId.

wildberriesTypeIdinteger · int64

Поле wildberriesTypeId.

aliexpressCategoryIdinteger · int64

Поле aliexpressCategoryId.

unitsUnit[]

Поле units.

unitsMapobject

Поле unitsMap.

measureIdinteger · int32

Поле measureId.

Option12 полей
idinteger · int64

Идентификатор значения, может отсутствовать

namestring

Название значения, лучше всегда передавать

paramIdinteger · int64

Идентификатор значения параметра Param.id

ozonIdinteger · int64

Идентификатор значения параметра на Ozon

wildberriesIdinteger · int64

Признак того, что значение параметра WB

ymIdinteger · int64

Признак того, что значение параметра YM

aliexpressIdinteger · int64

Идентификатор значения параметра на Aliexpress

clientIdinteger · int64

Поле clientId.

deletedboolean

Поле deleted.

oneCIdstring

Идентификатор значения параметра в 1С

dictionaryboolean

Поле dictionary.

optionIdOption

Поле optionId.

Param47 полей
namestring

Поле name.

titlestring

Поле title.

publishedboolean

Поле published.

visibleboolean

Поле visible.

serviceParamstring

Поле serviceParam.

servicestring

Маркетплейс, к которому относится этот параметр

useCategoryOptionboolean

Поле useCategoryOption.

valueTypestring

Поле valueType.

displayTypestring

Поле displayType.

requiredboolean

Обязательность заполнения параметра

multiValueAllowedboolean

Многозначный параметр - у которого может быть несколько значений

maxValuesCountinteger · int32

Максимальное количество значений для многозначных параметров

useDictionaryboolean

Поле useDictionary.

descriptionstring

Описание параметра, как его заполнять и особенности заполнения

groupNamestring

Название группировки параметров

groupIdstring

Идентификатор группы параметров

ozonDictionaryIdinteger · int64

Поле ozonDictionaryId.

dictionaryIdinteger · int64

Поле dictionaryId.

measureIdinteger · int32

Поле measureId.

measureMeasure

Единица измерения параметра

defaultUnitUnit

Поле defaultUnit.

ozonIdinteger · int64

Поле ozonId.

wildberriesIdinteger · int64

Поле wildberriesId.

ymIdinteger · int64

Поле ymId.

lamodaIdstring

Поле lamodaId.

nationalCatalogIdinteger · int64

Связь с параметром национального каталога

categoryIdinteger · int64

Поле categoryId.

avitoIdsinteger[]

Поле avitoIds.

avitoOptionsXmlFileNamestring

Поле avitoOptionsXmlFileName.

clientIdinteger · int64

Заполняется для пользовательских параметров

createdDatestring · date-time

Поле createdDate.

aliexpressIdinteger · int64

Поле aliexpressId.

presetstring

Поле preset.

dictionaryParamIdinteger · int64

Поле dictionaryParamId.

dictionaryKeystring

Поле dictionaryKey.

levelstring

Поле level.

gs1Classstring

Группы категорий Честного знака

useAllCategoriesboolean

Используется для параметров клиента

oneCIdstring

Поле oneCId.

optionsOption[]

Поле options.

optionsCacheCacheStringOption

Поле optionsCache.

lastRefreshOptionsinteger · int64

Поле lastRefreshOptions.

optionsCountinteger · int32

Поле optionsCount.

isAnalyticboolean

Использовать параметр в аналитических отчетах

analyticOrderinteger · int32

Порядок отображения параметра в аналитических отчетах. NULL — параметр выводится после всех упорядоченных, в алфавитном порядке по имени

marketplaceServicestring

Сервис

idinteger · int64

Поле id.

Unit3 полей
namestring

Название единицы измерения

measureIdinteger · int32

Мера параметра

idinteger · int32

Поле id.

SuggestParam1 полей
numberstring

Поле number.

SuggestResponse3 полей
apiversioninteger · int32

Поле apiversion.

resultSuggestParam[]

Поле result.

emptyboolean

Поле empty.

Контракт ошибок

Как API возвращает прикладные ошибки

Код ошибки одинаков для всех локалей, а текст для пользователя переводится сервером. Поэтому бизнес-логику стройте по error, а localMessage используйте только для отображения.

error

Стабильный машинный код ошибки для логики интеграции.

localMessage

Готовое сообщение на языке пользователя API-токена.

params

Значения

Язык localMessage определяется полем lang пользователя, которому принадлежит API-токен. Язык страницы документации и заголовок Accept-Language его не переключают; если язык пользователя не указан, используется русский.

RUПользователь с локалью ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
ENПользователь с локалью en
{
  "error": "error_brand_already_exists",
  "localMessage": "Brand Base already exists",
  "params": {
    "name": "Base"
  }
}

Методы

Методы

POST

Создание пользовательского параметра

/api/param/
Токен с правами записи

Создаёт глобальный пользовательский параметр, который привязан к клиенту. Чтобы параметр отображался в товарах, его нужно сначала привязать к категориям через linkCategoriesToParam

Тело запроса

application/json
Поля объектаParam
ПолеТипОбязательноОписание
name string Нет Поле name.
title string Нет Поле title.
published boolean Нет Поле published.
visible boolean Нет Поле visible.
serviceParam stringNAME, 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 Нет Поле serviceParam.
service stringNONE, 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 boolean Нет Поле useCategoryOption.
valueType stringBOOLEAN, LONG, DOUBLE, ENUM, TEXT, DATE Нет Поле valueType.
displayType stringSELECT, SUGGEST, TEXT, CHECKBOX, LONGTEXT Нет Поле displayType.
required boolean Нет Обязательность заполнения параметра
multiValueAllowed boolean Нет Многозначный параметр - у которого может быть несколько значений
maxValuesCount integer · int32 Нет Максимальное количество значений для многозначных параметров
useDictionary boolean Нет Поле useDictionary.
description string Нет Описание параметра, как его заполнять и особенности заполнения
groupName string Нет Название группировки параметров
groupId string Нет Идентификатор группы параметров
ozonDictionaryId integer · int64 Нет Поле ozonDictionaryId.
dictionaryId integer · int64 Нет Поле dictionaryId.
measureId integer · int32 Нет Поле measureId.
measure Measure Нет Единица измерения параметра
Поля объекта Measure
ПолеТипОбязательноОписание
id integer · int32 Нет Поле id.
name string Нет Поле name.
nationalCatalogId integer · int64 Нет Поле nationalCatalogId.
wildberriesTypeId integer · int64 Нет Поле wildberriesTypeId.
aliexpressCategoryId integer · int64 Нет Поле aliexpressCategoryId.
units Unit[] Нет Поле units.
Структура элемента массива Unit
ПолеТипОбязательноОписание
name string Нет Название единицы измерения
measureId integer · int32 Нет Мера параметра
id integer · int32 Нет Поле id.
unitsMap object Нет Поле unitsMap.
measureId integer · int32 Нет Поле measureId.
defaultUnit Unit Нет Поле defaultUnit.
Поля объекта Unit
ПолеТипОбязательноОписание
name string Нет Название единицы измерения
measureId integer · int32 Нет Мера параметра
id integer · int32 Нет Поле id.
ozonId integer · int64 Нет Поле ozonId.
wildberriesId integer · int64 Нет Поле wildberriesId.
ymId integer · int64 Нет Поле ymId.
lamodaId string Нет Поле lamodaId.
nationalCatalogId integer · int64 Нет Связь с параметром национального каталога
categoryId integer · int64 Нет Поле categoryId.
avitoIds integer[] Нет Поле avitoIds.
avitoOptionsXmlFileName string Нет Поле avitoOptionsXmlFileName.
clientId integer · int64 Нет Заполняется для пользовательских параметров
createdDate string · date-time Нет Поле createdDate.
aliexpressId integer · int64 Нет Поле aliexpressId.
preset string Нет Поле preset.
dictionaryParamId integer · int64 Нет Поле dictionaryParamId.
dictionaryKey string Нет Поле dictionaryKey.
level stringCATEGORY, MODEL, VIEW, PRODUCT Нет Поле level.
gs1Class stringSHOES, 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 boolean Нет Используется для параметров клиента
oneCId string Нет Поле oneCId.
options Option[] Нет Поле options.
Структура элемента массива Option
ПолеТипОбязательноОписание
id integer · int64 Нет Идентификатор значения, может отсутствовать
name string Нет Название значения, лучше всегда передавать
paramId integer · int64 Нет Идентификатор значения параметра Param.id
ozonId integer · int64 Нет Идентификатор значения параметра на Ozon
wildberriesId integer · int64 Нет Признак того, что значение параметра WB
ymId integer · int64 Нет Признак того, что значение параметра YM
aliexpressId integer · int64 Нет Идентификатор значения параметра на Aliexpress
clientId integer · int64 Нет Поле clientId.
deleted boolean Нет Поле deleted.
oneCId string Нет Идентификатор значения параметра в 1С
dictionary boolean Нет Поле dictionary.
optionId Option Нет Поле optionId.
optionsCache CacheStringOption Нет Поле optionsCache.
lastRefreshOptions integer · int64 Нет Поле lastRefreshOptions.
optionsCount integer · int32 Нет Поле optionsCount.
isAnalytic boolean Нет Использовать параметр в аналитических отчетах
analyticOrder integer · int32 Нет Порядок отображения параметра в аналитических отчетах. NULL — параметр выводится после всех упорядоченных, в алфавитном порядке по имени
marketplaceService stringNONE, 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 integer · int64 Нет Поле id.
curl --request POST 'https://api.selsup.ru/api/param/' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "title": "Example",
  "published": false,
  "visible": false,
  "serviceParam": "NAME",
  "service": "NONE"
}'

Успешный ответ

200
Поля объекта Param
ПолеТипОбязательноОписание
name string Нет Поле name.
title string Нет Поле title.
published boolean Нет Поле published.
visible boolean Нет Поле visible.
serviceParam stringNAME, 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 Нет Поле serviceParam.
service stringNONE, 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 boolean Нет Поле useCategoryOption.
valueType stringBOOLEAN, LONG, DOUBLE, ENUM, TEXT, DATE Нет Поле valueType.
displayType stringSELECT, SUGGEST, TEXT, CHECKBOX, LONGTEXT Нет Поле displayType.
required boolean Нет Обязательность заполнения параметра
multiValueAllowed boolean Нет Многозначный параметр - у которого может быть несколько значений
maxValuesCount integer · int32 Нет Максимальное количество значений для многозначных параметров
useDictionary boolean Нет Поле useDictionary.
description string Нет Описание параметра, как его заполнять и особенности заполнения
groupName string Нет Название группировки параметров
groupId string Нет Идентификатор группы параметров
ozonDictionaryId integer · int64 Нет Поле ozonDictionaryId.
dictionaryId integer · int64 Нет Поле dictionaryId.
measureId integer · int32 Нет Поле measureId.
measure Measure Нет Единица измерения параметра
Поля объекта Measure
ПолеТипОбязательноОписание
id integer · int32 Нет Поле id.
name string Нет Поле name.
nationalCatalogId integer · int64 Нет Поле nationalCatalogId.
wildberriesTypeId integer · int64 Нет Поле wildberriesTypeId.
aliexpressCategoryId integer · int64 Нет Поле aliexpressCategoryId.
units Unit[] Нет Поле units.
Структура элемента массива Unit
ПолеТипОбязательноОписание
name string Нет Название единицы измерения
measureId integer · int32 Нет Мера параметра
id integer · int32 Нет Поле id.
unitsMap object Нет Поле unitsMap.
measureId integer · int32 Нет Поле measureId.
defaultUnit Unit Нет Поле defaultUnit.
Поля объекта Unit
ПолеТипОбязательноОписание
name string Нет Название единицы измерения
measureId integer · int32 Нет Мера параметра
id integer · int32 Нет Поле id.
ozonId integer · int64 Нет Поле ozonId.
wildberriesId integer · int64 Нет Поле wildberriesId.
ymId integer · int64 Нет Поле ymId.
lamodaId string Нет Поле lamodaId.
nationalCatalogId integer · int64 Нет Связь с параметром национального каталога
categoryId integer · int64 Нет Поле categoryId.
avitoIds integer[] Нет Поле avitoIds.
avitoOptionsXmlFileName string Нет Поле avitoOptionsXmlFileName.
clientId integer · int64 Нет Заполняется для пользовательских параметров
createdDate string · date-time Нет Поле createdDate.
aliexpressId integer · int64 Нет Поле aliexpressId.
preset string Нет Поле preset.
dictionaryParamId integer · int64 Нет Поле dictionaryParamId.
dictionaryKey string Нет Поле dictionaryKey.
level stringCATEGORY, MODEL, VIEW, PRODUCT Нет Поле level.
gs1Class stringSHOES, 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 boolean Нет Используется для параметров клиента
oneCId string Нет Поле oneCId.
options Option[] Нет Поле options.
Структура элемента массива Option
ПолеТипОбязательноОписание
id integer · int64 Нет Идентификатор значения, может отсутствовать
name string Нет Название значения, лучше всегда передавать
paramId integer · int64 Нет Идентификатор значения параметра Param.id
ozonId integer · int64 Нет Идентификатор значения параметра на Ozon
wildberriesId integer · int64 Нет Признак того, что значение параметра WB
ymId integer · int64 Нет Признак того, что значение параметра YM
aliexpressId integer · int64 Нет Идентификатор значения параметра на Aliexpress
clientId integer · int64 Нет Поле clientId.
deleted boolean Нет Поле deleted.
oneCId string Нет Идентификатор значения параметра в 1С
dictionary boolean Нет Поле dictionary.
optionId Option Нет Поле optionId.
optionsCache CacheStringOption Нет Поле optionsCache.
lastRefreshOptions integer · int64 Нет Поле lastRefreshOptions.
optionsCount integer · int32 Нет Поле optionsCount.
isAnalytic boolean Нет Использовать параметр в аналитических отчетах
analyticOrder integer · int32 Нет Порядок отображения параметра в аналитических отчетах. NULL — параметр выводится после всех упорядоченных, в алфавитном порядке по имени
marketplaceService stringNONE, 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 integer · int64 Нет Поле id.
{
  "name": "Example",
  "title": "Example",
  "published": false,
  "visible": false,
  "serviceParam": "NAME",
  "service": "NONE"
}
Ошибки8

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

400error_param_empty_display_type
Не указан тип

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_param_empty_display_type; localMessage содержит приведённый выше перевод.

400error_param_empty_level
уровень параметра пустой

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_param_empty_level; localMessage содержит приведённый выше перевод.

400error_param_empty_name
Не указано название параметра

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_param_empty_name; localMessage содержит приведённый выше перевод.

400error_param_empty_value_type
Не указан тип значения параметра

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_param_empty_value_type; localMessage содержит приведённый выше перевод.

400error_subscription_expired
У вас закончился срок действия тарифа. Оплатите тариф для продолжения использования сервиса.

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_subscription_expired; localMessage содержит приведённый выше перевод.

GET

Получить параметр клиента

/api/param/{id}
Токен с правами чтения

Получить параметр клиента.

Параметры пути

ПолеТипОбязательноОписание
id integer · int64 Да Поле id.
curl --request GET 'https://api.selsup.ru/api/param/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Успешный ответ

200
Поля объекта Param
ПолеТипОбязательноОписание
name string Нет Поле name.
title string Нет Поле title.
published boolean Нет Поле published.
visible boolean Нет Поле visible.
serviceParam stringNAME, 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 Нет Поле serviceParam.
service stringNONE, 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 boolean Нет Поле useCategoryOption.
valueType stringBOOLEAN, LONG, DOUBLE, ENUM, TEXT, DATE Нет Поле valueType.
displayType stringSELECT, SUGGEST, TEXT, CHECKBOX, LONGTEXT Нет Поле displayType.
required boolean Нет Обязательность заполнения параметра
multiValueAllowed boolean Нет Многозначный параметр - у которого может быть несколько значений
maxValuesCount integer · int32 Нет Максимальное количество значений для многозначных параметров
useDictionary boolean Нет Поле useDictionary.
description string Нет Описание параметра, как его заполнять и особенности заполнения
groupName string Нет Название группировки параметров
groupId string Нет Идентификатор группы параметров
ozonDictionaryId integer · int64 Нет Поле ozonDictionaryId.
dictionaryId integer · int64 Нет Поле dictionaryId.
measureId integer · int32 Нет Поле measureId.
measure Measure Нет Единица измерения параметра
Поля объекта Measure
ПолеТипОбязательноОписание
id integer · int32 Нет Поле id.
name string Нет Поле name.
nationalCatalogId integer · int64 Нет Поле nationalCatalogId.
wildberriesTypeId integer · int64 Нет Поле wildberriesTypeId.
aliexpressCategoryId integer · int64 Нет Поле aliexpressCategoryId.
units Unit[] Нет Поле units.
Структура элемента массива Unit
ПолеТипОбязательноОписание
name string Нет Название единицы измерения
measureId integer · int32 Нет Мера параметра
id integer · int32 Нет Поле id.
unitsMap object Нет Поле unitsMap.
measureId integer · int32 Нет Поле measureId.
defaultUnit Unit Нет Поле defaultUnit.
Поля объекта Unit
ПолеТипОбязательноОписание
name string Нет Название единицы измерения
measureId integer · int32 Нет Мера параметра
id integer · int32 Нет Поле id.
ozonId integer · int64 Нет Поле ozonId.
wildberriesId integer · int64 Нет Поле wildberriesId.
ymId integer · int64 Нет Поле ymId.
lamodaId string Нет Поле lamodaId.
nationalCatalogId integer · int64 Нет Связь с параметром национального каталога
categoryId integer · int64 Нет Поле categoryId.
avitoIds integer[] Нет Поле avitoIds.
avitoOptionsXmlFileName string Нет Поле avitoOptionsXmlFileName.
clientId integer · int64 Нет Заполняется для пользовательских параметров
createdDate string · date-time Нет Поле createdDate.
aliexpressId integer · int64 Нет Поле aliexpressId.
preset string Нет Поле preset.
dictionaryParamId integer · int64 Нет Поле dictionaryParamId.
dictionaryKey string Нет Поле dictionaryKey.
level stringCATEGORY, MODEL, VIEW, PRODUCT Нет Поле level.
gs1Class stringSHOES, 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 boolean Нет Используется для параметров клиента
oneCId string Нет Поле oneCId.
options Option[] Нет Поле options.
Структура элемента массива Option
ПолеТипОбязательноОписание
id integer · int64 Нет Идентификатор значения, может отсутствовать
name string Нет Название значения, лучше всегда передавать
paramId integer · int64 Нет Идентификатор значения параметра Param.id
ozonId integer · int64 Нет Идентификатор значения параметра на Ozon
wildberriesId integer · int64 Нет Признак того, что значение параметра WB
ymId integer · int64 Нет Признак того, что значение параметра YM
aliexpressId integer · int64 Нет Идентификатор значения параметра на Aliexpress
clientId integer · int64 Нет Поле clientId.
deleted boolean Нет Поле deleted.
oneCId string Нет Идентификатор значения параметра в 1С
dictionary boolean Нет Поле dictionary.
optionId Option Нет Поле optionId.
optionsCache CacheStringOption Нет Поле optionsCache.
lastRefreshOptions integer · int64 Нет Поле lastRefreshOptions.
optionsCount integer · int32 Нет Поле optionsCount.
isAnalytic boolean Нет Использовать параметр в аналитических отчетах
analyticOrder integer · int32 Нет Порядок отображения параметра в аналитических отчетах. NULL — параметр выводится после всех упорядоченных, в алфавитном порядке по имени
marketplaceService stringNONE, 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 integer · int64 Нет Поле id.
{
  "name": "Example",
  "title": "Example",
  "published": false,
  "visible": false,
  "serviceParam": "NAME",
  "service": "NONE"
}
Ошибки5

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

400error_no_client
Клиент не найден или был удален. Напишите в поддержку

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.

400error_not_found_param_by_id
Параметр по ID не найден

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_not_found_param_by_id; localMessage содержит приведённый выше перевод.

GET

Саджест для параметров

/api/param/preset/{service}/{organizationId}/{preset}
Токен с правами чтения

Запрашивает данные о параметре доступном только через саджест

Параметры пути

ПолеТипОбязательноОписание
service stringNONE, 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 Да Сервис
preset stringSUGGEST_REQUIRED Да Поле preset.
organizationId integer · int64 Да Поле organizationId.

Параметры запроса

ПолеТипОбязательноОписание
attrId integer · int64 Да Поле attrId.
number string Да Поле number.
curl --request GET 'https://api.selsup.ru/api/param/preset/NONE/1001/SUGGEST_REQUIRED?attrId=1001&number=string' \
  --header 'Authorization: YOUR_API_TOKEN'

Успешный ответ

200
Поля объекта SuggestResponse
ПолеТипОбязательноОписание
apiversion integer · int32 Нет Поле apiversion.
result SuggestParam[] Нет Поле result.
Структура элемента массива SuggestParam
ПолеТипОбязательноОписание
number string Нет Поле number.
empty boolean Нет Поле empty.
{
  "apiversion": 1,
  "result": "string",
  "empty": false
}
Ошибки8

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

400error_no_integration_with_nc
Не получен токен Национального Каталога

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_integration_with_nc; localMessage содержит приведённый выше перевод.

400error_service_did_not_find_any_results
Сервис не нашел результатов по заданным параметрам {number}

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_service_did_not_find_any_results; localMessage содержит приведённый выше перевод.

400error_service_not_implemented
Сервис не реализован

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_service_not_implemented; localMessage содержит приведённый выше перевод.

400error_subscription_expired
У вас закончился срок действия тарифа. Оплатите тариф для продолжения использования сервиса.

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_subscription_expired; localMessage содержит приведённый выше перевод.

400error_token_expired_or_revoked
Токен API отозван или введен некорректно. Проверьте, что ключ API имеет полный функционал. Сгенерируйте новый ключ и замените в SELSUP, так как ключи имеют срок жизни.

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_token_expired_or_revoked; localMessage содержит приведённый выше перевод.

GET

Поиск параметров

/api/param/find
Токен с правами чтения

Возвращает список всех заведенных параметров для категории озон, предмета Вайлдбериз или Национального каталога

Параметры запроса

ПолеТипОбязательноОписание
nationalCatalogId integer · int64 Нет ТНВЭД национального каталога для которого необходимо получить список значений
wildberriesTypeId integer · int64 Нет Предмет Вайлдбериз для которой неободимо получить список значений
wildberriesCategoryId integer · int64 Нет Категория Вайлдбериз для которой неободимо получить список значений
ozonCategoryId integer · int64 Нет Категория Озон для которой неободимо получить список значений
ozonDescriptionCategoryId integer · int64 Нет Новая категория Озон для которой неободимо получить список значений
aliexpressCategoryId integer · int64 Нет Категория Aliexpress для которой неободимо получить список значений
lamodaCategoryId integer · int64 Нет Категория Lamoda для которой необходимо получить список значений
kaspiCategoryId string Нет Код категории Kaspi для получения характеристик
avitoCategoryId integer · int64 Нет Категория Avito для которой неободимо получить список значений
yandexMarketCategoryId integer · int64 Нет Категория Яндекс.Маркета для которой неободимо получить список значений
categoryId integer · int32 Нет Категория SelSup, используется только для параметров клиента вместе с clientId
useAllCategories boolean Нет Используется только параметров клиента
useCategoryOption boolean Нет Поле useCategoryOption.
limit integer · int32 Нет Ограничение на количество записей. Максимальное значение - 500
page integer · int32 Нет Номер страницы начиная с 1
count boolean Нет Возвратить в ответе общее количество записей
sortBy string Нет Поле сортировки записей. Работает только при получении списка.
ascending boolean Нет Порядок сортировки - по возрастанию?. Работает только при получении списка.
curl --request GET 'https://api.selsup.ru/api/param/find?limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

Успешный ответ

200
Структура элемента массива Param[]
ПолеТипОбязательноОписание
name string Нет Поле name.
title string Нет Поле title.
published boolean Нет Поле published.
visible boolean Нет Поле visible.
serviceParam stringNAME, 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 Нет Поле serviceParam.
service stringNONE, 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 boolean Нет Поле useCategoryOption.
valueType stringBOOLEAN, LONG, DOUBLE, ENUM, TEXT, DATE Нет Поле valueType.
displayType stringSELECT, SUGGEST, TEXT, CHECKBOX, LONGTEXT Нет Поле displayType.
required boolean Нет Обязательность заполнения параметра
multiValueAllowed boolean Нет Многозначный параметр - у которого может быть несколько значений
maxValuesCount integer · int32 Нет Максимальное количество значений для многозначных параметров
useDictionary boolean Нет Поле useDictionary.
description string Нет Описание параметра, как его заполнять и особенности заполнения
groupName string Нет Название группировки параметров
groupId string Нет Идентификатор группы параметров
ozonDictionaryId integer · int64 Нет Поле ozonDictionaryId.
dictionaryId integer · int64 Нет Поле dictionaryId.
measureId integer · int32 Нет Поле measureId.
measure Measure Нет Единица измерения параметра
Поля объекта Measure
ПолеТипОбязательноОписание
id integer · int32 Нет Поле id.
name string Нет Поле name.
nationalCatalogId integer · int64 Нет Поле nationalCatalogId.
wildberriesTypeId integer · int64 Нет Поле wildberriesTypeId.
aliexpressCategoryId integer · int64 Нет Поле aliexpressCategoryId.
units Unit[] Нет Поле units.
Структура элемента массива Unit
ПолеТипОбязательноОписание
name string Нет Название единицы измерения
measureId integer · int32 Нет Мера параметра
id integer · int32 Нет Поле id.
unitsMap object Нет Поле unitsMap.
measureId integer · int32 Нет Поле measureId.
defaultUnit Unit Нет Поле defaultUnit.
Поля объекта Unit
ПолеТипОбязательноОписание
name string Нет Название единицы измерения
measureId integer · int32 Нет Мера параметра
id integer · int32 Нет Поле id.
ozonId integer · int64 Нет Поле ozonId.
wildberriesId integer · int64 Нет Поле wildberriesId.
ymId integer · int64 Нет Поле ymId.
lamodaId string Нет Поле lamodaId.
nationalCatalogId integer · int64 Нет Связь с параметром национального каталога
categoryId integer · int64 Нет Поле categoryId.
avitoIds integer[] Нет Поле avitoIds.
avitoOptionsXmlFileName string Нет Поле avitoOptionsXmlFileName.
clientId integer · int64 Нет Заполняется для пользовательских параметров
createdDate string · date-time Нет Поле createdDate.
aliexpressId integer · int64 Нет Поле aliexpressId.
preset string Нет Поле preset.
dictionaryParamId integer · int64 Нет Поле dictionaryParamId.
dictionaryKey string Нет Поле dictionaryKey.
level stringCATEGORY, MODEL, VIEW, PRODUCT Нет Поле level.
gs1Class stringSHOES, 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 boolean Нет Используется для параметров клиента
oneCId string Нет Поле oneCId.
options Option[] Нет Поле options.
Структура элемента массива Option
ПолеТипОбязательноОписание
id integer · int64 Нет Идентификатор значения, может отсутствовать
name string Нет Название значения, лучше всегда передавать
paramId integer · int64 Нет Идентификатор значения параметра Param.id
ozonId integer · int64 Нет Идентификатор значения параметра на Ozon
wildberriesId integer · int64 Нет Признак того, что значение параметра WB
ymId integer · int64 Нет Признак того, что значение параметра YM
aliexpressId integer · int64 Нет Идентификатор значения параметра на Aliexpress
clientId integer · int64 Нет Поле clientId.
deleted boolean Нет Поле deleted.
oneCId string Нет Идентификатор значения параметра в 1С
dictionary boolean Нет Поле dictionary.
optionId Option Нет Поле optionId.
optionsCache CacheStringOption Нет Поле optionsCache.
lastRefreshOptions integer · int64 Нет Поле lastRefreshOptions.
optionsCount integer · int32 Нет Поле optionsCount.
isAnalytic boolean Нет Использовать параметр в аналитических отчетах
analyticOrder integer · int32 Нет Порядок отображения параметра в аналитических отчетах. NULL — параметр выводится после всех упорядоченных, в алфавитном порядке по имени
marketplaceService stringNONE, 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 integer · int64 Нет Поле id.
[
  "string"
]
Ошибки3

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

DELETE

Удаление пользовательского параметра

/api/param/{paramId}
Токен с правами записи

Удаляет глобальный пользовательский параметр клиента

Параметры пути

ПолеТипОбязательноОписание
paramId integer · int64 Да Поле paramId.
curl --request DELETE 'https://api.selsup.ru/api/param/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Успешный ответ

200
"string"
Ошибки6

Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑

401auth_required
Требуется авторизация

Заголовок Authorization отсутствует, пуст или содержит недействительный токен.

400error_access_denied
Недостаточно прав

Токен существует, но его роль не позволяет выполнить операцию.

500error_unknown
Непредвиденная ошибка

Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.

400error_no_client
Клиент не найден или был удален. Напишите в поддержку

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.

400error_remove_param
Не удается удалить параметр

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_remove_param; localMessage содержит приведённый выше перевод.

400error_subscription_expired
У вас закончился срок действия тарифа. Оплатите тариф для продолжения использования сервиса.

Персональная ошибка этого метода. Для программной логики используйте стабильный код error_subscription_expired; localMessage содержит приведённый выше перевод.

Authorization

Токен для тестовых запросов

Токен хранится только в localStorage этого браузера и отправляется исключительно в заголовке Authorization запросов к api.selsup.ru.

Попробовать

Параметры реального запроса

Реальный ответ API

Выполните запрос, чтобы увидеть ответ SelSup.