Модели перечислены отдельно и раскрываются также непосредственно у методов, где они используются.
Hypothesis14 полей
idinteger · int32
Поле id.
namestring
Название гипотезы
previousStartDatestring · date-time
Начало предыдущего периода для сравнения
startDatestring · date-time
Дата начала гипотезы
endDatestring · date-time
Дата окончания гипотезы
modelIdinteger · int64
Модель, в которой создана гипотеза
modelArticlestring
Артикул модели, в которой создана гипотеза
viewIdinteger · int64
Идентификатор цвета
productIdinteger · int64
Идентификатор товара
organizationIdinteger · int64
Идентификатор организации
createdDatestring · date-time
Дата создания
createdUserstring
Логин пользователя, создавшего гипотезу
servicestring
Маркетплейс, на котором проверяем гипотезу
successStatusstring
Статус
FindResponseHypothesis1 полей
rowsHypothesis[]
Строки с результатом поиска
Контракт ошибок
Как 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_empty_end_date
Не указана дата окончания
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_end_date; localMessage содержит приведённый выше перевод.
400error_empty_name
Не указано название
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_name; localMessage содержит приведённый выше перевод.
400error_empty_start_date
Не указана дата начала
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_start_date; localMessage содержит приведённый выше перевод.
400error_end_less_then_start_date
Дата окончания должна быть больше даты начала
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_end_less_then_start_date; localMessage содержит приведённый выше перевод.
400error_no_client
Клиент не найден или был удален. Напишите в поддержку
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.
GET
Получить гипотезу
/api/hypothesis/{id}
Токен с правами чтения
Позволяет получить гипотезу по ID
Параметры пути
Поле
Тип
Обязательно
Описание
id
integer · int32
Да
Поле id.
curl --request GET 'https://api.selsup.ru/api/hypothesis/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_empty_end_date
Не указана дата окончания
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_end_date; localMessage содержит приведённый выше перевод.
400error_empty_id
Не указан идентификатор
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_id; localMessage содержит приведённый выше перевод.
400error_empty_name
Не указано название
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_name; localMessage содержит приведённый выше перевод.
400error_empty_start_date
Не указана дата начала
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_start_date; localMessage содержит приведённый выше перевод.
400error_end_less_then_start_date
Дата окончания должна быть больше даты начала
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_end_less_then_start_date; localMessage содержит приведённый выше перевод.
400error_no_client
Клиент не найден или был удален. Напишите в поддержку
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.
Прикладные ошибки обычно возвращаются как 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_no_client
Клиент не найден или был удален. Напишите в поддержку
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.