SelSup Developers

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

Производители

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

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

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

/api/manufacturer

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

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

01

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

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

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

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

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

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

Manufacturer11 полей
manufacturerIdinteger · int32

Идентификатор производителя. Генерируется автоматически

titlestring

Название производителя внешнее для печати

namestring

Название производителя внутреннее

Обязательно
addressstring

Адрес производителя производителя внутреннее

organizationIdinteger · int64

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

clientIdinteger · int64

Идентификатор клиента

read-only
countryIdinteger · int32

Идентификатор страны

countryNamestring

Название страны

read-only
innstring

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

deletedboolean

Если true - производитель удален

oneCIdstring

Идентификатор в 1С

FindResponseManufacturer1 полей
rowsManufacturer[]

Строки с результатом поиска

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

Как 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"
  }
}

Методы

Методы

GET

Информация о производителе

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

Позволяет получить производителя по идентификатору

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

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

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

200
Поля объекта Manufacturer
ПолеТипОбязательноОписание
manufacturerId integer · int32 Нет Идентификатор производителя. Генерируется автоматически
title string Нет Название производителя внешнее для печати
name string Да Название производителя внутреннее
address string Нет Адрес производителя производителя внутреннее
organizationId integer · int64 Нет Связь производителя с организацией - контрагентом
clientId integer · int64 Нет Идентификатор клиента
countryId integer · int32 Нет Идентификатор страны
countryName string Нет Название страны
inn string Нет ИНН производителя, используется в основном для Честного знака
deleted boolean Нет Если true - производитель удален
oneCId string Нет Идентификатор в 1С
{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}
Ошибки6

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

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

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

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

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

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

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

400error_manufacturer_not_found
Не найден производитель: {id}

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

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

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

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

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

PUT

Изменить производителя

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

Позволяет изменить данные о производителе для товаров

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

ПолеТипОбязательноОписание
manufacturerId integer · int64 Да Поле manufacturerId.

Тело запроса

application/json
Поля объектаManufacturer
ПолеТипОбязательноОписание
manufacturerId integer · int32 Нет Идентификатор производителя. Генерируется автоматически
title string Нет Название производителя внешнее для печати
name string Да Название производителя внутреннее
address string Нет Адрес производителя производителя внутреннее
organizationId integer · int64 Нет Связь производителя с организацией - контрагентом
clientId integer · int64 Нет Идентификатор клиента
countryId integer · int32 Нет Идентификатор страны
countryName string Нет Название страны
inn string Нет ИНН производителя, используется в основном для Честного знака
deleted boolean Нет Если true - производитель удален
oneCId string Нет Идентификатор в 1С
curl --request PUT 'https://api.selsup.ru/api/manufacturer/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}'

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

200
Поля объекта Manufacturer
ПолеТипОбязательноОписание
manufacturerId integer · int32 Нет Идентификатор производителя. Генерируется автоматически
title string Нет Название производителя внешнее для печати
name string Да Название производителя внутреннее
address string Нет Адрес производителя производителя внутреннее
organizationId integer · int64 Нет Связь производителя с организацией - контрагентом
clientId integer · int64 Нет Идентификатор клиента
countryId integer · int32 Нет Идентификатор страны
countryName string Нет Название страны
inn string Нет ИНН производителя, используется в основном для Честного знака
deleted boolean Нет Если true - производитель удален
oneCId string Нет Идентификатор в 1С
{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}
Ошибки7

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

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

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

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

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

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

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

400error_empty_manufacturer_name
Не указано название производителя

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

400error_manufacturer_already_exist
Уже существует производитель с названием {name}

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

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

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

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

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

DELETE

Удалить производителя

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

Удаляет производителя или помечает его удаленным

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

ПолеТипОбязательноОписание
manufacturerId integer · int32 Да Поле manufacturerId.

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

ПолеТипОбязательноОписание
deleted boolean Да Поле deleted.
curl --request DELETE 'https://api.selsup.ru/api/manufacturer/1001?deleted=false' \
  --header 'Authorization: YOUR_API_TOKEN'

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

200
"string"
Ошибки3

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

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

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

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

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

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

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

POST

Создать производителя

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

Позволяет добавить нового производителя для товаров

Тело запроса

application/json
Поля объектаManufacturer
ПолеТипОбязательноОписание
manufacturerId integer · int32 Нет Идентификатор производителя. Генерируется автоматически
title string Нет Название производителя внешнее для печати
name string Да Название производителя внутреннее
address string Нет Адрес производителя производителя внутреннее
organizationId integer · int64 Нет Связь производителя с организацией - контрагентом
clientId integer · int64 Нет Идентификатор клиента
countryId integer · int32 Нет Идентификатор страны
countryName string Нет Название страны
inn string Нет ИНН производителя, используется в основном для Честного знака
deleted boolean Нет Если true - производитель удален
oneCId string Нет Идентификатор в 1С
curl --request POST 'https://api.selsup.ru/api/manufacturer' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}'

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

200
Поля объекта Manufacturer
ПолеТипОбязательноОписание
manufacturerId integer · int32 Нет Идентификатор производителя. Генерируется автоматически
title string Нет Название производителя внешнее для печати
name string Да Название производителя внутреннее
address string Нет Адрес производителя производителя внутреннее
organizationId integer · int64 Нет Связь производителя с организацией - контрагентом
clientId integer · int64 Нет Идентификатор клиента
countryId integer · int32 Нет Идентификатор страны
countryName string Нет Название страны
inn string Нет ИНН производителя, используется в основном для Честного знака
deleted boolean Нет Если true - производитель удален
oneCId string Нет Идентификатор в 1С
{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}
Ошибки7

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

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

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

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

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

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

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

400error_empty_manufacturer_name
Не указано название производителя

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

400error_manufacturer_already_exist
Уже существует производитель с названием {name}

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

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

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

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

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

GET

Поиск производителя

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

Позволяет найти производителя для товаров

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

ПолеТипОбязательноОписание
query string Нет Поиск по названию производителя
manufacturerOneCId string Нет Идентификатор производителя в 1С
limit integer · int32 Нет Ограничение на количество записей. Максимальное значение - 500
page integer · int32 Нет Номер страницы начиная с 1
count boolean Нет Возвратить в ответе общее количество записей
sortBy stringMANUFACTURERID, NAME Нет Поле для сортировки
ascending boolean Нет Порядок сортировки - по возрастанию?. Работает только при получении списка.
curl --request GET 'https://api.selsup.ru/api/manufacturer/find?limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

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

200
Поля объекта FindResponseManufacturer
ПолеТипОбязательноОписание
rows Manufacturer[] Нет Строки с результатом поиска
Структура элемента массива Manufacturer
ПолеТипОбязательноОписание
manufacturerId integer · int32 Нет Идентификатор производителя. Генерируется автоматически
title string Нет Название производителя внешнее для печати
name string Да Название производителя внутреннее
address string Нет Адрес производителя производителя внутреннее
organizationId integer · int64 Нет Связь производителя с организацией - контрагентом
clientId integer · int64 Нет Идентификатор клиента
countryId integer · int32 Нет Идентификатор страны
countryName string Нет Название страны
inn string Нет ИНН производителя, используется в основном для Честного знака
deleted boolean Нет Если true - производитель удален
oneCId string Нет Идентификатор в 1С
{
  "rows": "string"
}
Ошибки5

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

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

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

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

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

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

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

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

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

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

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

Authorization

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

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

Попробовать

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

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

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