SelSup Developers

Грамадскае API · API Падпісанне

Параметры

Канчатковыя пункты для параметраў, уключаючы дакладныя маршруты, параметры, органы запыту і схемы пашырэння адказу.

5 канчатковыя пункты/api/paramСтабільныМашыначытна чытае апісанне ↗
{ }

Гэты старонка падтрымліваецца рэдагаваць самастойны кантракт.

/api/param

Готовыя да выкарыстання працоўныя патокі

Готовыя да выкарыстання працоўныя патокі

01

Пачніце выкарыстоўваць параметры

Выкарыстоўвайце адмысловы токен API і пацвердзіце аперацыі чытання з дадзенымі тэсту спачатку.

  1. Захоўвайце знак з боку сервера і адправіце яго ў заголоўку Authorization.
  2. Праверце патрабаваныя параметры і пашырыць схему запыту або адказу.
  3. Выкарыстоўвайце стан HTTP і стабільнае поле error ў памылках прыкладання.

Мадэль дадзеных

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

Мадэлі пералічаныя тут адзін раз і могуць быць пашыраныя непасрэдна з канчатковых пунктаў, якія іх выкарыстоўваюць.

CacheStringOption0 палёў
Measure8 палёў
idinteger · int32

Id.

namestring

Назва.

nationalCatalogIdinteger · int64

Нацыянальны каталог ID.

wildberriesTypeIdinteger · int64

Вільготныя яблыкі тыпу ID.

aliexpressCategoryIdinteger · int64

Аліэкспрэс катэгорыя ID.

unitsUnit[]

Адраздзяленні.

unitsMapobject

Карта адзінак.

measureIdinteger · int32

Вымяраць ID.

Option12 палёў
idinteger · int64

Id.

namestring

Назва.

paramIdinteger · int64

Парам ID.

ozonIdinteger · int64

Азоны ID.

wildberriesIdinteger · int64

Ід Wildberries.

ymIdinteger · int64

Яму ідэнтыфікацыя.

aliexpressIdinteger · int64

Аліэкспрэс ID.

clientIdinteger · int64

Ідэнтыфікатар кліента.

deletedboolean

Здарэнне.

oneCIdstring

Адзін ІК.

dictionaryboolean

Слоўнік.

optionIdOption

Ід варыянту.

Param47 палёў
namestring

Назва.

titlestring

Назва.

publishedboolean

Выдадзены.

visibleboolean

Відаць.

serviceParamstring

Паслугі Парам.

servicestring

Паслуга.

useCategoryOptionboolean

Выкарыстоўвайце варыянт катэгорыі.

valueTypestring

Тып значэння.

displayTypestring

Тып дысплей.

requiredboolean

Патрабавана.

multiValueAllowedboolean

Шматзначныя дапушчаныя.

maxValuesCountinteger · int32

Максімальныя каштоўнасці лічаць.

useDictionaryboolean

Выкарыстоўвайце слоўнік.

descriptionstring

Апісанне.

groupNamestring

Назва групы.

groupIdstring

Группа ID.

ozonDictionaryIdinteger · int64

Азоны слоўнік ID.

dictionaryIdinteger · int64

Спіс слоўніка.

measureIdinteger · int32

Вымяраць ID.

measureMeasure

Вымяраць.

defaultUnitUnit

Падставовы блок.

ozonIdinteger · int64

Азоны ID.

wildberriesIdinteger · int64

Ід Wildberries.

ymIdinteger · int64

Яму ідэнтыфікацыя.

lamodaIdstring

Ламуда ID.

nationalCatalogIdinteger · int64

Нацыянальны каталог ID.

categoryIdinteger · int64

Ід катэгорыі.

avitoIdsinteger[]

Авіто IDs.

avitoOptionsXmlFileNamestring

Avito Options Xml імя файла.

clientIdinteger · int64

Ідэнтыфікатар кліента.

createdDatestring · date-time

Стварыўся Дата.

aliexpressIdinteger · int64

Аліэкспрэс ID.

presetstring

Папярэдне ўсталёўваецца.

dictionaryParamIdinteger · int64

Слоўнік Param ID.

dictionaryKeystring

Ключ да слоўніка.

