Модели перечислены отдельно и раскрываются также непосредственно у методов, где они используются.
ProductTag3 полей
idinteger · int64
Идентификатор метки
read-only
namestring
Название метки
Обязательно
clientIdinteger · int64
Идентификатор клиента
read-only
FindResponseProductTag1 полей
rowsProductTag[]
Строки с результатом поиска
FindResponseProductTagInfo1 полей
rowsProductTagInfo[]
Строки с результатом поиска
ProductTagInfo2 полей
productIdinteger · int64
Поле productId.
productTagsProductTag[]
Поле productTags.
Контракт ошибок
Как 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_no_client
Клиент не найден или был удален. Напишите в поддержку
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.
400error_tag_id_and_name_required
Требуются id и имя тега
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_tag_id_and_name_required; localMessage содержит приведённый выше перевод.
400error_tag_id_required
Требуется id тега
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_tag_id_required; localMessage содержит приведённый выше перевод.
400error_tag_update_failed
Не удалось обновить тег с id: {0}
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_tag_update_failed; localMessage содержит приведённый выше перевод.
DELETE
Удаление тэга товара
/api/tag/{tagId}
Токен с правами записи
Удаляет тэг по идентификатору. Тэг отвязывается от всех товаров.
Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
401auth_required
Требуется авторизация
Заголовок Authorization отсутствует, пуст или содержит недействительный токен.
400error_access_denied
Недостаточно прав
Токен существует, но его роль не позволяет выполнить операцию.
500error_unknown
Непредвиденная ошибка
Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.
PUT
Привязать тэг к продукту
/api/tag/product/{tagId}/{productId}
Токен с правами записи
Привязывает указанный тэг к продукту по их идентификаторам.
Параметры пути
Поле
Тип
Обязательно
Описание
tagId
integer · int64
Да
Поле tagId.
productId
integer · int64
Да
Поле productId.
curl --request PUT 'https://api.selsup.ru/api/tag/product/1001/1001' \
--header 'Authorization: YOUR_API_TOKEN'
Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
401auth_required
Требуется авторизация
Заголовок Authorization отсутствует, пуст или содержит недействительный токен.
400error_access_denied
Недостаточно прав
Токен существует, но его роль не позволяет выполнить операцию.
500error_unknown
Непредвиденная ошибка
Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.
400error_duplicate_tag_association
Тег уже привязан к продукту
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_duplicate_tag_association; localMessage содержит приведённый выше перевод.
400error_no_client
Клиент не найден или был удален. Напишите в поддержку
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.
400error_tag_and_product_id_required
требуется тег и ID продукта
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_tag_and_product_id_required; localMessage содержит приведённый выше перевод.
DELETE
Отвязать тэг от продукта
/api/tag/product/{tagId}/{productId}
Токен с правами записи
Удаляет связь между тэгом и продуктом по их идентификаторам.
Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
401auth_required
Требуется авторизация
Заголовок Authorization отсутствует, пуст или содержит недействительный токен.
400error_access_denied
Недостаточно прав
Токен существует, но его роль не позволяет выполнить операцию.
500error_unknown
Непредвиденная ошибка
Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.
400error_no_client
Клиент не найден или был удален. Напишите в поддержку
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.
400error_tag_and_model_id_required
Требуются id тега и id модели
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_tag_and_model_id_required; localMessage содержит приведённый выше перевод.
PUT
Привязать тэг ко всем товарам модели
/api/tag/model/{tagId}/{modelId}
Токен с правами записи
Привязывает указанный тэг ко всем продуктам модели.
Параметры пути
Поле
Тип
Обязательно
Описание
tagId
integer · int64
Да
Поле tagId.
modelId
integer · int64
Да
Поле modelId.
curl --request PUT 'https://api.selsup.ru/api/tag/model/1001/1001' \
--header 'Authorization: YOUR_API_TOKEN'
Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
401auth_required
Требуется авторизация
Заголовок Authorization отсутствует, пуст или содержит недействительный токен.
400error_access_denied
Недостаточно прав
Токен существует, но его роль не позволяет выполнить операцию.
500error_unknown
Непредвиденная ошибка
Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.
400error_duplicate_tag_association
Тег уже привязан к продукту
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_duplicate_tag_association; localMessage содержит приведённый выше перевод.
400error_no_client
Клиент не найден или был удален. Напишите в поддержку
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.
400error_tag_and_model_id_required
Требуются id тега и id модели
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_tag_and_model_id_required; localMessage содержит приведённый выше перевод.
DELETE
Отвязать тэг от всех товаров модели
/api/tag/model/{tagId}/{modelId}
Токен с правами записи
Удаляет связь между тэгом и всеми продуктами модели.
Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
401auth_required
Требуется авторизация
Заголовок Authorization отсутствует, пуст или содержит недействительный токен.
400error_access_denied
Недостаточно прав
Токен существует, но его роль не позволяет выполнить операцию.
500error_unknown
Непредвиденная ошибка
Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.
400error_no_client
Клиент не найден или был удален. Напишите в поддержку
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.
400error_tag_and_model_id_required
Требуются id тега и id модели
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_tag_and_model_id_required; localMessage содержит приведённый выше перевод.
POST
Создание тэга товара
/api/tag
Токен с правами записи
Создаёт новый тэг для товаров клиента. Имя тэга должно быть уникальным в рамках клиента.
Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
401auth_required
Требуется авторизация
Заголовок Authorization отсутствует, пуст или содержит недействительный токен.
400error_access_denied
Недостаточно прав
Токен существует, но его роль не позволяет выполнить операцию.
500error_unknown
Непредвиденная ошибка
Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.
400error_duplicate_tag_name
Тег с таким именем уже существует: {0}
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_duplicate_tag_name; localMessage содержит приведённый выше перевод.
400error_no_client
Клиент не найден или был удален. Напишите в поддержку
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.
400error_tag_name_required
Требуется имя тега
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_tag_name_required; localMessage содержит приведённый выше перевод.
GET
Поиск и фильтрация тегов
/api/tag/find
Токен с правами чтения
Возвращает список тегов с поддержкой фильтрации, сортировки и пагинации.
Параметры запроса
Поле
Тип
Обязательно
Описание
query
string
Нет
Запрос на поиск тега
productId
integer · int64
Нет
Идентификатор продукта
limit
integer · int32
Нет
Ограничение на количество записей. Максимальное значение - 500
page
integer · int32
Нет
Номер страницы начиная с 1
count
boolean
Нет
Возвратить в ответе общее количество записей
sortBy
stringID, NAME
Нет
Поле для сортировки
ascending
boolean
Нет
Порядок сортировки - по возрастанию?. Работает только при получении списка.
curl --request GET 'https://api.selsup.ru/api/tag/find?limit=50&page=1' \
--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 содержит приведённый выше перевод.
GET
Получить теги товаров по id модели
/api/tag/find/{modelId}
Токен с правами чтения
Возвращает список объектов,в которых сопоставляются id продукта и его теги
Параметры пути
Поле
Тип
Обязательно
Описание
modelId
integer · int64
Да
Поле modelId.
curl --request GET 'https://api.selsup.ru/api/tag/find/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 содержит приведённый выше перевод.