SelSup Developers

Публичный API · Справочник API

Настройки

Получение и изменение настроек SelSup.

Методы: 3/api/propertyСтабильныйСпецификация OpenAPI ↗
{ }

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

/api/property

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

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

Поля объектов, которые используются в запросах и ответах этого раздела.

Property6 полей
organizationIdinteger · int64

Идентификатор организации

clientIdinteger · int64

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

read-only
componentstring

Компонент для настройки

namestring

Название свойства. Пример для МойСклад: контрагент "contractor.Ozon"; договор "contract.WB"; проект: "project.WILDBERRIES" (для всех); "project.WILDBERRIES.FBO" (тип FBO); "project.WILDBERRIES.FBO.express" (FBO экспресс); "project.WILDBERRIES.FBO.dbs" (FBO DBS); "project.WILDBERRIES.FBO.express.dbs" (FBO экспресс DBS)

valuestring

Значение свойства

valueNamestring

Название значения - в случае когда в value передается ID

Ошибки

Обработка ошибок

При ошибке API возвращает её код в поле error и сообщение на языке пользователя в localMessage. Проверяйте код error в программе, а localMessage показывайте пользователю.

error

Код ошибки для обработки в программе.

localMessage

Сообщение на языке пользователя, которому принадлежит токен.

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"
  }
}

Методы

Методы

PUT

Изменить настройки

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

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

Тело запроса

application/json
Поля объектаProperty
ПолеТипОбязательноОписание
organizationId integer · int64 Нет Идентификатор организации
clientId integer · int64 Нет Идентификатор клиента
component string Нет Компонент для настройки
name string Нет Название свойства. Пример для МойСклад: контрагент "contractor.Ozon"; договор "contract.WB"; проект: "project.WILDBERRIES" (для всех); "project.WILDBERRIES.FBO" (тип FBO); "project.WILDBERRIES.FBO.express" (FBO экспресс); "project.WILDBERRIES.FBO.dbs" (FBO DBS); "project.WILDBERRIES.FBO.express.dbs" (FBO экспресс DBS)
value string Нет Значение свойства
valueName string Нет Название значения - в случае когда в value передается ID
curl --request PUT 'https://api.selsup.ru/api/property/' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "organizationId": 1001,
  "clientId": 1001,
  "component": "string",
  "name": "Example",
  "value": "string",
  "valueName": "Example"
}'

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

200

Тело ответа пустое.

Ошибки7

При ошибке проверьте HTTP-статус и тело ответа. Поле error содержит код ошибки, localMessage — сообщение для пользователя, params — дополнительные сведения. Обработка ошибок ↑

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

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

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

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

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

Не удалось выполнить запрос из-за внутренней ошибки. Если запрос изменял данные, проверьте результат перед повторной отправкой. Для обращения в поддержку сохраните время запроса и полученный ответ.

400error_cant_extract_tariffs
Не удается получить тарифы. Напишите в поддержку

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

400error_invalid_currency_source
Указанный источник курса валют не поддерживается

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

400error_invalid_stock_distribution_rules
Некорректные правила распределения остатков: проверьте доли от 0 до 1 и границы остатка.

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

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

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

GET

Получение настроек

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

Получает сохраненные настройки для компонента

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

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

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

200
"string"
Ошибки32

При ошибке проверьте HTTP-статус и тело ответа. Поле error содержит код ошибки, localMessage — сообщение для пользователя, params — дополнительные сведения. Обработка ошибок ↑

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

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

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

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

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

Не удалось выполнить запрос из-за внутренней ошибки. Если запрос изменял данные, проверьте результат перед повторной отправкой. Для обращения в поддержку сохраните время запроса и полученный ответ.

400error_base_creating
Ваш кабинет в процессе создания, подождите несколько минут до полного создания кабинета

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

400error_cant_extract_tariffs
Не удается получить тарифы. Напишите в поддержку

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

400error_cant_receive_stocks
не удалось получить остатки

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

400error_client_branding_failed
Не удалось загрузить или сохранить настройки брендирования.

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

400error_fbs_marking_code_unsupported
Fbs marking code unsupported

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

400error_fulfillment_client_access_denied
Нет доступа к данным клиента фулфилмента

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

400error_fulfillment_client_contract_required
Примите договор, чтобы получить доступ к операциям.

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

400error_fulfillment_request_invalid
Fulfillment request invalid

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

400error_header_logo_upload_failed
Не удалось загрузить логотип. Попробуйте еще раз.

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

400error_income_not_found
Не найден заказ поставщика №{id}

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

400error_integration_cell_mapping_invalid
Integration cell mapping invalid

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

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

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

400error_no_price_for_order_product
Не указана цена для товара: {name}

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

400error_no_quantity_for_order_product
Не указано количество товара: {name}

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

400error_order_not_found
Заказ не найден

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