levelstring

Уніз.

gs1Classstring

Клас Gs1.

useAllCategoriesboolean

Выкарыстоўвайце ўсе катэгорыі.

oneCIdstring

Адзін ІК.

optionsOption[]

Варыянты.

optionsCacheCacheStringOption

Варыянты Cache.

lastRefreshOptionsinteger · int64

Апошнія варыянты абнаўлення.

optionsCountinteger · int32

Варыянты лічаць.

isAnalyticboolean

Гэта Аналітыка.

analyticOrderinteger · int32

Аналітычны ордэн.

marketplaceServicestring

Служба рынку.

idinteger · int64

Id.

Unit3 палёў
namestring

Назва.

measureIdinteger · int32

Вымяраць ID.

idinteger · int32

Id.

SuggestParam1 палёў
numberstring

Нумар.

SuggestResponse3 палёў
apiversioninteger · int32

Апіверсія.

resultSuggestParam[]

Вынік.

emptyboolean

Пусты.

Памылка дагавор

Як вяртаюць памылкі прыкладання

Код error аднолькавы ў кожным лакелі, у той час як паведамленне, якое з'яўляецца карыстальнікам, перакладаецца серверам.

error

Стабільны машыначытай код для інтэграцыйнай логікі.

localMessage

Паведамленне гатовае да адлюстравання на мове карыстальніка токены API.

params

Значэнні, якія інтэрполююцца серверам у лакалізаваным шаблоне паведамленняў.

localMessage выкарыстоўвае поле lang карыстальніка, які валодае токеном API. Мова дакументацыі і загаловак Accept-Language не змяняюць яго; руская выкарыстоўваецца, калі карыстацкая мова не канфігуруецца.

RUМясцовасць карыстальніка ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
BEБеларуская (be)
{
  "error": "error_brand_already_exists",
  "localMessage": "Брэнд Base ужо існуе",
  "params": {
    "name": "Base"
  }
}

Канчатковыя пункты

Канчатковыя пункты

POST

Паста Парам

/api/param/
Знак з пісьмовым доступам

Паставай параметры з дапамогай POST /api/param/.

Запытвальны орган

