Модели перечислены отдельно и раскрываются также непосредственно у методов, где они используются.
QualityDocumentImage5 полей
idinteger · int64
Поле id.
urlstring
Поле url.
positioninteger · int32
Поле position.
documentIdinteger · int64
Поле documentId.
clientIdinteger · int64
Поле clientId.
AliexpressCategory8 полей
idinteger · int64
Поле id.
namestring
Поле name.
publishedboolean
Поле published.
parentIdinteger · int64
Поле parentId.
aliexpressIdinteger · int64
Поле aliexpressId.
lastSyncDatestring · date-time
Дата последней синхронизации категории
notChangedDaysinteger · int32
Количество дней, в течение которых данные категории не менялась. Используется для того, чтобы сократить обновление категорий, которые не меняются
isLeafboolean
Категория является листовой. Карточки можно добавлять только в листовые
AvitoCategory9 полей
idinteger · int64
Идентификатор категории на Авито.Совпадает с идентификатором Авито
Обязательно
namestring
Полное название категории (включает в себя названия родительских категорий)
Обязательно
shortNamestring
Краткое название категории
publishedboolean
Опубликована категория
parentIdinteger · int64
id родительской категории Авито. Используется при импорте обьявлений с Авито
lastSyncDatestring · date-time
Дата последней синхронизации категории
isLeafboolean
Категория является листовой. Карточки можно добавлять только в листовые
goodsTypestring
Тег GoodsType в фиде
categorystring
Тег Category в фиде
Brand11 полей
brandIdinteger · int32
Идентификатор бренда
read-only
namestring
Название бренда
Обязательно
clientIdinteger · int64
Идентификатор клиента
read-only
logoUrlstring
Ссылка логотипа бренда
read-only
logoSizeinteger · int32
Размер логотипа в байтах
read-only
logoWidthinteger · int32
Ширина логотипа в пикселях
read-only
logoHeightinteger · int32
Высота логотипа в пикселях
read-only
deletedboolean
Бренд удален?
ozonNamestring
Название бренда на Ozon
ozonIdinteger · int64
ID бренда на Ozon
oneCIdstring
Идентификатор 1С
Category46 полей
categoryIdinteger · int32
Идентификатор категории. Проставляется автоматически
read-only
namestring
Наименование категории
Обязательно
deletedboolean
Признак удаленных категорий
read-only
parentIdinteger · int32
Идентификатор родительской категории
clientIdinteger · int64
Идентификатор клиента
read-only
markedboolean
Маркируется ли категория
categoryClassstring
Тип категории для Честного знака. По умолчанию ставится OTHER
wildberriesTypeWildberriesType
Предмет Вайлдбериз. Можно устанавливать либо объект,либо только идентификатор
wildberriesCategoryIdinteger · int64
Идентификатор категории Wildberries, совпадает с ID категории на самом Wildberries
wildberriesFbmCommissionnumber · double
Комиссия по тарифу FBM
read-only
wildberriesFbwCommissionnumber · double
Комиссия по тарифу FBW
read-only
wildberriesFbsCommissionnumber · double
Комиссия по тарифу FBS
read-only
wildberriesDbsCommissionnumber · double
Комиссия по тарифу DBS
read-only
wildberriesEdbsCommissionnumber · double
Комиссия по тарифу EDBS
read-only
wildberriesCAndCCommissionnumber · double
Комиссия по тарифу C&C
read-only
wildberriesBookingCommissionnumber · double
Комиссия за бронирование
read-only
ozonDescriptionCategoryIdinteger · int64
Идентификатор категории на Ozon. Строится из ID категории + ID типа на Ozon
yandexMarketCategoryIdinteger · int64
Идентификатор категории в Яндекс.Маркет. Совпадает с идентификатором категории на самом Яндекс.Маркет
yandexMarketCategoryYandexMarketCategory
Категория Яндекс.Маркета. Можно проставлять либо объект, либо только идентификатор
ozonDescriptionCategoryOzonDescriptionCategory
Категория Озон
ozonCommissionnumber · double
Комиссия озона.
read-only
tnvedTnved
ТНВЭД. Можно проставлять либо объект, либо идентификатор ТНВЭД
tnvedIdinteger · int64
Идентификатор ТНВЭД
laundrystring
Правила ухода за вещами. Разделяются запятыми
paramsstring
JSON значений параметров для категории
namePatternstring
Шаблон названий категории
aliexpressCategoryAliexpressCategory
Категория Aliexpress
aliexpressCategoryIdinteger · int64
Идентификатор категории на самом Aliexpress
avitoCategoryAvitoCategory
Категория Avito
lamodaCategoryLamodaCategory
Категория Lamoda
lamodaCategoryIdinteger · int64
Идентификатор категории на Lamoda
avitoCategoryIdinteger · int64
Идентификатор категории на Avito
packDepthinteger · int32
Глубина упаковки в мм. Проставляется всем товарам в категории
packWidthinteger · int32
Ширина упаковки в мм. Проставляется всем товарам в категории
packHeightinteger · int32
Высота упаковки в мм. Проставляется всем товарам в категории
packWeightinteger · int32
Вес упаковки в граммах. Проставляется всем товарам в категории
hasSizeboolean
Признак разделения товаров в категории по размеру. Меняет вид редактора карточки
hasColorboolean
Признак разделения товаров в категории по цвету. Меняет вид редактора карточки
autoNameboolean
Автоматически формировать названия товаров в категории
removeFbsStockboolean
Не передавать остатки товаров по FBS для товаров из этой категории
oneCIdstring
Идентификатор категории в 1С
externalIdstring
Идентификатор категории на сайте
moySkladIdstring
Идентификатор категории в сервисе МойСклад
useClientParamsboolean
Показывать пользовательские параметры в категории
requiredExpirationDateboolean
Является ли срок годности обязательным параметром
productCountinteger · int32
Количество товаров в категории. Отдается только при withProductCount=true
LamodaCategory8 полей
idinteger · int64
Поле id.
namestring
Название
shortNamestring
Краткое название категории
publishedboolean
Опубликованность категории
isLeafboolean
Листовая категория
parentIdinteger · int64
Поле parentId.
lastSyncDatestring · date-time
Дата последней синхронизации
notChangedDaysinteger · int32
Количество дней, в течение которых данные категории не менялась. Используется для того, чтобы сократить обновление категорий, которые не меняются
OzonDescriptionCategory21 полей
idinteger · int64
Идентификатор категории на Ozon. Состоит из двух идентификаторов Категории + ID типа на самом Ozon
namestring
Название категории
Обязательно
publishedboolean
Поле published.
parentIdinteger · int64
Поле parentId.
isLeafboolean
Признак листовой категории, в которой могут находиться товары
lastSyncDatestring · date-time
Дата последней синхронизации категории с Озон
notChangedDaysinteger · int32
Количество дней, в течение которых данные категории не менялась. Используется для того, чтобы сократить обновление категорий, которые не меняются
isErrorboolean
Поле isError.
errorDatestring · date
Поле errorDate.
typesstring
Поле types.
typeIdinteger · int64
Идентификатор типа на Ozon
purchasePercentAvgnumber · double
Среднее значение процента выкупа. Используется в AI Финдире
purchasePercentMinnumber · double
Минимально допустимое значение процента выкупа. Используется в AI Финдире
photoAvginteger · int32
Среднее кол-во фотографий. Используется в AI Финдире
photoMininteger · int32
Минимально допустимое кол-во фотографий. Используется в AI Финдире
drrAvgnumber · double
Среднее значение ДРР. Используется в AI Финдире
drrMinnumber · double
Минимально допустимое значение ДРР. Используется в AI Финдире
marginAvgnumber · double
Среднее значение маржинальности. Используется в AI Финдире
marginMinnumber · double
Минимально допустимое значение маржинальности. Используется в AI Финдире
promotionCtrAvgnumber · double
Среднее значение CTR рекламной кампании. Используется в AI Финдире
promotionCtrMinnumber · double
Минимально допустимое значение CTR рекламной кампании. Используется в AI Финдире
QualityDocument11 полей
idinteger · int64
Поле id.
namestring
Поле name.
typestring
Тип документа
numberstring
Номер сертификата
clientIdinteger · int64
Поле clientId.
versionIdinteger · int64
Поле versionId.
createdUserstring
Поле createdUser.
startDatestring · date
Дата начала действия сертификата
expireDatestring · date
Дата окончания срока действия сертификата
dataQualityDocumentData[]
Связи сертификата с брендом и категорией
imagesQualityDocumentImage[]
Изображения сертификата
QualityDocumentData8 полей
idinteger · int64
Поле id.
documentIdinteger · int64
Сертификат
productModelIdinteger · int64
Связь сертификата с продуктом
brandBrand
Связь сертификата с брендом
brandIdinteger · int32
Поле brandId.
categoryCategory
Связь категории с сертификатом
categoryIdinteger · int32
Поле categoryId.
clientIdinteger · int64
Поле clientId.
Tnved13 полей
idinteger · int64
Идентификатор кода ТНВЭД без нулей в начале
namestring
Название кода ТНВЭД
deletedboolean
Поле deleted.
typestring
Тип
categoryClassstring
Информационное поле, чтобы автоматически заполнять значение в категории,при выборе ТНВЭД, но никогда не используется в документах
parentIdinteger · int64
Родительский ТНВЭД
keywordsstring
Ключевые слова для кода ТНВЭД
descriptionstring
Описание кода ТНВЭД
paramsTnvedIdinteger · int64
Идентификатор категории национального каталога (cat_id)
isInParamboolean
Означает что ТНВЭД есть в параметре Вайлдбериз - их нужно выбирать в приоритете
certificationstring
Необходимость сертификации товаров с этим ТНВЭД
codestring
Поле code.
parentCodestring
Поле parentCode.
WildberriesType32 полей
idinteger · int64
Поле id.
namestring
Название
publishedboolean
Опубликованность предмета Вайлдбериз
hasSizeboolean
Атрибут, указывающий наличие размера
monoBoxMinQuantityinteger · int32
Поле monoBoxMinQuantity.
monoTypestring
Поле monoType.
monoMinPriceinteger · int32
Поле monoMinPrice.
hasParentboolean
Поле hasParent.
parentIdinteger · int64
Поле parentId.
wildberriesIdinteger · int64
Идентификатор предмета на Вайлдбериз
lastSyncDatestring · date-time
Дата последней синхронизации предмета с Вайлдбериз
notChangedDaysinteger · int32
Количество дней, в течение которых данные категории не менялась. Используется для того, чтобы сократить обновление категорий, которые не меняются
commissionnumber · double
Комиссия для товаров данного предмета в Вайлдбериз по FBM
fbsCommissionnumber · double
Комиссия для товаров данного предмета в Вайлдбериз по FBS
fbwCommissionnumber · double
Комиссия по тарифу FBW
dbsCommissionnumber · double
Комиссия по тарифу DBS
edbsCommissionnumber · double
Комиссия по тарифу EDBS
cAndCCommissionnumber · double
Комиссия по тарифу C&C
bookingCommissionnumber · double
Комиссия за бронирование
logisticPriceinteger · int32
Стоимость доставки товара к клиенту на Вайлдбериз
storagePricenumber · double
Стоимость хранения товара на складе Вайлдбериз за штуку в день
acceptancePricenumber · double
Стоимость приемки товара на складе Вайлдбериз за штуку
needDimensionsboolean
Атрибут обязательности габаритов товара, тк стоимость хранения рассчитывается на основе габаритов
purchasePercentAvgnumber · double
Среднее значение процента выкупа. Используется в AI Финдире
purchasePercentMinnumber · double
Минимально допустимое значение процента выкупа. Используется в AI Финдире
photoAvginteger · int32
Среднее кол-во фотографий. Используется в AI Финдире
photoMininteger · int32
Минимально допустимое кол-во фотографий. Используется в AI Финдире
drrAvgnumber · double
Среднее значение ДРР. Используется в AI Финдире
drrMinnumber · double
Минимально допустимое значение ДПП. Используется в AI Финдире
marginAvgnumber · double
Среднее значение маржинальности. Используется в AI Финдире
marginMinnumber · double
Минимально допустимое значение маржинальности. Используется в AI Финдире
candCCommissionnumber · double
Поле candCCommission.
YandexMarketCategory7 полей
idinteger · int64
Поле id.
namestring
Название категории
Обязательно
publishedboolean
Поле published.
parentIdinteger · int64
Поле parentId.
isLeafboolean
Признак листовой категории, в которой могут находиться товары
lastSyncDatestring · date-time
Дата последней синхронизации категории с Озон
notChangedDaysinteger · int32
Количество дней, в течение которых данные категории не менялась. Используется для того, чтобы сократить обновление категорий, которые не меняются
FindResponseQualityDocument1 полей
rowsQualityDocument[]
Строки с результатом поиска
Контракт ошибок
Как API возвращает прикладные ошибки
Код ошибки одинаков для всех локалей, а текст для пользователя переводится сервером. Поэтому бизнес-логику стройте по error, а localMessage используйте только для отображения.
error
Стабильный машинный код ошибки для логики интеграции.
localMessage
Готовое сообщение на языке пользователя API-токена.
params
Значения
文
Язык localMessage определяется полем lang пользователя, которому принадлежит API-токен. Язык страницы документации и заголовок Accept-Language его не переключают; если язык пользователя не указан, используется русский.
RUПользователь с локалью ru
{
"error": "error_brand_already_exists",
"localMessage": "Бренд Base уже существует",
"params": {
"name": "Base"
}
}
Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
401auth_required
Требуется авторизация
Заголовок Authorization отсутствует, пуст или содержит недействительный токен.
400error_access_denied
Недостаточно прав
Токен существует, но его роль не позволяет выполнить операцию.
500error_unknown
Непредвиденная ошибка
Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.
400error_max_upload_size_exceeded
Допустимый размер файла превышен
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_max_upload_size_exceeded; localMessage содержит приведённый выше перевод.
400error_no_client
Клиент не найден или был удален. Напишите в поддержку
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.
400error_quality_document_not_found
Сертификат не найден
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_quality_document_not_found; localMessage содержит приведённый выше перевод.
400error_storage_size_exceeded
Вы превысили лимит на размер хранилища файлов: {limit} Мб
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_storage_size_exceeded; localMessage содержит приведённый выше перевод.
400error_wrong_image_format
Некорректный формат изображения для файла: {name}
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_wrong_image_format; localMessage содержит приведённый выше перевод.
Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
401auth_required
Требуется авторизация
Заголовок Authorization отсутствует, пуст или содержит недействительный токен.
400error_access_denied
Недостаточно прав
Токен существует, но его роль не позволяет выполнить операцию.
500error_unknown
Непредвиденная ошибка
Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.
400error_document_already_exist
Документ с таким именем уже существует
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_document_already_exist; localMessage содержит приведённый выше перевод.
400error_no_client
Клиент не найден или был удален. Напишите в поддержку
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.
400error_quality_document_version_conflict
Документ был изменён другим пользователем. Обновите страницу и попробуйте снова
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_quality_document_version_conflict; localMessage содержит приведённый выше перевод.
POST
Удалить сертификат качества
/api/qualityDocument/removeQualityDocument
Токен с правами записи
Удаляет сертификат качества по идентификатору
Параметры запроса
Поле
Тип
Обязательно
Описание
documentId
integer · int64
Да
Поле documentId.
curl --request POST 'https://api.selsup.ru/api/qualityDocument/removeQualityDocument?documentId=1001' \
--header 'Authorization: YOUR_API_TOKEN'
Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
401auth_required
Требуется авторизация
Заголовок Authorization отсутствует, пуст или содержит недействительный токен.
400error_access_denied
Недостаточно прав
Токен существует, но его роль не позволяет выполнить операцию.
500error_unknown
Непредвиденная ошибка
Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.
400error_no_client
Клиент не найден или был удален. Напишите в поддержку
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.
POST
Удалить изображение сертификата
/api/qualityDocument/deleteQualityDocumentImage
Токен с правами записи
Удаляет изображение сертификата качества
Параметры запроса
Поле
Тип
Обязательно
Описание
imageId
integer · int64
Да
Поле imageId.
curl --request POST 'https://api.selsup.ru/api/qualityDocument/deleteQualityDocumentImage?imageId=1001' \
--header 'Authorization: YOUR_API_TOKEN'
Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
401auth_required
Требуется авторизация
Заголовок Authorization отсутствует, пуст или содержит недействительный токен.
400error_access_denied
Недостаточно прав
Токен существует, но его роль не позволяет выполнить операцию.
500error_unknown
Непредвиденная ошибка
Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.
400error_no_client
Клиент не найден или был удален. Напишите в поддержку
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.
Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
401auth_required
Требуется авторизация
Заголовок Authorization отсутствует, пуст или содержит недействительный токен.
400error_access_denied
Недостаточно прав
Токен существует, но его роль не позволяет выполнить операцию.
500error_unknown
Непредвиденная ошибка
Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.
400error_create_quality_document
Не удалось создать документ качества
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_create_quality_document; localMessage содержит приведённый выше перевод.
400error_document_already_exist
Документ с таким именем уже существует
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_document_already_exist; localMessage содержит приведённый выше перевод.
400error_no_client
Клиент не найден или был удален. Напишите в поддержку
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.
GET
Список сертификатов продукта
/api/qualityDocument/getQualityDocumentByModel
Токен с правами чтения
Позволяет получить сертификаты качества продукта
Параметры запроса
Поле
Тип
Обязательно
Описание
modelId
integer · int64
Да
Поле modelId.
curl --request GET 'https://api.selsup.ru/api/qualityDocument/getQualityDocumentByModel?modelId=1001' \
--header 'Authorization: YOUR_API_TOKEN'
Тип категории для Честного знака. По умолчанию ставится OTHER
wildberriesType
WildberriesType
Нет
Предмет Вайлдбериз. Можно устанавливать либо объект,либо только идентификатор
wildberriesCategoryId
integer · int64
Нет
Идентификатор категории Wildberries, совпадает с ID категории на самом Wildberries
wildberriesFbmCommission
number · double
Нет
Комиссия по тарифу FBM
wildberriesFbwCommission
number · double
Нет
Комиссия по тарифу FBW
wildberriesFbsCommission
number · double
Нет
Комиссия по тарифу FBS
wildberriesDbsCommission
number · double
Нет
Комиссия по тарифу DBS
wildberriesEdbsCommission
number · double
Нет
Комиссия по тарифу EDBS
wildberriesCAndCCommission
number · double
Нет
Комиссия по тарифу C&C
wildberriesBookingCommission
number · double
Нет
Комиссия за бронирование
ozonDescriptionCategoryId
integer · int64
Нет
Идентификатор категории на Ozon. Строится из ID категории + ID типа на Ozon
yandexMarketCategoryId
integer · int64
Нет
Идентификатор категории в Яндекс.Маркет. Совпадает с идентификатором категории на самом Яндекс.Маркет
yandexMarketCategory
YandexMarketCategory
Нет
Категория Яндекс.Маркета. Можно проставлять либо объект, либо только идентификатор
ozonDescriptionCategory
OzonDescriptionCategory
Нет
Категория Озон
ozonCommission
number · double
Нет
Комиссия озона.
tnved
Tnved
Нет
ТНВЭД. Можно проставлять либо объект, либо идентификатор ТНВЭД
tnvedId
integer · int64
Нет
Идентификатор ТНВЭД
laundry
string
Нет
Правила ухода за вещами. Разделяются запятыми
params
string
Нет
JSON значений параметров для категории
namePattern
string
Нет
Шаблон названий категории
aliexpressCategory
AliexpressCategory
Нет
Категория Aliexpress
aliexpressCategoryId
integer · int64
Нет
Идентификатор категории на самом Aliexpress
avitoCategory
AvitoCategory
Нет
Категория Avito
lamodaCategory
LamodaCategory
Нет
Категория Lamoda
lamodaCategoryId
integer · int64
Нет
Идентификатор категории на Lamoda
avitoCategoryId
integer · int64
Нет
Идентификатор категории на Avito
packDepth
integer · int32
Нет
Глубина упаковки в мм. Проставляется всем товарам в категории
packWidth
integer · int32
Нет
Ширина упаковки в мм. Проставляется всем товарам в категории
packHeight
integer · int32
Нет
Высота упаковки в мм. Проставляется всем товарам в категории
packWeight
integer · int32
Нет
Вес упаковки в граммах. Проставляется всем товарам в категории
hasSize
boolean
Нет
Признак разделения товаров в категории по размеру. Меняет вид редактора карточки
hasColor
boolean
Нет
Признак разделения товаров в категории по цвету. Меняет вид редактора карточки
autoName
boolean
Нет
Автоматически формировать названия товаров в категории
removeFbsStock
boolean
Нет
Не передавать остатки товаров по FBS для товаров из этой категории
oneCId
string
Нет
Идентификатор категории в 1С
externalId
string
Нет
Идентификатор категории на сайте
moySkladId
string
Нет
Идентификатор категории в сервисе МойСклад
useClientParams
boolean
Нет
Показывать пользовательские параметры в категории
requiredExpirationDate
boolean
Нет
Является ли срок годности обязательным параметром
productCount
integer · int32
Нет
Количество товаров в категории. Отдается только при withProductCount=true
categoryId
integer · int32
Нет
Поле categoryId.
clientId
integer · int64
Нет
Поле clientId.
images
QualityDocumentImage[]
Нет
Изображения сертификата
Структура элемента массиваQualityDocumentImage
Поле
Тип
Обязательно
Описание
id
integer · int64
Нет
Поле id.
url
string
Нет
Поле url.
position
integer · int32
Нет
Поле position.
documentId
integer · int64
Нет
Поле documentId.
clientId
integer · int64
Нет
Поле clientId.
[
"string"
]
Ошибки4
Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
401auth_required
Требуется авторизация
Заголовок Authorization отсутствует, пуст или содержит недействительный токен.
400error_access_denied
Недостаточно прав
Токен существует, но его роль не позволяет выполнить операцию.
500error_unknown
Непредвиденная ошибка
Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.
400error_no_client
Клиент не найден или был удален. Напишите в поддержку
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.
GET
Получить список сертификатов по фильтру
/api/qualityDocument/findQualityDocument
Токен с правами чтения
Позволяет получить сертификаты по фильтрам: бренд, категория и запрос, который может содержать часть названия или номера
Параметры запроса
Поле
Тип
Обязательно
Описание
brandId
integer · int32
Нет
Поиск по id бренда
categoryId
integer · int32
Нет
Поиск по id категории
query
string
Нет
Поисковый запрос, может содержать часть названия или номера сертификата
limit
integer · int32
Нет
Ограничение на количество записей. Максимальное значение - 500
Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
401auth_required
Требуется авторизация
Заголовок Authorization отсутствует, пуст или содержит недействительный токен.
400error_access_denied
Недостаточно прав
Токен существует, но его роль не позволяет выполнить операцию.
500error_unknown
Непредвиденная ошибка
Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.
400error_no_client
Клиент не найден или был удален. Напишите в поддержку
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.
GET
Получить сертификат качества
/api/quality/document/{documentId}
Токен с правами чтения
Возвращает сертификат качества по идентификатору
Параметры пути
Поле
Тип
Обязательно
Описание
documentId
integer · int64
Да
Поле documentId.
curl --request GET 'https://api.selsup.ru/api/quality/document/1001' \
--header 'Authorization: YOUR_API_TOKEN'
Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
401auth_required
Требуется авторизация
Заголовок Authorization отсутствует, пуст или содержит недействительный токен.
400error_access_denied
Недостаточно прав
Токен существует, но его роль не позволяет выполнить операцию.
500error_unknown
Непредвиденная ошибка
Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.