Модели перечислены отдельно и раскрываются также непосредственно у методов, где они используются.
Receipt14 полей
idinteger · int64
ID чека
read-only
clientIdinteger · int64
ID клиента
read-only
orderIdinteger · int64
ID заказа
read-only
organizationIdinteger · int64
ID организации
read-only
externalReceiptIdstring
ID чека в системе онлайн-кассы
fiscalNumberstring
Фискальный номер документа (ФД), присвоенный ФНС
cashRegisterServicestring
Сервис онлайн-кассы
fnsUrlstring
Ссылка на проверку чека на сайте ФНС
statusstring
Статус чека
receiptTypestring
Тип операции
totalAmountnumber · double
Общая сумма чека
createdDatestring · date-time
Дата создания записи
read-only
completedDatestring · date-time
Дата успешного пробития чека
errorMessagestring
Сообщение об ошибке, если статус FAILED
Контракт ошибок
Как 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
Непредвиденная ошибка
Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.
POST
Создать чек для заказа
/api/receipt/order/{orderId}
Токен с правами записи
Пробивает чек через онлайн-кассу для указанного заказа
Параметры пути
Поле
Тип
Обязательно
Описание
orderId
integer · int64
Да
Поле orderId.
Параметры запроса
Поле
Тип
Обязательно
Описание
typeПо умолчанию: INCOME
stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND
Нет
Поле type.
curl --request POST 'https://api.selsup.ru/api/receipt/order/1001' \
--header 'Authorization: YOUR_API_TOKEN'
Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
401auth_required
Требуется авторизация
Заголовок Authorization отсутствует, пуст или содержит недействительный токен.
400error_access_denied
Недостаточно прав
Токен существует, но его роль не позволяет выполнить операцию.
500error_unknown
Непредвиденная ошибка
Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.
GET
Получить чек по ID
/api/receipt/{receiptId}
Токен с правами чтения
Возвращает детальную информацию о чеке
Параметры пути
Поле
Тип
Обязательно
Описание
receiptId
integer · int64
Да
Поле receiptId.
curl --request GET 'https://api.selsup.ru/api/receipt/1001' \
--header 'Authorization: YOUR_API_TOKEN'
Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
401auth_required
Требуется авторизация
Заголовок Authorization отсутствует, пуст или содержит недействительный токен.
400error_access_denied
Недостаточно прав
Токен существует, но его роль не позволяет выполнить операцию.
500error_unknown
Непредвиденная ошибка
Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.
GET
Обновить статус чека
/api/receipt/{receiptId}/update
Токен с правами чтения
Запрашивает актуальный статус чека у онлайн-кассы
Параметры пути
Поле
Тип
Обязательно
Описание
receiptId
integer · int64
Да
Поле receiptId.
curl --request GET 'https://api.selsup.ru/api/receipt/1001/update' \
--header 'Authorization: YOUR_API_TOKEN'
Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
401auth_required
Требуется авторизация
Заголовок Authorization отсутствует, пуст или содержит недействительный токен.
400error_access_denied
Недостаточно прав
Токен существует, но его роль не позволяет выполнить операцию.
500error_unknown
Непредвиденная ошибка
Внутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.