application/json
Палі аб'ектаўParam
ПолеТыпАбавязковаАпісанне
name string Не Назва.
title string Не Назва.
published boolean Не Выдадзены.
visible boolean Не Відаць.
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 Не Паслугі Парам.
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 Не Выкарыстоўвайце варыянт катэгорыі.
valueType stringBOOLEAN, LONG, DOUBLE, ENUM, TEXT, DATE Не Тып значэння.
displayType stringSELECT, SUGGEST, TEXT, CHECKBOX, LONGTEXT Не Тып дысплей.
required boolean Не Патрабавана.
multiValueAllowed boolean Не Шматзначныя дапушчаныя.
maxValuesCount integer · int32 Не Максімальныя каштоўнасці лічаць.
useDictionary boolean Не Выкарыстоўвайце слоўнік.
description string Не Апісанне.
groupName string Не Назва групы.
groupId string Не Группа ID.
ozonDictionaryId integer · int64 Не Азоны слоўнік ID.
dictionaryId integer · int64 Не Спіс слоўніка.
measureId integer · int32 Не Вымяраць ID.
measure Measure Не Вымяраць.
Палі аб'ектаў Measure
ПолеТыпАбавязковаАпісанне
id integer · int32 Не Id.
name string Не Назва.
nationalCatalogId integer · int64 Не Нацыянальны каталог ID.
wildberriesTypeId integer · int64 Не Вільготныя яблыкі тыпу ID.
aliexpressCategoryId integer · int64 Не Аліэкспрэс катэгорыя ID.
units Unit[] Не Адраздзяленні.
Структура элементаў масіва Unit
ПолеТыпАбавязковаАпісанне
name string Не Назва.
measureId integer · int32 Не Вымяраць ID.
id integer · int32 Не Id.
unitsMap object Не Карта адзінак.
measureId integer · int32 Не Вымяраць ID.
defaultUnit Unit Не Падставовы блок.
Палі аб'ектаў Unit
ПолеТыпАбавязковаАпісанне
name string Не Назва.
measureId integer · int32 Не Вымяраць ID.
id integer · int32 Не Id.
ozonId integer · int64 Не Азоны ID.
wildberriesId integer · int64 Не Ід Wildberries.
ymId integer · int64 Не Яму ідэнтыфікацыя.
lamodaId string Не Ламуда ID.
nationalCatalogId integer · int64 Не Нацыянальны каталог ID.
categoryId integer · int64 Не Ід катэгорыі.
avitoIds integer[] Не Авіто IDs.
avitoOptionsXmlFileName string Не Avito Options Xml імя файла.
clientId integer · int64 Не Ідэнтыфікатар кліента.
createdDate string · date-time Не Стварыўся Дата.
aliexpressId integer · int64 Не Аліэкспрэс ID.
preset string Не Папярэдне ўсталёўваецца.
dictionaryParamId integer · int64 Не Слоўнік Param ID.
dictionaryKey string Не Ключ да слоўніка.
level stringCATEGORY, MODEL, VIEW, PRODUCT Не Уніз.
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 Не Клас Gs1.
useAllCategories boolean Не Выкарыстоўвайце ўсе катэгорыі.
oneCId string Не Адзін ІК.
options Option[] Не Варыянты.
Структура элементаў масіва Option
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
name string Не Назва.
paramId integer · int64 Не Парам ID.
ozonId integer · int64 Не Азоны ID.
wildberriesId integer · int64 Не Ід Wildberries.
ymId integer · int64 Не Яму ідэнтыфікацыя.
aliexpressId integer · int64 Не Аліэкспрэс ID.
clientId integer · int64 Не Ідэнтыфікатар кліента.
deleted boolean Не Здарэнне.
oneCId string Не Адзін ІК.
dictionary boolean Не Слоўнік.
optionId Option Не Ід варыянту.
optionsCache CacheStringOption Не Варыянты Cache.
lastRefreshOptions integer · int64 Не Апошнія варыянты абнаўлення.
optionsCount integer · int32 Не Варыянты лічаць.
isAnalytic boolean Не Гэта Аналітыка.
analyticOrder integer · int32 Не Аналітычны ордэн.
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 Не Назва.
title string Не Назва.
published boolean Не Выдадзены.
visible boolean Не Відаць.
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 Не Паслугі Парам.
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 Не Выкарыстоўвайце варыянт катэгорыі.
valueType stringBOOLEAN, LONG, DOUBLE, ENUM, TEXT, DATE Не Тып значэння.
displayType stringSELECT, SUGGEST, TEXT, CHECKBOX, LONGTEXT Не Тып дысплей.
required boolean Не Патрабавана.
multiValueAllowed boolean Не Шматзначныя дапушчаныя.
maxValuesCount integer · int32 Не Максімальныя каштоўнасці лічаць.
useDictionary boolean Не Выкарыстоўвайце слоўнік.
description string Не Апісанне.
groupName string Не Назва групы.
groupId string Не Группа ID.
ozonDictionaryId integer · int64 Не Азоны слоўнік ID.
dictionaryId integer · int64 Не Спіс слоўніка.
measureId integer · int32 Не Вымяраць ID.
measure Measure Не Вымяраць.
Палі аб'ектаў Measure
ПолеТыпАбавязковаАпісанне
id integer · int32 Не Id.
name string Не Назва.
nationalCatalogId integer · int64 Не Нацыянальны каталог ID.
wildberriesTypeId integer · int64 Не Вільготныя яблыкі тыпу ID.
aliexpressCategoryId integer · int64 Не Аліэкспрэс катэгорыя ID.
units Unit[] Не Адраздзяленні.
Структура элементаў масіва Unit
ПолеТыпАбавязковаАпісанне
name string Не Назва.
measureId integer · int32 Не Вымяраць ID.
id integer · int32 Не Id.
unitsMap object Не Карта адзінак.
measureId integer · int32 Не Вымяраць ID.
defaultUnit Unit Не Падставовы блок.
Палі аб'ектаў Unit
ПолеТыпАбавязковаАпісанне
name string Не Назва.
measureId integer · int32 Не Вымяраць ID.
id integer · int32 Не Id.
ozonId integer · int64 Не Азоны ID.
wildberriesId integer · int64 Не Ід Wildberries.
ymId integer · int64 Не Яму ідэнтыфікацыя.
lamodaId string Не Ламуда ID.
nationalCatalogId integer · int64 Не Нацыянальны каталог ID.
categoryId integer · int64 Не Ід катэгорыі.
avitoIds integer[] Не Авіто IDs.
avitoOptionsXmlFileName string Не Avito Options Xml імя файла.
clientId integer · int64 Не Ідэнтыфікатар кліента.
createdDate string · date-time Не Стварыўся Дата.
aliexpressId integer · int64 Не Аліэкспрэс ID.
preset string Не Папярэдне ўсталёўваецца.
dictionaryParamId integer · int64 Не Слоўнік Param ID.
dictionaryKey string Не Ключ да слоўніка.
level stringCATEGORY, MODEL, VIEW, PRODUCT Не Уніз.
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 Не Клас Gs1.
useAllCategories boolean Не Выкарыстоўвайце ўсе катэгорыі.
oneCId string Не Адзін ІК.
options Option[] Не Варыянты.
Структура элементаў масіва Option
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
name string Не Назва.
paramId integer · int64 Не Парам ID.
ozonId integer · int64 Не Азоны ID.
wildberriesId integer · int64 Не Ід Wildberries.
ymId integer · int64 Не Яму ідэнтыфікацыя.
aliexpressId integer · int64 Не Аліэкспрэс ID.
clientId integer · int64 Не Ідэнтыфікатар кліента.
deleted boolean Не Здарэнне.
oneCId string Не Адзін ІК.
dictionary boolean Не Слоўнік.
optionId Option Не Ід варыянту.
optionsCache CacheStringOption Не Варыянты Cache.
lastRefreshOptions integer · int64 Не Апошнія варыянты абнаўлення.
optionsCount integer · int32 Не Варыянты лічаць.
isAnalytic boolean Не Гэта Аналітыка.
analyticOrder integer · int32 Не Аналітычны ордэн.
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. Як вяртаюць памылкі прыкладання ↑