400error_organization_create_failed
Возникла проблема при создании организации. Пожалуйста, обратитесь в поддержку

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

400error_organization_exists
Организация уже создана

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

400error_organization_not_found
Не найдена организация

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

400error_ozon_fbo_workflow_not_found
Процесс Ozon FBO {id} не найден

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

400error_reload
Сессия авторизации истекла, обновите страницу браузера. Если обновление не помогает попробуйте удалить файлы cookie для сайта

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

400error_settlement_invalid
Settlement invalid

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

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

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

400error_supply_not_found
Не найдена поставка: {name}

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

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

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

400error_transport_waybill_invalid
Проверьте данные ЭТрН.

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

400error_transport_waybill_source
ЭТрН недоступна для этой отгрузки или поставки.

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

400error_user_does_not_have_this_organization
У пользователя нет доступа к данной организации

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

400error_warehouse_not_found
Не найден склад

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

400error_warehouse_setup_unavailable
Warehouse setup unavailable

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

GET

Список настроек

/api/property/list/{component}
Токен с правами чтения

Получает список сохраненных настроек для компонента

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

ПолеТипОбязательноОписание
component string Да Поле component.

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

ПолеТипОбязательноОписание
organizationId integer · int64 Нет Поле organizationId.
curl --request GET 'https://api.selsup.ru/api/property/list/string' \
  --header 'Authorization: YOUR_API_TOKEN'

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

200
Структура элемента массива Property[]
ПолеТипОбязательноОписание
organizationId integer · int64 Нет Идентификатор организации
clientId integer · int64 Нет Идентификатор клиента
component string Нет Компонент для настройки
name string Нет Название свойства. Пример для МойСклад: контрагент "contractor.Ozon"; договор "contract.WB"; проект: "project.WILDBERRIES" (для всех); "project.WILDBERRIES.FBO" (тип FBO); "project.WILDBERRIES.FBO.express" (FBO экспресс); "project.WILDBERRIES.FBO.dbs" (FBO DBS); "project.WILDBERRIES.FBO.express.dbs" (FBO экспресс DBS)
value string Нет Значение свойства
valueName string Нет Название значения - в случае когда в value передается ID
[
  "string"
]
Ошибки34

При ошибке проверьте HTTP-статус и тело ответа. Поле error содержит код ошибки, localMessage — сообщение для пользователя, params — дополнительные сведения. Обработка ошибок ↑

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

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

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

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

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

Не удалось выполнить запрос из-за внутренней ошибки. Если запрос изменял данные, проверьте результат перед повторной отправкой. Для обращения в поддержку сохраните время запроса и полученный ответ.

400error_bad_request
Некорретный формат запроса

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

400error_base_creating
Ваш кабинет в процессе создания, подождите несколько минут до полного создания кабинета

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

400error_cabinet_access_denied
Доступ к этому кабинету недоступен.

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

400error_cant_extract_tariffs
Не удается получить тарифы. Напишите в поддержку

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

400error_container_log_read_failed
Container log read failed

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

400error_container_log_request_invalid
Container log request invalid

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

400error_empty_first_name
Не указано Имя

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

400error_empty_last_name
Не указана Фамилия

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

400error_empty_organization_form
не указана форма организации

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

400error_empty_organization_inn
Не указан ИНН организации

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

400error_empty_organization_name
Не указано название организации

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

400error_empty_position_name
Не указано название должности

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

400error_fulfillment_client_access_denied
Нет доступа к данным клиента фулфилмента

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

400error_fulfillment_client_contract_required
Примите договор, чтобы получить доступ к операциям.

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

400error_fulfillment_document_error
Не удалось сформировать документ. Проверьте параметры и состав операции.

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

400error_fulfillment_request_invalid
Fulfillment request invalid

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

400error_income_not_found
Не найден заказ поставщика №{id}

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

400error_max_page
Номер страницы не может быть больше 100 000

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

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

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

400error_no_price_for_order_product
Не указана цена для товара: {name}

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

400error_no_quantity_for_order_product
Не указано количество товара: {name}

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

400error_order_not_found
Заказ не найден

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

400error_organization_create_failed
Возникла проблема при создании организации. Пожалуйста, обратитесь в поддержку

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

400error_organization_exists
Организация уже создана

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

400error_position_exists
Должность с таким названием уже существует

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

400error_reload
Сессия авторизации истекла, обновите страницу браузера. Если обновление не помогает попробуйте удалить файлы cookie для сайта

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

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

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

400error_warehouse_not_found
Не найден склад

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

400error_wrong_crm_token
Неверный токен CRM

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

400error_wrong_inn
Некорректно указан ИНН организации, длина 10 или 12 цифр

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

400error_wrong_version
Неправильно указана версия

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

Authorization

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

Получить токен

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

Попробовать

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

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

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