HW cloud API v1

Справка

Коды ошибок

Ошибка — HTTP 4xx или 5xx и application/problem+json (RFC 9457) с машинным кодом в поле code: ветвитесь по нему, не по тексту.

Формат ошибки

problem+json
{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "Касса 42 не найдена",
  "code": "DEVICE_NOT_FOUND"
}

Коды

HTTPcodeКогда
400INVALID_REQUESTНеверный JSON или параметры; что не так — в detail
401UNAUTHORIZEDНет или неверный X-Api-Key
402TRIAL_LIMITПробный тариф: чеков в этом месяце больше лимита — подключите подписку в кабинете
403FORBIDDENДействие недоступно этому ключу
403KEY_READ_ONLYКлюч или вход «только чтение»: изменения касс, команды, прокси (кроме GET) и чеки недоступны
403DEVICE_DISABLEDКасса выключена в аккаунте (PATCH /api/v1/devices/{id} disabled=true): команды и прокси ей не передаются; для чека — 409
404DEVICE_NOT_FOUNDКассы нет или она принадлежит другому аккаунту
404NOT_FOUNDНет чека или адреса
409IDEMPOTENCY_KEY_REUSEDКлюч уже использован для другого чека
429RATE_LIMITEDЛимит запросов к агентам — подождите Retry-After
503NOT_CONNECTEDКасса не на связи (команда или прокси); Retry-After — когда повторить
504TIMEOUTКасса не ответила — повторите с тем же ключом идемпотентности

Ошибки прокси к API агента (/agent/api/v1/** и команды) приходят ещё и с заголовком X-Hw-Proxy-Error — см. API агента → Через облако.