401auth_required
Патрабаваная аўтэнтыфікацыя

Authorization не хапае, пусты, або ўтрымлівае недаступны токен.

400error_access_denied
Доступ забаронены

Токен існуе, але яго роля не можа выканаць гэтую аперацыю.

500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі

Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.

400error_param_empty_display_type
Не пазначаны тып

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_param_empty_display_type ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

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

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_param_empty_level ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_param_empty_name
Не пазначана назва параметра

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_param_empty_name ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_param_empty_value_type
Не пазначаны тып значэння параметра

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_param_empty_value_type ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_subscription_expired
У вас скончыўся тэрмін дзеяння тарыфа. Аплаціце тарыф для працягу выкарыстання сэрвісу.

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_subscription_expired ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

GET

Парам

/api/param/{id}
Значок з чытальным доступам

Парам з выкарыстаннем 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 Не Назва.
title string Не Назва.
published boolean Не Выдадзены.
visible boolean Не Відаць.
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 Не Паслугі Парам.
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 Не Выкарыстоўвайце варыянт катэгорыі.
valueType stringBOOLEAN, LONG, DOUBLE, ENUM, TEXT, DATE Не Тып значэння.
displayType stringSELECT, SUGGEST, TEXT, CHECKBOX, LONGTEXT Не Тып дысплей.
required boolean Не Патрабавана.
multiValueAllowed boolean Не Шматзначныя дапушчаныя.
maxValuesCount integer · int32 Не Максімальныя каштоўнасці лічаць.
useDictionary boolean Не Выкарыстоўвайце слоўнік.
description string Не Апісанне.
groupName string Не Назва групы.
groupId string Не Группа ID.
ozonDictionaryId integer · int64 Не Азоны слоўнік ID.
dictionaryId integer · int64 Не Спіс слоўніка.
measureId integer · int32 Не Вымяраць ID.
measure Measure Не Вымяраць.
Палі аб'ектаў Measure
ПолеТыпАбавязковаАпісанне
id integer · int32 Не Id.
name string Не Назва.
nationalCatalogId integer · int64 Не Нацыянальны каталог ID.
wildberriesTypeId integer · int64 Не Вільготныя яблыкі тыпу ID.
aliexpressCategoryId integer · int64 Не Аліэкспрэс катэгорыя ID.
units Unit[] Не Адраздзяленні.
Структура элементаў масіва Unit
ПолеТыпАбавязковаАпісанне
name string Не Назва.
measureId integer · int32 Не Вымяраць ID.
id integer · int32 Не Id.
unitsMap object Не Карта адзінак.
measureId integer · int32 Не Вымяраць ID.
defaultUnit Unit Не Падставовы блок.
Палі аб'ектаў Unit
ПолеТыпАбавязковаАпісанне
name string Не Назва.
measureId integer · int32 Не Вымяраць ID.
id integer · int32 Не Id.
ozonId integer · int64 Не Азоны ID.
wildberriesId integer · int64 Не Ід Wildberries.
ymId integer · int64 Не Яму ідэнтыфікацыя.
lamodaId string Не Ламуда ID.
nationalCatalogId integer · int64 Не Нацыянальны каталог ID.
categoryId integer · int64 Не Ід катэгорыі.
avitoIds integer[] Не Авіто IDs.
avitoOptionsXmlFileName string Не Avito Options Xml імя файла.
clientId integer · int64 Не Ідэнтыфікатар кліента.
createdDate string · date-time Не Стварыўся Дата.
aliexpressId integer · int64 Не Аліэкспрэс ID.
preset string Не Папярэдне ўсталёўваецца.
dictionaryParamId integer · int64 Не Слоўнік Param ID.
dictionaryKey string Не Ключ да слоўніка.
level stringCATEGORY, MODEL, VIEW, PRODUCT Не Уніз.
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 Не Клас Gs1.
useAllCategories boolean Не Выкарыстоўвайце ўсе катэгорыі.
oneCId string Не Адзін ІК.
options Option[] Не Варыянты.
Структура элементаў масіва Option
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
name string Не Назва.
paramId integer · int64 Не Парам ID.
ozonId integer · int64 Не Азоны ID.
wildberriesId integer · int64 Не Ід Wildberries.
ymId integer · int64 Не Яму ідэнтыфікацыя.
aliexpressId integer · int64 Не Аліэкспрэс ID.
clientId integer · int64 Не Ідэнтыфікатар кліента.
deleted boolean Не Здарэнне.
oneCId string Не Адзін ІК.
dictionary boolean Не Слоўнік.
optionId Option Не Ід варыянту.
optionsCache CacheStringOption Не Варыянты Cache.
lastRefreshOptions integer · int64 Не Апошнія варыянты абнаўлення.
optionsCount integer · int32 Не Варыянты лічаць.
isAnalytic boolean Не Гэта Аналітыка.
analyticOrder integer · int32 Не Аналітычны ордэн.
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. Як вяртаюць памылкі прыкладання ↑

