Модели перечислены отдельно и раскрываются также непосредственно у методов, где они используются.
Job11 полей
idinteger · int32
Поле id.
namestring
Поле name.
categoryClassstring
Группы категорий Честного знака
clientIdinteger · int64
Поле clientId.
deletedboolean
Поле deleted.
positionIdinteger · int64
Поле positionId.
versionIdinteger · int64
Поле versionId.
createdUserstring
Поле createdUser.
createdDatestring · date-time
Поле createdDate.
pricenumber · double
Поле price.
tariffsJobTariff[]
Поле tariffs.
JobTariff8 полей
idinteger · int64
Поле id.
jobIdinteger · int32
Поле jobId.
pricenumber · double
Поле price.
brandIdinteger · int32
Поле brandId.
categoryClassstring
Группы категорий Честного знака
categoryIdinteger · int32
Поле categoryId.
priorityinteger · int32
Поле priority.
productIdinteger · int64
Поле productId.
Контракт ошибок
Как 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_category_class
Не указан класс
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_category_class; localMessage содержит приведённый выше перевод.
400error_empty_job_price
Не указана цена для выполнения работы
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_job_price; localMessage содержит приведённый выше перевод.
400error_empty_position
Не указана должность
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_position; localMessage содержит приведённый выше перевод.
400error_empty_tariff_price
Не указана цена для тарифа №{position}
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_tariff_price; localMessage содержит приведённый выше перевод.
400error_empty_tariff_priority
Не указан приоритет для тарифа
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_tariff_priority; localMessage содержит приведённый выше перевод.
400error_empty_tariffs
Не указаны тарифы
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_tariffs; localMessage содержит приведённый выше перевод.
400error_job_already_exists
Задание с названием {jobName} уже существует
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_job_already_exists; localMessage содержит приведённый выше перевод.
400error_job_modified
Данные о работе уже обновлены. Обновите страницу.
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_job_modified; localMessage содержит приведённый выше перевод.
400error_job_tariff_wrong_product_id
Некорректно указан идентификатор товара: {id}
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_job_tariff_wrong_product_id; localMessage содержит приведённый выше перевод.
400error_no_client
Клиент не найден или был удален. Напишите в поддержку
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.
400error_subscription_expired
У вас закончился срок действия тарифа. Оплатите тариф для продолжения использования сервиса.
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_subscription_expired; localMessage содержит приведённый выше перевод.
Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
401auth_required
Требуется авторизация
Заголовок Authorization отсутствует, пуст или содержит недействительный токен.
400error_access_denied
Недостаточно прав
Токен существует, но его роль не позволяет выполнить операцию.
500error_unknown
Непредвиденная ошибка
Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.
400error_job_modified
Данные о работе уже обновлены. Обновите страницу.
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_job_modified; localMessage содержит приведённый выше перевод.
400error_no_client
Клиент не найден или был удален. Напишите в поддержку
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.
400error_subscription_expired
У вас закончился срок действия тарифа. Оплатите тариф для продолжения использования сервиса.
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_subscription_expired; localMessage содержит приведённый выше перевод.
Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
401auth_required
Требуется авторизация
Заголовок Authorization отсутствует, пуст или содержит недействительный токен.
400error_access_denied
Недостаточно прав
Токен существует, но его роль не позволяет выполнить операцию.
500error_unknown
Непредвиденная ошибка
Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.
400error_empty_category_class
Не указан класс
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_category_class; localMessage содержит приведённый выше перевод.
400error_empty_job_price
Не указана цена для выполнения работы
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_job_price; localMessage содержит приведённый выше перевод.
400error_empty_position
Не указана должность
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_position; localMessage содержит приведённый выше перевод.
400error_empty_tariff_price
Не указана цена для тарифа №{position}
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_tariff_price; localMessage содержит приведённый выше перевод.
400error_empty_tariff_priority
Не указан приоритет для тарифа
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_tariff_priority; localMessage содержит приведённый выше перевод.
400error_empty_tariffs
Не указаны тарифы
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_tariffs; localMessage содержит приведённый выше перевод.
400error_job_already_exists
Задание с названием {jobName} уже существует
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_job_already_exists; localMessage содержит приведённый выше перевод.
400error_job_tariff_wrong_product_id
Некорректно указан идентификатор товара: {id}
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_job_tariff_wrong_product_id; localMessage содержит приведённый выше перевод.
400error_no_client
Клиент не найден или был удален. Напишите в поддержку
Персональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.