401auth_required
Патрабаваная аўтэнтыфікацыя

Authorization не хапае, пусты, або ўтрымлівае недаступны токен.

400error_access_denied
Доступ забаронены

Токен існуе, але яго роля не можа выканаць гэтую аперацыю.

500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі

Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.

400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

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

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_not_found_param_by_id ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

GET

Атрымаць парам прапановы патрабуецца

/api/param/preset/{service}/{organizationId}/{preset}
Значок з чытальным доступам

Атрымаць парам Прапанова патрабуецца з дапамогай 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 Так Папярэдне ўсталёўваецца.
organizationId integer · int64 Так Ід арганізацыі.

Параметры запытаў

ПолеТыпАбавязковаАпісанне
attrId integer · int64 Так Адміністратар ID.
number string Так Нумар.
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 Не Апіверсія.
result SuggestParam[] Не Вынік.
Структура элементаў масіва SuggestParam
ПолеТыпАбавязковаАпісанне
number string Не Нумар.
empty boolean Не Пусты.
{
  "apiversion": 1,
  "result": "string",
  "empty": false
}
Памылкі8

Памылкі прыкладання звычайна вяртаюцца ў выглядзе JSON з error, localMessage і params. Як вяртаюць памылкі прыкладання ↑

401auth_required
Патрабаваная аўтэнтыфікацыя

Authorization не хапае, пусты, або ўтрымлівае недаступны токен.

400error_access_denied
Доступ забаронены

Токен існуе, але яго роля не можа выканаць гэтую аперацыю.

500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі

Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.

400error_no_integration_with_nc
Не атрыманы токен Нацыянальнага Каталога

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_integration_with_nc ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_service_did_not_find_any_results
Сэрвіс не знайшоў вынікаў па зададзеных параметрах {number}

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_service_did_not_find_any_results ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_service_not_implemented
Сэрвіс не рэалізаваны

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_service_not_implemented ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_subscription_expired
У вас скончыўся тэрмін дзеяння тарыфа. Аплаціце тарыф для працягу выкарыстання сэрвісу.

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_subscription_expired ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_token_expired_or_revoked
Токен API адкліканы або ўведзены некарэктна. Праверце, што ключ API мае поўны функцыянал. Згенеруйце новы ключ і заменіце ў SELSUP, бо ключы маюць тэрмін жыцця.

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_token_expired_or_revoked ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

GET

Парамы

/api/param/find
Значок з чытальным доступам

Параметры з выкарыстаннем GET /api/param/find.

Параметры запытаў

ПолеТыпАбавязковаАпісанне
nationalCatalogId integer · int64 Не Нацыянальны каталог ID.
wildberriesTypeId integer · int64 Не Вільготныя яблыкі тыпу ID.
wildberriesCategoryId integer · int64 Не Wildberries Катэгорыя ID.
ozonCategoryId integer · int64 Не Ід катэгорыі озону.
ozonDescriptionCategoryId integer · int64 Не Апісанне азону Катэгорыя ID.
aliexpressCategoryId integer · int64 Не Аліэкспрэс катэгорыя ID.
lamodaCategoryId integer · int64 Не Ід катэгорыі Lamoda.
kaspiCategoryId string Не Ід катэгорыі Каспі.
avitoCategoryId integer · int64 Не Авіто Катэгорыя ID.
yandexMarketCategoryId integer · int64 Не Яндекс Рынок Катэгорыя ID.
categoryId integer · int32 Не Ід катэгорыі.
useAllCategories boolean Не Выкарыстоўвайце ўсе катэгорыі.
useCategoryOption boolean Не Выкарыстоўвайце варыянт катэгорыі.
limit integer · int32 Не Межа.
page integer · int32 Не Праз старонку.
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 Не Назва.
title string Не Назва.
published boolean Не Выдадзены.
visible boolean Не Відаць.
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 Не Паслугі Парам.
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 Не Выкарыстоўвайце варыянт катэгорыі.
valueType stringBOOLEAN, LONG, DOUBLE, ENUM, TEXT, DATE Не Тып значэння.
displayType stringSELECT, SUGGEST, TEXT, CHECKBOX, LONGTEXT Не Тып дысплей.
required boolean Не Патрабавана.
multiValueAllowed boolean Не Шматзначныя дапушчаныя.
maxValuesCount integer · int32 Не Максімальныя каштоўнасці лічаць.
useDictionary boolean Не Выкарыстоўвайце слоўнік.
description string Не Апісанне.
groupName string Не Назва групы.
groupId string Не Группа ID.
ozonDictionaryId integer · int64 Не Азоны слоўнік ID.
dictionaryId integer · int64 Не Спіс слоўніка.
measureId integer · int32 Не Вымяраць ID.
measure Measure Не Вымяраць.
Палі аб'ектаў Measure
ПолеТыпАбавязковаАпісанне
id integer · int32 Не Id.
name string Не Назва.
nationalCatalogId integer · int64 Не Нацыянальны каталог ID.
wildberriesTypeId integer · int64 Не Вільготныя яблыкі тыпу ID.
aliexpressCategoryId integer · int64 Не Аліэкспрэс катэгорыя ID.
units Unit[] Не Адраздзяленні.
Структура элементаў масіва Unit
ПолеТыпАбавязковаАпісанне
name string Не Назва.
measureId integer · int32 Не Вымяраць ID.
id integer · int32 Не Id.
unitsMap object Не Карта адзінак.
measureId integer · int32 Не Вымяраць ID.
defaultUnit Unit Не Падставовы блок.
Палі аб'ектаў Unit
ПолеТыпАбавязковаАпісанне
name string Не Назва.
measureId integer · int32 Не Вымяраць ID.
id integer · int32 Не Id.
ozonId integer · int64 Не Азоны ID.
wildberriesId integer · int64 Не Ід Wildberries.
ymId integer · int64 Не Яму ідэнтыфікацыя.
lamodaId string Не Ламуда ID.
nationalCatalogId integer · int64 Не Нацыянальны каталог ID.
categoryId integer · int64 Не Ід катэгорыі.
avitoIds integer[] Не Авіто IDs.
avitoOptionsXmlFileName string Не Avito Options Xml імя файла.
clientId integer · int64 Не Ідэнтыфікатар кліента.
createdDate string · date-time Не Стварыўся Дата.
aliexpressId integer · int64 Не Аліэкспрэс ID.
preset string Не Папярэдне ўсталёўваецца.
dictionaryParamId integer · int64 Не Слоўнік Param ID.
dictionaryKey string Не Ключ да слоўніка.
level stringCATEGORY, MODEL, VIEW, PRODUCT Не Уніз.
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 Не Клас Gs1.
useAllCategories boolean Не Выкарыстоўвайце ўсе катэгорыі.
oneCId string Не Адзін ІК.
options Option[] Не Варыянты.
Структура элементаў масіва Option
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
name string Не Назва.
paramId integer · int64 Не Парам ID.
ozonId integer · int64 Не Азоны ID.
wildberriesId integer · int64 Не Ід Wildberries.
ymId integer · int64 Не Яму ідэнтыфікацыя.
aliexpressId integer · int64 Не Аліэкспрэс ID.
clientId integer · int64 Не Ідэнтыфікатар кліента.
deleted boolean Не Здарэнне.
oneCId string Не Адзін ІК.
dictionary boolean Не Слоўнік.
optionId Option Не Ід варыянту.
optionsCache CacheStringOption Не Варыянты Cache.
lastRefreshOptions integer · int64 Не Апошнія варыянты абнаўлення.
optionsCount integer · int32 Не Варыянты лічаць.
isAnalytic boolean Не Гэта Аналітыка.
analyticOrder integer · int32 Не Аналітычны ордэн.
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. Як вяртаюць памылкі прыкладання ↑

401auth_required
Патрабаваная аўтэнтыфікацыя

Authorization не хапае, пусты, або ўтрымлівае недаступны токен.

400error_access_denied
Доступ забаронены

Токен існуе, але яго роля не можа выканаць гэтую аперацыю.

500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі

Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.

DELETE

Знімайце Param

/api/param/{paramId}
Знак з пісьмовым доступам

Знімайце параметр з дапамогай DELETE /api/param/{paramId}.

Параметры шляху

ПолеТыпАбавязковаАпісанне
paramId integer · int64 Так Парам ID.
curl --request DELETE 'https://api.selsup.ru/api/param/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200
"string"
Памылкі6

Памылкі прыкладання звычайна вяртаюцца ў выглядзе JSON з error, localMessage і params. Як вяртаюць памылкі прыкладання ↑

401auth_required
Патрабаваная аўтэнтыфікацыя

Authorization не хапае, пусты, або ўтрымлівае недаступны токен.

400error_access_denied
Доступ забаронены

Токен існуе, але яго роля не можа выканаць гэтую аперацыю.

500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі

Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.

400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_remove_param
Не атрымоўваецца выдаліць параметр

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_remove_param ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_subscription_expired
У вас скончыўся тэрмін дзеяння тарыфа. Аплаціце тарыф для працягу выкарыстання сэрвісу.

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_subscription_expired ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

Authorization

Знак для запытаў на выпрабаванне

Токен застаецца ў лакальным сховішчы гэтага браўзэра і адпраўляецца толькі ў заголоўцы Authorization запытаў на api.selsup.ru.

Паспрабаваць

Рэальныя параметры запыту

Жывы адказ API

Пашляце запыт, каб убачыць адказ SelSup.