Введение
Публичный API Rosta.
API находится на стадии alpha-тестирования.
Аутентификация
Для аутентификации необходимо отправлять заголовок Authorization со значением "Bearer {API_KEY}".
Инфраструктура
# Торговые точки
API для работы со справочником торговых точек.
# Список торговых точек
Ответ
Поля ответа
data
object
id
string
ID торговой точки.
name
string
Название торговой точки.
doc_prefix
string
Префикс документов.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": [
{
"id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"name": "Магазин \"Clothes\" ",
"doc_prefix": "",
"warehouse_id": "62f8ec81-5cf6-4072-bd89-cfd033454f0e",
"updated_at": "2026-03-12 07:30:49.848214"
},
{
"id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"name": "Магазин \"Clothes\" ",
"doc_prefix": "",
"warehouse_id": "62f8ec81-5cf6-4072-bd89-cfd033454f0e",
"updated_at": "2026-03-12 07:30:49.848214"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Показать торговую точку
Ответ
Поля ответа
data
object
id
string
ID торговой точки.
name
string
Название торговой точки.
service
integer
Процент наценки.
discount
integer
Процент скидки.
address
string
Адрес торговой точки.
doc_prefix
string
Префикс документов.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": {
"id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"name": "Магазин \"Clothes\" ",
"service": 0,
"discount": 0,
"address": "",
"doc_prefix": "",
"updated_at": "2026-03-12 07:30:49.848214",
"warehouse": {
"id": "62f8ec81-5cf6-4072-bd89-cfd033454f0e",
"name": "Магазин "
}
}
}
# Рабочие места
API для работы со справочником рабочих мест.
# Список групп рабочих мест
Ответ
Пример ответа
{
"data": [
{
"id": null,
"name": null,
"updated_at": null,
"tradepoint_id": null
},
{
"id": null,
"name": null,
"updated_at": null,
"tradepoint_id": null
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Показать группу рабочих мест
Ответ
Пример ответа
{
"data": {
"id": null,
"name": null,
"updated_at": null,
"tradepoint": null
}
}
# Список рабочих мест
Ответ
Поля ответа
data
object
id
string
ID рабочего места.
name
string
Название рабочего места.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": [
{
"id": "9bd9df84-3ee9-414b-aed9-cba86ed235f3",
"name": "Kassa",
"parent_id": null,
"cashbox_id": "af909040-eee2-4fb4-b090-8acee5cdad14",
"tradepoint_id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"updated_at": "2026-03-12 07:30:49.865969"
},
{
"id": "9bd9df84-3ee9-414b-aed9-cba86ed235f3",
"name": "Kassa",
"parent_id": null,
"cashbox_id": "af909040-eee2-4fb4-b090-8acee5cdad14",
"tradepoint_id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"updated_at": "2026-03-12 07:30:49.865969"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Показать рабочее место
Ответ
Поля ответа
data
object
id
string
ID рабочего места.
name
string
Название рабочего места.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": {
"id": "9bd9df84-3ee9-414b-aed9-cba86ed235f3",
"name": "Kassa",
"updated_at": "2026-03-12 07:30:49.865969",
"cashbox": {
"id": "af909040-eee2-4fb4-b090-8acee5cdad14",
"name": "Касса"
},
"parent": null,
"tradepoint": {
"id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"name": "Магазин \"Clothes\" "
}
}
}
# Склады
API для работы со справочником складов.
# Список складов
Ответ
Поля ответа
data
object
id
string
ID склада.
name
string
Название склада.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": [
{
"id": "62f8ec81-5cf6-4072-bd89-cfd033454f0e",
"name": "Магазин ",
"tradepoint_id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"updated_at": "2026-03-12T07:30:49.841854Z"
},
{
"id": "62f8ec81-5cf6-4072-bd89-cfd033454f0e",
"name": "Магазин ",
"tradepoint_id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"updated_at": "2026-03-12T07:30:49.841854Z"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Создать склад
Ответ
Поля ответа
data
object
id
string
ID склада.
name
string
Название склада.
is_limit
boolean
Ограничены ли продажи.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": {
"id": "62f8ec81-5cf6-4072-bd89-cfd033454f0e",
"name": "Магазин ",
"is_limit": false,
"updated_at": "2026-03-12T07:30:49.841854Z",
"tradepoint": {
"id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"name": "Магазин \"Clothes\" "
}
}
}
# Показать склад
Ответ
Поля ответа
data
object
id
string
ID склада.
name
string
Название склада.
is_limit
boolean
Ограничены ли продажи.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": {
"id": "62f8ec81-5cf6-4072-bd89-cfd033454f0e",
"name": "Магазин ",
"is_limit": false,
"updated_at": "2026-03-12T07:30:49.841854Z",
"tradepoint": {
"id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"name": "Магазин \"Clothes\" "
}
}
}
# Редактировать склад
Ответ
Поля ответа
data
object
id
string
ID склада.
name
string
Название склада.
is_limit
boolean
Ограничены ли продажи.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": {
"id": "62f8ec81-5cf6-4072-bd89-cfd033454f0e",
"name": "Магазин ",
"is_limit": false,
"updated_at": "2026-03-12T07:30:49.841854Z",
"tradepoint": {
"id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"name": "Магазин \"Clothes\" "
}
}
}
# Удалить склад
# Остатки склада
Ответ
Поля ответа
data
object
id
string
ID склада.
name
string
Название склада.
is_limit
boolean
Ограничены ли продажи.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": {
"id": "62f8ec81-5cf6-4072-bd89-cfd033454f0e",
"name": "Магазин ",
"is_limit": false,
"updated_at": "2026-03-12T07:30:49.841854Z",
"tradepoint": {
"id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"name": "Магазин \"Clothes\" "
}
}
}
# Помещения
API для работы со справочником помещений.
# Список помещений
Ответ
Поля ответа
data
object
id
string
ID помещения.
name
string
Название помещения.
parent_id
ID родительского помещения.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": [
{
"id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"name": "Магазин \"Clothes\" ",
"parent_id": null,
"is_tradepoint": true,
"updated_at": "2026-03-12 07:32:35.577666"
},
{
"id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"name": "Магазин \"Clothes\" ",
"parent_id": null,
"is_tradepoint": true,
"updated_at": "2026-03-12 07:32:35.577666"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Создать помещение
Ответ
Поля ответа
data
object
id
string
ID помещения.
name
string
Название помещения.
updated_at
string
Дата последнего обновления.
parent
object
id
ID родительского помещения.
name
Название родительского помещения.
Пример ответа
{
"data": {
"id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"name": "Магазин \"Clothes\" ",
"is_tradepoint": true,
"updated_at": "2026-03-12 07:32:35.577666",
"parent": null
}
}
# Показать помещение
Ответ
Поля ответа
data
object
id
string
ID помещения.
name
string
Название помещения.
updated_at
string
Дата последнего обновления.
parent
object
id
ID родительского помещения.
name
Название родительского помещения.
Пример ответа
{
"data": {
"id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"name": "Магазин \"Clothes\" ",
"is_tradepoint": true,
"updated_at": "2026-03-12 07:32:35.577666",
"parent": null
}
}
# Редактировать помещение
Ответ
Поля ответа
data
object
id
string
ID помещения.
name
string
Название помещения.
updated_at
string
Дата последнего обновления.
parent
object
id
ID родительского помещения.
name
Название родительского помещения.
Пример ответа
{
"data": {
"id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"name": "Магазин \"Clothes\" ",
"is_tradepoint": true,
"updated_at": "2026-03-12 07:32:35.577666",
"parent": null
}
}
# Удалить помещение
# Столы
API для работы со справочником столов.
# Список столов
Ответ
Поля ответа
data
object
id
string
ID стола.
name
string
Название стола.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": [
{
"id": "e1d2a19a-e565-4c4a-a80c-118602d41f72",
"name": "Стол 7",
"room_id": "a4965983-d869-42bf-8c23-6b3027cd304d",
"updated_at": "2026-03-12 07:30:59.644310"
},
{
"id": "e1d2a19a-e565-4c4a-a80c-118602d41f72",
"name": "Стол 7",
"room_id": "a4965983-d869-42bf-8c23-6b3027cd304d",
"updated_at": "2026-03-12 07:30:59.644310"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Создать стол
Ответ
Поля ответа
Пример ответа
{
"data": {
"id": "e1d2a19a-e565-4c4a-a80c-118602d41f72",
"name": "Стол 7",
"full_name": "Терраса/Стол 7",
"service": null,
"discount": null,
"updated_at": "2026-03-12 07:30:59.644310",
"room": {
"id": "a4965983-d869-42bf-8c23-6b3027cd304d",
"name": "Терраса"
}
}
}
# Показать стол
Ответ
Поля ответа
Пример ответа
{
"data": {
"id": "e1d2a19a-e565-4c4a-a80c-118602d41f72",
"name": "Стол 7",
"full_name": "Терраса/Стол 7",
"service": null,
"discount": null,
"updated_at": "2026-03-12 07:30:59.644310",
"room": {
"id": "a4965983-d869-42bf-8c23-6b3027cd304d",
"name": "Терраса"
}
}
}
# Редактировать стол
Ответ
Поля ответа
Пример ответа
{
"data": {
"id": "e1d2a19a-e565-4c4a-a80c-118602d41f72",
"name": "Стол 7",
"full_name": "Терраса/Стол 7",
"service": null,
"discount": null,
"updated_at": "2026-03-12 07:30:59.644310",
"room": {
"id": "a4965983-d869-42bf-8c23-6b3027cd304d",
"name": "Терраса"
}
}
}
# Удалить стол
# Кассы
API для работы со справочником касс.
# Список касс
Ответ
Поля ответа
data
object
id
string
ID кассы.
name
string
Название кассы.
type
integer
Тип кассы.
-1— Неизвестно0— Стандартная1— Webkassa2— Trinity3— E-Kassa4— Kaspi Касса5— Multikassa
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": [
{
"id": "af909040-eee2-4fb4-b090-8acee5cdad14",
"name": "Касса",
"type": 0,
"tradepoint_id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"updated_at": "2026-03-12T07:30:49.853993Z"
},
{
"id": "af909040-eee2-4fb4-b090-8acee5cdad14",
"name": "Касса",
"type": 0,
"tradepoint_id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"updated_at": "2026-03-12T07:30:49.853993Z"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Создать кассу
Ответ
Поля ответа
data
object
id
string
ID кассы.
name
string
Название кассы.
updated_at
string
Дата последнего обновления.
type
object
value
Тип кассы.
-1— Неизвестно0— Стандартная1— Webkassa2— Trinity3— E-Kassa4— Kaspi Касса5— Multikassa
label
Описание типа кассы.
Пример ответа
{
"data": {
"id": "af909040-eee2-4fb4-b090-8acee5cdad14",
"name": "Касса",
"updated_at": "2026-03-12T07:30:49.853993Z",
"type": {
"value": 0,
"label": "Стандартная"
},
"tradepoint": {
"id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"name": "Магазин \"Clothes\" "
}
}
}
# Показать кассу
Ответ
Поля ответа
data
object
id
string
ID кассы.
name
string
Название кассы.
updated_at
string
Дата последнего обновления.
type
object
value
Тип кассы.
-1— Неизвестно0— Стандартная1— Webkassa2— Trinity3— E-Kassa4— Kaspi Касса5— Multikassa
label
Описание типа кассы.
Пример ответа
{
"data": {
"id": "af909040-eee2-4fb4-b090-8acee5cdad14",
"name": "Касса",
"updated_at": "2026-03-12T07:30:49.853993Z",
"type": {
"value": 0,
"label": "Стандартная"
},
"tradepoint": {
"id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"name": "Магазин \"Clothes\" "
}
}
}
# Редактировать кассу
Ответ
Поля ответа
data
object
id
string
ID кассы.
name
string
Название кассы.
updated_at
string
Дата последнего обновления.
type
object
value
Тип кассы.
-1— Неизвестно0— Стандартная1— Webkassa2— Trinity3— E-Kassa4— Kaspi Касса5— Multikassa
label
Описание типа кассы.
Пример ответа
{
"data": {
"id": "af909040-eee2-4fb4-b090-8acee5cdad14",
"name": "Касса",
"updated_at": "2026-03-12T07:30:49.853993Z",
"type": {
"value": 0,
"label": "Стандартная"
},
"tradepoint": {
"id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"name": "Магазин \"Clothes\" "
}
}
}
# Удалить кассу
Номенклатура
# Товары и услуги
API для работы со справочником номенклатуры.
# Список товаров / услуг
Ответ
Поля ответа
data
object
id
string
ID товара.
name
string
Название товара.
price
integer
Цена товара.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": [
{
"id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"name": "Футболка приталенная",
"price": 25000,
"type_id": "8d57db04-83fd-4515-aef3-caef839038c5",
"unit_id": "00000000-0000-0000-0000-000020493d02",
"parent_id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"updated_at": "2026-03-12T07:30:57.315235Z"
},
{
"id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"name": "Футболка приталенная",
"price": 25000,
"type_id": "8d57db04-83fd-4515-aef3-caef839038c5",
"unit_id": "00000000-0000-0000-0000-000020493d02",
"parent_id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"updated_at": "2026-03-12T07:30:57.315235Z"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Создать товар / услугу
Ответ
Поля ответа
data
object
id
string
ID товара.
name
string
Название товара.
price
integer
Цена товара.
is_weight
boolean
Весовой товар.
is_quick
boolean
Показывать в быстрых товарах.
updated_at
string
Дата последнего обновления.
unit
object
Пример ответа
{
"data": {
"id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"name": "Футболка приталенная",
"price": 25000,
"is_visible": true,
"is_weight": false,
"is_quick": false,
"updated_at": "2026-03-12T07:30:57.315235Z",
"type": {
"id": "8d57db04-83fd-4515-aef3-caef839038c5",
"name": "Одежда"
},
"unit": {
"id": "00000000-0000-0000-0000-000020493d02",
"name": "шт",
"full_name": "Штуки"
},
"parent": {
"id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"name": "Футболки"
}
}
}
# Показать товар / услугу
Ответ
Поля ответа
data
object
id
string
ID товара.
name
string
Название товара.
price
integer
Цена товара.
is_weight
boolean
Весовой товар.
is_quick
boolean
Показывать в быстрых товарах.
updated_at
string
Дата последнего обновления.
unit
object
Пример ответа
{
"data": {
"id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"name": "Футболка приталенная",
"price": 25000,
"is_visible": true,
"is_weight": false,
"is_quick": false,
"updated_at": "2026-03-12T07:30:57.315235Z",
"type": {
"id": "8d57db04-83fd-4515-aef3-caef839038c5",
"name": "Одежда"
},
"unit": {
"id": "00000000-0000-0000-0000-000020493d02",
"name": "шт",
"full_name": "Штуки"
},
"parent": {
"id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"name": "Футболки"
}
}
}
# Редактировать товар / услугу
Ответ
Поля ответа
data
object
id
string
ID товара.
name
string
Название товара.
price
integer
Цена товара.
is_weight
boolean
Весовой товар.
is_quick
boolean
Показывать в быстрых товарах.
updated_at
string
Дата последнего обновления.
unit
object
Пример ответа
{
"data": {
"id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"name": "Футболка приталенная",
"price": 25000,
"is_visible": true,
"is_weight": false,
"is_quick": false,
"updated_at": "2026-03-12T07:30:57.315235Z",
"type": {
"id": "8d57db04-83fd-4515-aef3-caef839038c5",
"name": "Одежда"
},
"unit": {
"id": "00000000-0000-0000-0000-000020493d02",
"name": "шт",
"full_name": "Штуки"
},
"parent": {
"id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"name": "Футболки"
}
}
}
# Удалить товар / услугу
# Группы номенклатуры
API для работы со справочником групп/категорий номенклатуры.
# Список групп
Ответ
Поля ответа
data
object
id
string
ID группы товаров.
name
string
Название группы.
parent_id
ID родительской группы.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": [
{
"id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"name": "Футболки",
"parent_id": null,
"updated_at": "2026-03-12T07:30:57.972226Z"
},
{
"id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"name": "Футболки",
"parent_id": null,
"updated_at": "2026-03-12T07:30:57.972226Z"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Создать группу
Ответ
Поля ответа
data
object
id
string
ID группы номенклатуры.
name
string
Название группы.
is_quick
boolean
Показывать в быстрых товарах.
updated_at
string
Дата последнего обновления.
parent
object
id
ID родительской группы.
name
Название родительской группы.
Пример ответа
{
"data": {
"id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"name": "Футболки",
"is_quick": false,
"updated_at": "2026-03-12T07:30:57.972226Z",
"parent": null
}
}
# Показать группу
Ответ
Поля ответа
data
object
id
string
ID группы номенклатуры.
name
string
Название группы.
is_quick
boolean
Показывать в быстрых товарах.
updated_at
string
Дата последнего обновления.
parent
object
id
ID родительской группы.
name
Название родительской группы.
Пример ответа
{
"data": {
"id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"name": "Футболки",
"is_quick": false,
"updated_at": "2026-03-12T07:30:57.972226Z",
"parent": null
}
}
# Редактировать группу
Ответ
Поля ответа
data
object
id
string
ID группы номенклатуры.
name
string
Название группы.
is_quick
boolean
Показывать в быстрых товарах.
updated_at
string
Дата последнего обновления.
parent
object
id
ID родительской группы.
name
Название родительской группы.
Пример ответа
{
"data": {
"id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"name": "Футболки",
"is_quick": false,
"updated_at": "2026-03-12T07:30:57.972226Z",
"parent": null
}
}
# Удалить группу
# Характеристики
API для работы со справочником характеристик номенклатуры.
# Список характеристик
Ответ
Поля ответа
data
object
id
string
ID характеристики.
name
string
Название характеристики.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": [
{
"id": "84d76dc7-9908-43b2-a045-e089e2b649cf",
"name": "44, Чёрный",
"item_id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"updated_at": "2026-03-12T07:30:57.514922Z"
},
{
"id": "84d76dc7-9908-43b2-a045-e089e2b649cf",
"name": "44, Чёрный",
"item_id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"updated_at": "2026-03-12T07:30:57.514922Z"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Показать характеристику
Ответ
Поля ответа
Пример ответа
{
"data": {
"id": "84d76dc7-9908-43b2-a045-e089e2b649cf",
"name": "44, Чёрный",
"full_name": "Размер: 44, Цвет: Чёрный",
"updated_at": "2026-03-12T07:30:57.514922Z",
"item": {
"id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"name": "Футболка приталенная"
}
}
}
# Штрихкоды
API для работы со справочником штрихкодов.
# Список штрихкодов
Ответ
Поля ответа
data
object
id
string
ID штрихкода.
barcode
string
Штрихкод.
ntin
NTIN из национального каталога товаров.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": [
{
"id": "cc7dad12-540e-4e7d-b55d-ef1cb1575ee4",
"barcode": "2000000000121",
"ntin": null,
"item_id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"attribute_id": "84d76dc7-9908-43b2-a045-e089e2b649cf",
"updated_at": "2026-03-12T07:30:56.354493Z"
},
{
"id": "cc7dad12-540e-4e7d-b55d-ef1cb1575ee4",
"barcode": "2000000000121",
"ntin": null,
"item_id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"attribute_id": "84d76dc7-9908-43b2-a045-e089e2b649cf",
"updated_at": "2026-03-12T07:30:56.354493Z"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Создать штрихкод
Ответ
Поля ответа
data
object
id
string
ID штрихкода.
barcode
string
Штрихкод.
ntin
NTIN из национального каталога товаров.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": {
"id": "cc7dad12-540e-4e7d-b55d-ef1cb1575ee4",
"barcode": "2000000000121",
"ntin": null,
"updated_at": "2026-03-12T07:30:56.354493Z",
"item": {
"id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"name": "Футболка приталенная"
},
"attribute": {
"id": "84d76dc7-9908-43b2-a045-e089e2b649cf",
"name": "44, Чёрный"
}
}
}
# Показать штрихкод
Ответ
Поля ответа
data
object
id
string
ID штрихкода.
barcode
string
Штрихкод.
ntin
NTIN из национального каталога товаров.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": {
"id": "cc7dad12-540e-4e7d-b55d-ef1cb1575ee4",
"barcode": "2000000000121",
"ntin": null,
"updated_at": "2026-03-12T07:30:56.354493Z",
"item": {
"id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"name": "Футболка приталенная"
},
"attribute": {
"id": "84d76dc7-9908-43b2-a045-e089e2b649cf",
"name": "44, Чёрный"
}
}
}
# Удалить штрихкод
# Виды цен
API для работы со справочником видов цен.
# Список видов цен
Ответ
Поля ответа
data
object
id
string
ID вида цены.
name
string
Название вида цены.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": [
{
"id": "00000000-0000-0000-0000-000000000004",
"name": "Оптом",
"updated_at": "2026-03-11T05:12:16.267134Z"
},
{
"id": "00000000-0000-0000-0000-000000000004",
"name": "Оптом",
"updated_at": "2026-03-11T05:12:16.267134Z"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Создать вид цены
Ответ
Поля ответа
data
object
id
string
ID вида цены.
name
string
Название вида цены.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": {
"id": "00000000-0000-0000-0000-000000000004",
"name": "Оптом",
"updated_at": "2026-03-11T05:12:16.267134Z"
}
}
# Показать вид цены
Ответ
Поля ответа
data
object
id
string
ID вида цены.
name
string
Название вида цены.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": {
"id": "00000000-0000-0000-0000-000000000004",
"name": "Оптом",
"updated_at": "2026-03-11T05:12:16.267134Z"
}
}
# Редактировать вид цены
Ответ
Поля ответа
data
object
id
string
ID вида цены.
name
string
Название вида цены.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": {
"id": "00000000-0000-0000-0000-000000000004",
"name": "Оптом",
"updated_at": "2026-03-11T05:12:16.267134Z"
}
}
# Удалить вид цены
# Виды номенклатуры
API для работы со справочником видов номенклатуры.
# Список видов
Ответ
Поля ответа
data
object
id
string
ID вида номенклатуры.
name
string
Название вида номенклатуры.
type
integer
Тип вида номенклатуры.
1— Продукт2— Услуга3— Маркируемый товар4— Тарификатор
parent_id
ID родительского вида.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": [
{
"id": "8d57db04-83fd-4515-aef3-caef839038c5",
"name": "Одежда",
"type": 1,
"parent_id": null,
"updated_at": "2026-03-12 07:30:58.125027"
},
{
"id": "8d57db04-83fd-4515-aef3-caef839038c5",
"name": "Одежда",
"type": 1,
"parent_id": null,
"updated_at": "2026-03-12 07:30:58.125027"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Создать вид
Ответ
Поля ответа
data
object
id
string
ID вида номенклатуры.
name
string
Название вида номенклатуры.
type
object
value
Тип вида номенклатуры.
1— Продукт2— Услуга3— Маркируемый товар4— Тарификатор
label
Описание типа вида номенклатуры.
1— Продукт2— Услуга3— Маркируемый товар4— Тарификатор
parent
object
id
ID родительского вида.
name
Название родительского вида.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": {
"id": "8d57db04-83fd-4515-aef3-caef839038c5",
"name": "Одежда",
"updated_at": "2026-03-12 07:30:58.125027",
"type": {
"value": 1,
"label": "Продукт"
},
"parent": null
}
}
# Показать вид
Ответ
Поля ответа
data
object
id
string
ID вида номенклатуры.
name
string
Название вида номенклатуры.
type
object
value
Тип вида номенклатуры.
1— Продукт2— Услуга3— Маркируемый товар4— Тарификатор
label
Описание типа вида номенклатуры.
1— Продукт2— Услуга3— Маркируемый товар4— Тарификатор
parent
object
id
ID родительского вида.
name
Название родительского вида.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": {
"id": "8d57db04-83fd-4515-aef3-caef839038c5",
"name": "Одежда",
"updated_at": "2026-03-12 07:30:58.125027",
"type": {
"value": 1,
"label": "Продукт"
},
"parent": null
}
}
# Удалить вид
# Единицы измерения
API для работы со справочником единиц измерения.
# Список ед. измерения
Ответ
Поля ответа
data
object
id
string
ID единицы измерения.
name
string
Краткое название единицы измерения.
full_name
string
Полное название единицы измерения.
Пример ответа
{
"data": [
{
"id": "eb6524be-27cd-4900-87a1-46c6aa5b409f",
"name": "мин",
"full_name": "Минута"
},
{
"id": "eb6524be-27cd-4900-87a1-46c6aa5b409f",
"name": "мин",
"full_name": "Минута"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Создать ед. измерения
Ответ
Поля ответа
data
object
id
string
ID единицы измерения.
name
string
Краткое название единицы измерения.
full_name
string
Полное название единицы измерения.
Пример ответа
{
"data": {
"id": "eb6524be-27cd-4900-87a1-46c6aa5b409f",
"name": "мин",
"full_name": "Минута"
}
}
# Показать ед. измерения
Ответ
Поля ответа
data
object
id
string
ID единицы измерения.
name
string
Краткое название единицы измерения.
full_name
string
Полное название единицы измерения.
Пример ответа
{
"data": {
"id": "eb6524be-27cd-4900-87a1-46c6aa5b409f",
"name": "мин",
"full_name": "Минута"
}
}
# Редактировать ед. измерения
Ответ
Поля ответа
data
object
id
string
ID единицы измерения.
name
string
Краткое название единицы измерения.
full_name
string
Полное название единицы измерения.
Пример ответа
{
"data": {
"id": "eb6524be-27cd-4900-87a1-46c6aa5b409f",
"name": "мин",
"full_name": "Минута"
}
}
# Удалить ед. измерения
Контрагенты
# Контрагенты
API для работы со справочником контрагентов.
# Бонусы контрагентов
Ответ
Пример ответа
{
"data": [
{
"id": "a4d61291-e007-404d-9a3e-0bcbed6c1035",
"parent_id": "c75850ee-26db-4121-9e20-d0ad0026de34",
"contractor_type_id": "31000000-0000-0000-0000-000000000000",
"name": "Мария",
"bin": null,
"discount": null,
"service": null,
"updated_at": "2026-03-12T07:30:57.175944Z",
"latest_bonus": []
},
{
"id": "a4d61291-e007-404d-9a3e-0bcbed6c1035",
"parent_id": "c75850ee-26db-4121-9e20-d0ad0026de34",
"contractor_type_id": "31000000-0000-0000-0000-000000000000",
"name": "Мария",
"bin": null,
"discount": null,
"service": null,
"updated_at": "2026-03-12T07:30:57.175944Z",
"latest_bonus": []
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Список контрагентов
Ответ
Поля ответа
data
object
id
string
ID контрагента
name
string
Имя контрагента
service
Процент наценки.
discount
Процент скидки.
bin
БИН.
type
string
Тип контрагента.
31000000-0000-0000-0000-000000000000— Физическое лицо32000000-0000-0000-0000-000000000000— Юридическое лицо33000000-0000-0000-0000-000000000000— Юридическое лицо (нерезидент)
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": [
{
"id": "a4d61291-e007-404d-9a3e-0bcbed6c1035",
"name": "Мария",
"service": null,
"discount": null,
"bin": null,
"type": "31000000-0000-0000-0000-000000000000",
"parent_id": "c75850ee-26db-4121-9e20-d0ad0026de34",
"updated_at": "2026-03-12T07:30:57.175944Z"
},
{
"id": "a4d61291-e007-404d-9a3e-0bcbed6c1035",
"name": "Мария",
"service": null,
"discount": null,
"bin": null,
"type": "31000000-0000-0000-0000-000000000000",
"parent_id": "c75850ee-26db-4121-9e20-d0ad0026de34",
"updated_at": "2026-03-12T07:30:57.175944Z"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Создать контрагента
Ответ
Поля ответа
data
object
id
string
ID контрагентов.
name
string
Имя контрагентов.
service
Процент наценки.
discount
Процент скидки.
bin
БИН.
legal_address
Юридический адрес.
actual_address
Фактический адрес.
birthdate
Дата рождения.
comment
Комментарий.
updated_at
string
Дата последнего обновления.
type
object
id
ID типа контрагента.
31000000-0000-0000-0000-000000000000— Физическое лицо32000000-0000-0000-0000-000000000000— Юридическое лицо33000000-0000-0000-0000-000000000000— Юридическое лицо (нерезидент)
name
Название типа контрагента.
description
Описание типа контрагента.
Пример ответа
{
"data": {
"id": "a4d61291-e007-404d-9a3e-0bcbed6c1035",
"name": "Мария",
"full_name": "Мария",
"service": null,
"discount": null,
"bin": null,
"legal_address": null,
"actual_address": null,
"birthdate": null,
"comment": null,
"updated_at": "2026-03-12T07:30:57.175944Z",
"type": {
"id": "31000000-0000-0000-0000-000000000000",
"name": "Физ. лицо",
"description": "Физическое лицо"
},
"parent": {
"id": "c75850ee-26db-4121-9e20-d0ad0026de34",
"name": "Постоянные клиенты"
}
}
}
# Показать контрагента
Ответ
Поля ответа
data
object
id
string
ID контрагентов.
name
string
Имя контрагентов.
service
Процент наценки.
discount
Процент скидки.
bin
БИН.
legal_address
Юридический адрес.
actual_address
Фактический адрес.
birthdate
Дата рождения.
comment
Комментарий.
updated_at
string
Дата последнего обновления.
type
object
id
ID типа контрагента.
31000000-0000-0000-0000-000000000000— Физическое лицо32000000-0000-0000-0000-000000000000— Юридическое лицо33000000-0000-0000-0000-000000000000— Юридическое лицо (нерезидент)
name
Название типа контрагента.
description
Описание типа контрагента.
Пример ответа
{
"data": {
"id": "a4d61291-e007-404d-9a3e-0bcbed6c1035",
"name": "Мария",
"full_name": "Мария",
"service": null,
"discount": null,
"bin": null,
"legal_address": null,
"actual_address": null,
"birthdate": null,
"comment": null,
"updated_at": "2026-03-12T07:30:57.175944Z",
"type": {
"id": "31000000-0000-0000-0000-000000000000",
"name": "Физ. лицо",
"description": "Физическое лицо"
},
"parent": {
"id": "c75850ee-26db-4121-9e20-d0ad0026de34",
"name": "Постоянные клиенты"
}
}
}
# Редактировать контрагента
Ответ
Поля ответа
data
object
id
string
ID контрагентов.
name
string
Имя контрагентов.
service
Процент наценки.
discount
Процент скидки.
bin
БИН.
legal_address
Юридический адрес.
actual_address
Фактический адрес.
birthdate
Дата рождения.
comment
Комментарий.
updated_at
string
Дата последнего обновления.
type
object
id
ID типа контрагента.
31000000-0000-0000-0000-000000000000— Физическое лицо32000000-0000-0000-0000-000000000000— Юридическое лицо33000000-0000-0000-0000-000000000000— Юридическое лицо (нерезидент)
name
Название типа контрагента.
description
Описание типа контрагента.
Пример ответа
{
"data": {
"id": "a4d61291-e007-404d-9a3e-0bcbed6c1035",
"name": "Мария",
"full_name": "Мария",
"service": null,
"discount": null,
"bin": null,
"legal_address": null,
"actual_address": null,
"birthdate": null,
"comment": null,
"updated_at": "2026-03-12T07:30:57.175944Z",
"type": {
"id": "31000000-0000-0000-0000-000000000000",
"name": "Физ. лицо",
"description": "Физическое лицо"
},
"parent": {
"id": "c75850ee-26db-4121-9e20-d0ad0026de34",
"name": "Постоянные клиенты"
}
}
}
# Удалить контрагента
# Группы контрагентов
API для работы со справочником групп контрагентов.
# Список групп
Ответ
Поля ответа
data
object
id
string
ID группы контрагентов.
name
string
Название группы.
service
Процент наценки.
discount
Процент скидки.
parent_id
ID родительской группы.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": [
{
"id": "c75850ee-26db-4121-9e20-d0ad0026de34",
"name": "Постоянные клиенты",
"service": null,
"discount": null,
"parent_id": null,
"updated_at": "2026-03-12T07:30:57.068105Z"
},
{
"id": "c75850ee-26db-4121-9e20-d0ad0026de34",
"name": "Постоянные клиенты",
"service": null,
"discount": null,
"parent_id": null,
"updated_at": "2026-03-12T07:30:57.068105Z"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Создать группу
Ответ
Поля ответа
data
object
id
string
ID группы контрагентов.
name
string
Название группы.
service
Процент наценки.
discount
Процент скидки.
parent
object
id
ID родительской группы.
name
Название родительской группы.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": {
"id": "c75850ee-26db-4121-9e20-d0ad0026de34",
"name": "Постоянные клиенты",
"service": null,
"discount": null,
"updated_at": "2026-03-12T07:30:57.068105Z",
"parent": null
}
}
# Показать группу
Ответ
Поля ответа
data
object
id
string
ID группы контрагентов.
name
string
Название группы.
service
Процент наценки.
discount
Процент скидки.
parent
object
id
ID родительской группы.
name
Название родительской группы.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": {
"id": "c75850ee-26db-4121-9e20-d0ad0026de34",
"name": "Постоянные клиенты",
"service": null,
"discount": null,
"updated_at": "2026-03-12T07:30:57.068105Z",
"parent": null
}
}
# Редактировать группу
Ответ
Поля ответа
data
object
id
string
ID группы контрагентов.
name
string
Название группы.
service
Процент наценки.
discount
Процент скидки.
parent
object
id
ID родительской группы.
name
Название родительской группы.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": {
"id": "c75850ee-26db-4121-9e20-d0ad0026de34",
"name": "Постоянные клиенты",
"service": null,
"discount": null,
"updated_at": "2026-03-12T07:30:57.068105Z",
"parent": null
}
}
# Удалить группу
# Контакты контрагентов
API для работы со справочником контакты контрагентов.
# Список контактов
Ответ
Пример ответа
{
"data": [
{
"id": "9dbefbdd-02cf-4755-b221-44b490f1bf16",
"type_id": "00000000-0000-0000-0000-000000000001",
"contractor_id": "9cbfeb92-4f43-4900-b934-6ae1d6eca79e",
"value": "+77087887878",
"updated_at": "2026-03-12T07:30:56.925560Z"
},
{
"id": "9dbefbdd-02cf-4755-b221-44b490f1bf16",
"type_id": "00000000-0000-0000-0000-000000000001",
"contractor_id": "9cbfeb92-4f43-4900-b934-6ae1d6eca79e",
"value": "+77087887878",
"updated_at": "2026-03-12T07:30:56.925560Z"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Создать контакт
Ответ
Пример ответа
{
"data": {
"id": "9dbefbdd-02cf-4755-b221-44b490f1bf16",
"type": {
"id": "00000000-0000-0000-0000-000000000001",
"name": "Телефон"
},
"contractor": {
"id": "9cbfeb92-4f43-4900-b934-6ae1d6eca79e",
"name": "Иван"
},
"value": "+77087887878",
"updated_at": "2026-03-12T07:30:56.925560Z"
}
}
# Показать контакт
Ответ
Пример ответа
{
"data": {
"id": "9dbefbdd-02cf-4755-b221-44b490f1bf16",
"type": {
"id": "00000000-0000-0000-0000-000000000001",
"name": "Телефон"
},
"contractor": {
"id": "9cbfeb92-4f43-4900-b934-6ae1d6eca79e",
"name": "Иван"
},
"value": "+77087887878",
"updated_at": "2026-03-12T07:30:56.925560Z"
}
}
# Редактировать контакт
Ответ
Пример ответа
{
"data": {
"id": "9dbefbdd-02cf-4755-b221-44b490f1bf16",
"type": {
"id": "00000000-0000-0000-0000-000000000001",
"name": "Телефон"
},
"contractor": {
"id": "9cbfeb92-4f43-4900-b934-6ae1d6eca79e",
"name": "Иван"
},
"value": "+77087887878",
"updated_at": "2026-03-12T07:30:56.925560Z"
}
}
# Удалить контакт
Документы
# Поступление на счет
API для работы со справочником Поступление на счет.
# Список документов.
Ответ
Пример ответа
{
"data": [
{
"id": null,
"bank_data_id": null,
"cashflow": null,
"contractor": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"date": null,
"doc_type": {
"id": 14,
"name": "Поступление на счёт"
},
"is_conduct": true,
"removed": null,
"created_by": null,
"updated_at": null,
"value": 0
},
{
"id": null,
"bank_data_id": null,
"cashflow": null,
"contractor": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"date": null,
"doc_type": {
"id": 14,
"name": "Поступление на счёт"
},
"is_conduct": true,
"removed": null,
"created_by": null,
"updated_at": null,
"value": 0
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Показать документ.
Ответ
Пример ответа
{
"data": {
"id": null,
"bank_data": null,
"cashflow": null,
"contractor": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"comment": null,
"date": null,
"doc_type": {
"id": 14,
"name": "Поступление на счёт"
},
"is_conduct": true,
"removed": null,
"created_by": null,
"updated_at": null,
"value": 0
}
}
# Изъятие со счета
API для работы со справочником Изъятие со счета.
# Список документов.
Ответ
Пример ответа
{
"data": [
{
"id": null,
"bank_data_id": null,
"cashflow": null,
"contractor": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"date": null,
"doc_type": {
"id": 15,
"name": "Изъятие со счёта"
},
"is_conduct": true,
"removed": null,
"created_by": null,
"updated_at": null,
"value": 0
},
{
"id": null,
"bank_data_id": null,
"cashflow": null,
"contractor": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"date": null,
"doc_type": {
"id": 15,
"name": "Изъятие со счёта"
},
"is_conduct": true,
"removed": null,
"created_by": null,
"updated_at": null,
"value": 0
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Показать документ.
Ответ
Пример ответа
{
"data": {
"id": null,
"bank_data": null,
"cashflow": null,
"contractor": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"comment": null,
"date": null,
"doc_type": {
"id": 15,
"name": "Изъятие со счёта"
},
"is_conduct": true,
"removed": null,
"created_by": null,
"updated_at": null,
"value": 0
}
}
# Поступление в кассу
API для работы со справочником Поступление в кассу.
# Список документов.
Ответ
Пример ответа
{
"data": [
{
"id": null,
"cashbox_id": null,
"cashflow": null,
"contractor": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"date": null,
"doc_type": {
"id": 11,
"name": "Поступление в кассу"
},
"fiscal_data": null,
"is_conduct": true,
"removed": null,
"created_by": null,
"updated_at": null,
"value": 0
},
{
"id": null,
"cashbox_id": null,
"cashflow": null,
"contractor": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"date": null,
"doc_type": {
"id": 11,
"name": "Поступление в кассу"
},
"fiscal_data": null,
"is_conduct": true,
"removed": null,
"created_by": null,
"updated_at": null,
"value": 0
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Показать документ.
Ответ
Пример ответа
{
"data": {
"id": null,
"cashbox": null,
"cashflow": null,
"contractor": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"comment": null,
"date": null,
"doc_type": {
"id": 11,
"name": "Поступление в кассу"
},
"fiscal_data": null,
"is_conduct": true,
"removed": null,
"created_by": null,
"updated_at": null,
"tradepoint": null,
"value": 0
}
}
# Изъятие из кассы
API для работы со справочником Изъятие из кассы.
# Список документов.
Ответ
Пример ответа
{
"data": [
{
"id": null,
"cashbox_id": null,
"cashflow": null,
"contractor": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"date": null,
"doc_type": {
"id": 12,
"name": "Изъятие из кассы"
},
"fiscal_data": null,
"is_conduct": true,
"removed": null,
"created_by": null,
"updated_at": null,
"value": 0
},
{
"id": null,
"cashbox_id": null,
"cashflow": null,
"contractor": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"date": null,
"doc_type": {
"id": 12,
"name": "Изъятие из кассы"
},
"fiscal_data": null,
"is_conduct": true,
"removed": null,
"created_by": null,
"updated_at": null,
"value": 0
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Показать документ.
Ответ
Пример ответа
{
"data": {
"id": null,
"cashbox": null,
"cashflow": null,
"contractor": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"comment": null,
"date": null,
"doc_type": {
"id": 12,
"name": "Изъятие из кассы"
},
"fiscal_data": null,
"is_conduct": true,
"removed": null,
"created_by": null,
"updated_at": null,
"tradepoint": null,
"value": 0
}
}
# Инвентаризация
API для работы со справочником Инвентаризация.
# Список документов.
Ответ
Пример ответа
{
"data": [
{
"id": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"date": null,
"doc_type": {
"id": 6,
"name": "Инвентаризация"
},
"is_conduct": true,
"items_count": 0,
"removed": null,
"created_by": null,
"updated_at": null,
"warehouse": null
},
{
"id": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"date": null,
"doc_type": {
"id": 6,
"name": "Инвентаризация"
},
"is_conduct": true,
"items_count": 0,
"removed": null,
"created_by": null,
"updated_at": null,
"warehouse": null
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Показать документ.
Ответ
Пример ответа
{
"data": {
"id": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"comment": null,
"date": null,
"doc_type": {
"id": 6,
"name": "Инвентаризация"
},
"is_conduct": true,
"items": [],
"removed": null,
"created_by": null,
"updated_at": null,
"tradepoint": null,
"warehouse": null
}
}
# Перемещение товаров
API для работы со справочником Перемещение товаров.
# Список документов.
Ответ
Пример ответа
{
"data": [
{
"id": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"date": null,
"doc_type": {
"id": 5,
"name": "Перемещение товаров"
},
"is_conduct": true,
"items_count": 0,
"removed": null,
"sum": 0,
"created_by": null,
"updated_at": null,
"warehouse_from": null,
"warehouse_to": null
},
{
"id": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"date": null,
"doc_type": {
"id": 5,
"name": "Перемещение товаров"
},
"is_conduct": true,
"items_count": 0,
"removed": null,
"sum": 0,
"created_by": null,
"updated_at": null,
"warehouse_from": null,
"warehouse_to": null
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Показать документ.
Ответ
Пример ответа
{
"data": {
"id": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"comment": null,
"date": null,
"doc_type": {
"id": 5,
"name": "Перемещение товаров"
},
"is_conduct": true,
"items": [],
"removed": null,
"sum": 0,
"created_by": null,
"updated_at": null,
"tradepoint_from": null,
"tradepoint_to": null,
"warehouse_from": null,
"warehouse_to": null
}
}
# Оприходование
API для работы со справочником Оприходование.
# Список документов.
Ответ
Пример ответа
{
"data": [
{
"id": "bf3be6c3-3279-457d-a34e-3a952f2f5012",
"based_on": 0,
"based_id": null,
"code": "00000000003",
"date": "2026-03-12 07:05:16",
"doc_type": {
"id": 8,
"name": "Оприходование"
},
"is_conduct": true,
"items_count": 12,
"removed": false,
"sum": 425000,
"created_by": "Не перезванивать",
"updated_at": "2026-03-12T07:48:07.542598Z",
"warehouse": {
"id": "62f8ec81-5cf6-4072-bd89-cfd033454f0e",
"is_limit": false,
"name": "Магазин "
}
},
{
"id": "bf3be6c3-3279-457d-a34e-3a952f2f5012",
"based_on": 0,
"based_id": null,
"code": "00000000003",
"date": "2026-03-12 07:05:16",
"doc_type": {
"id": 8,
"name": "Оприходование"
},
"is_conduct": true,
"items_count": 12,
"removed": false,
"sum": 425000,
"created_by": "Не перезванивать",
"updated_at": "2026-03-12T07:48:07.542598Z",
"warehouse": {
"id": "62f8ec81-5cf6-4072-bd89-cfd033454f0e",
"is_limit": false,
"name": "Магазин "
}
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Показать документ.
Ответ
Пример ответа
{
"data": {
"id": "bf3be6c3-3279-457d-a34e-3a952f2f5012",
"based_on": 0,
"based_id": null,
"code": "00000000003",
"comment": "",
"date": "2026-03-12 07:05:16",
"doc_type": {
"id": 8,
"name": "Оприходование"
},
"is_conduct": true,
"items": [
{
"id": "1d370d64-a215-4a47-b3ef-571d988a6395",
"gross": 8,
"price": 5000,
"price_types": [],
"attribute": {
"id": "4178553d-11b6-4fb5-a785-bbdd8c5d0785",
"item_id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"name": "44, Белый",
"updated_at": "2026-03-12T07:30:57.514918Z"
},
"item": {
"id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"parent_id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"name": "Футболка приталенная",
"price": 25000,
"type_id": "8d57db04-83fd-4515-aef3-caef839038c5",
"unit_id": "00000000-0000-0000-0000-000020493d02",
"updated_at": "2026-03-12T07:30:57.315235Z"
},
"measure": {
"id": "00000000-0000-0000-0000-000020493d02",
"name": "шт",
"full_name": "Штуки"
},
"removed": false
},
{
"id": "9ae6fdcd-ebe2-453d-9dde-703db04b0253",
"gross": 4,
"price": 5000,
"price_types": [],
"attribute": {
"id": "42296815-b6ba-46be-9ffa-f1e3af091cc9",
"item_id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"name": "48, Чёрный",
"updated_at": "2026-03-12T07:30:57.514919Z"
},
"item": {
"id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"parent_id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"name": "Футболка приталенная",
"price": 25000,
"type_id": "8d57db04-83fd-4515-aef3-caef839038c5",
"unit_id": "00000000-0000-0000-0000-000020493d02",
"updated_at": "2026-03-12T07:30:57.315235Z"
},
"measure": {
"id": "00000000-0000-0000-0000-000020493d02",
"name": "шт",
"full_name": "Штуки"
},
"removed": false
},
{
"id": "2d982e12-4068-4f76-9650-2810a7359974",
"gross": 5,
"price": 5000,
"price_types": [],
"attribute": {
"id": "5394095f-e92b-4581-8799-9f5961514cb4",
"item_id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"name": "52, Чёрный",
"updated_at": "2026-03-12T07:30:57.514920Z"
},
"item": {
"id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"parent_id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"name": "Футболка приталенная",
"price": 25000,
"type_id": "8d57db04-83fd-4515-aef3-caef839038c5",
"unit_id": "00000000-0000-0000-0000-000020493d02",
"updated_at": "2026-03-12T07:30:57.315235Z"
},
"measure": {
"id": "00000000-0000-0000-0000-000020493d02",
"name": "шт",
"full_name": "Штуки"
},
"removed": false
},
{
"id": "4628191c-6138-48f4-8517-590c4456111a",
"gross": 6,
"price": 5000,
"price_types": [],
"attribute": {
"id": "62fb0fe4-840b-4a0e-a1ef-9469847df586",
"item_id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"name": "52, Белый",
"updated_at": "2026-03-12T07:30:57.514921Z"
},
"item": {
"id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"parent_id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"name": "Футболка приталенная",
"price": 25000,
"type_id": "8d57db04-83fd-4515-aef3-caef839038c5",
"unit_id": "00000000-0000-0000-0000-000020493d02",
"updated_at": "2026-03-12T07:30:57.315235Z"
},
"measure": {
"id": "00000000-0000-0000-0000-000020493d02",
"name": "шт",
"full_name": "Штуки"
},
"removed": false
},
{
"id": "239bb24b-fb8c-4e00-b210-2a97f7c619ef",
"gross": 7,
"price": 5000,
"price_types": [],
"attribute": {
"id": "84d76dc7-9908-43b2-a045-e089e2b649cf",
"item_id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"name": "44, Чёрный",
"updated_at": "2026-03-12T07:30:57.514922Z"
},
"item": {
"id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"parent_id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"name": "Футболка приталенная",
"price": 25000,
"type_id": "8d57db04-83fd-4515-aef3-caef839038c5",
"unit_id": "00000000-0000-0000-0000-000020493d02",
"updated_at": "2026-03-12T07:30:57.315235Z"
},
"measure": {
"id": "00000000-0000-0000-0000-000020493d02",
"name": "шт",
"full_name": "Штуки"
},
"removed": false
},
{
"id": "da8be761-94f7-41f0-9631-1917415be793",
"gross": 9,
"price": 5000,
"price_types": [],
"attribute": {
"id": "a57fcb72-ebf5-4292-967e-6ea9f4fbf7d9",
"item_id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"name": "52, Зелёный",
"updated_at": "2026-03-12T07:30:57.514923Z"
},
"item": {
"id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"parent_id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"name": "Футболка приталенная",
"price": 25000,
"type_id": "8d57db04-83fd-4515-aef3-caef839038c5",
"unit_id": "00000000-0000-0000-0000-000020493d02",
"updated_at": "2026-03-12T07:30:57.315235Z"
},
"measure": {
"id": "00000000-0000-0000-0000-000020493d02",
"name": "шт",
"full_name": "Штуки"
},
"removed": false
},
{
"id": "48ae5464-6994-46cc-a2d6-cf2fd9b502f8",
"gross": 9,
"price": 5000,
"price_types": [],
"attribute": {
"id": "cc1e7823-345e-4af3-b034-869654ba666a",
"item_id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"name": "48, Белый",
"updated_at": "2026-03-12T07:30:57.514924Z"
},
"item": {
"id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"parent_id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"name": "Футболка приталенная",
"price": 25000,
"type_id": "8d57db04-83fd-4515-aef3-caef839038c5",
"unit_id": "00000000-0000-0000-0000-000020493d02",
"updated_at": "2026-03-12T07:30:57.315235Z"
},
"measure": {
"id": "00000000-0000-0000-0000-000020493d02",
"name": "шт",
"full_name": "Штуки"
},
"removed": false
},
{
"id": "4b3aeeca-29ba-40be-b8b2-c13a763649b9",
"gross": 10,
"price": 5000,
"price_types": [],
"attribute": {
"id": "d4f63971-4d28-40b8-af41-66bbbf122978",
"item_id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"name": "48, Зелёный",
"updated_at": "2026-03-12T07:30:57.514925Z"
},
"item": {
"id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"parent_id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"name": "Футболка приталенная",
"price": 25000,
"type_id": "8d57db04-83fd-4515-aef3-caef839038c5",
"unit_id": "00000000-0000-0000-0000-000020493d02",
"updated_at": "2026-03-12T07:30:57.315235Z"
},
"measure": {
"id": "00000000-0000-0000-0000-000020493d02",
"name": "шт",
"full_name": "Штуки"
},
"removed": false
},
{
"id": "3ad504f0-36a5-4600-ad47-03d7b834ab50",
"gross": 8,
"price": 5000,
"price_types": [],
"attribute": {
"id": "e1543deb-312e-497e-b91b-51a7aad79984",
"item_id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"name": "46, Чёрный",
"updated_at": "2026-03-12T07:30:57.514926Z"
},
"item": {
"id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"parent_id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"name": "Футболка приталенная",
"price": 25000,
"type_id": "8d57db04-83fd-4515-aef3-caef839038c5",
"unit_id": "00000000-0000-0000-0000-000020493d02",
"updated_at": "2026-03-12T07:30:57.315235Z"
},
"measure": {
"id": "00000000-0000-0000-0000-000020493d02",
"name": "шт",
"full_name": "Штуки"
},
"removed": false
},
{
"id": "dae31355-7b56-4206-a85d-5a468dfc30b7",
"gross": 6,
"price": 5000,
"price_types": [],
"attribute": {
"id": "e49ad80a-6457-4434-8529-8e86d03b5a2a",
"item_id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"name": "46, Белый",
"updated_at": "2026-03-12T07:30:57.514927Z"
},
"item": {
"id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"parent_id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"name": "Футболка приталенная",
"price": 25000,
"type_id": "8d57db04-83fd-4515-aef3-caef839038c5",
"unit_id": "00000000-0000-0000-0000-000020493d02",
"updated_at": "2026-03-12T07:30:57.315235Z"
},
"measure": {
"id": "00000000-0000-0000-0000-000020493d02",
"name": "шт",
"full_name": "Штуки"
},
"removed": false
},
{
"id": "cd0ad573-1782-4e9b-878f-6156d84188c2",
"gross": 7,
"price": 5000,
"price_types": [],
"attribute": {
"id": "f8d4650d-136f-408e-8fc3-db09956220bb",
"item_id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"name": "44, Зелёный",
"updated_at": "2026-03-12T07:30:57.514928Z"
},
"item": {
"id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"parent_id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"name": "Футболка приталенная",
"price": 25000,
"type_id": "8d57db04-83fd-4515-aef3-caef839038c5",
"unit_id": "00000000-0000-0000-0000-000020493d02",
"updated_at": "2026-03-12T07:30:57.315235Z"
},
"measure": {
"id": "00000000-0000-0000-0000-000020493d02",
"name": "шт",
"full_name": "Штуки"
},
"removed": false
},
{
"id": "b5ed8229-c6f6-43d0-a5e2-a6c80d4cb531",
"gross": 6,
"price": 5000,
"price_types": [],
"attribute": {
"id": "fec72995-164d-430f-b3e0-ee7fee035749",
"item_id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"name": "46, Зелёный",
"updated_at": "2026-03-12T07:30:57.514929Z"
},
"item": {
"id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
"parent_id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
"name": "Футболка приталенная",
"price": 25000,
"type_id": "8d57db04-83fd-4515-aef3-caef839038c5",
"unit_id": "00000000-0000-0000-0000-000020493d02",
"updated_at": "2026-03-12T07:30:57.315235Z"
},
"measure": {
"id": "00000000-0000-0000-0000-000020493d02",
"name": "шт",
"full_name": "Штуки"
},
"removed": false
}
],
"removed": false,
"sum": 425000,
"created_by": "Не перезванивать",
"updated_at": "2026-03-12T07:48:07.542598Z",
"tradepoint": {
"id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
"name": "Магазин \"Clothes\" "
},
"warehouse": {
"id": "62f8ec81-5cf6-4072-bd89-cfd033454f0e",
"is_limit": false,
"name": "Магазин "
}
}
}
# Поступления товаров и услуг
API для работы со справочником Поступления товаров и услуг.
# Список документов.
Ответ
Пример ответа
{
"data": [
{
"id": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"contractor": null,
"date": null,
"doc_type": {
"id": 2,
"name": "Поступления товаров и услуг"
},
"is_conduct": true,
"items_count": 0,
"removed": null,
"sum": null,
"created_by": null,
"updated_at": null,
"warehouse": null
},
{
"id": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"contractor": null,
"date": null,
"doc_type": {
"id": 2,
"name": "Поступления товаров и услуг"
},
"is_conduct": true,
"items_count": 0,
"removed": null,
"sum": null,
"created_by": null,
"updated_at": null,
"warehouse": null
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Показать документ.
Ответ
Пример ответа
{
"data": {
"id": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"comment": null,
"contractor": null,
"date": null,
"doc_type": {
"id": 2,
"name": "Поступления товаров и услуг"
},
"is_conduct": true,
"items": [],
"removed": null,
"sum": null,
"created_by": null,
"updated_at": null,
"tradepoint": null,
"warehouse": null
}
}
# Реализация товаров и услуг
API для работы со справочником Реализация товаров и услуг.
# Список документов.
Ответ
Пример ответа
{
"data": [
{
"id": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"contractor": null,
"date": null,
"doc_type": {
"id": 1,
"name": "Реализация товаров и услуг"
},
"is_conduct": true,
"is_cook": null,
"items_count": 0,
"removed": null,
"sum": null,
"created_by": null,
"updated_at": null,
"warehouse": null
},
{
"id": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"contractor": null,
"date": null,
"doc_type": {
"id": 1,
"name": "Реализация товаров и услуг"
},
"is_conduct": true,
"is_cook": null,
"items_count": 0,
"removed": null,
"sum": null,
"created_by": null,
"updated_at": null,
"warehouse": null
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Показать документ.
Ответ
Пример ответа
{
"data": {
"id": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"comment": null,
"contractor": null,
"date": null,
"doc_type": {
"id": 1,
"name": "Реализация товаров и услуг"
},
"is_conduct": true,
"is_cook": null,
"items": [],
"price_types": null,
"removed": null,
"sum": null,
"created_by": null,
"updated_at": null,
"tradepoint": null,
"warehouse": null
}
}
# Списание
API для работы со справочником Списание.
# Список документов.
Ответ
Пример ответа
{
"data": [
{
"id": null,
"article": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"date": null,
"doc_type": {
"id": 9,
"name": "Списание"
},
"is_conduct": true,
"is_cook": null,
"items_count": 0,
"removed": null,
"created_by": null,
"updated_at": null,
"warehouse": null
},
{
"id": null,
"article": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"date": null,
"doc_type": {
"id": 9,
"name": "Списание"
},
"is_conduct": true,
"is_cook": null,
"items_count": 0,
"removed": null,
"created_by": null,
"updated_at": null,
"warehouse": null
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Показать документ.
Ответ
Пример ответа
{
"data": {
"id": null,
"article": null,
"based_on": null,
"based_id": null,
"code": "00000000000",
"comment": null,
"date": null,
"doc_type": {
"id": 9,
"name": "Списание"
},
"is_conduct": true,
"is_cook": null,
"items": [],
"removed": null,
"created_by": null,
"updated_at": null,
"tradepoint": null,
"warehouse": null
}
}
Пользователи
# Сотрудники Front-офиса
API для работы со справочником сотрудников Front-офиса.
# Список сотрудников
Ответ
Поля ответа
data
object
id
string
ID сотрудника Front-офиса.
name
string
Имя сотрудника.
parent_id
ID родительской группа.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": [
{
"id": "31000000-0000-0000-0000-000000000000",
"name": "Официант",
"parent_id": null,
"updated_at": "2026-03-12T07:48:07.436177Z"
},
{
"id": "31000000-0000-0000-0000-000000000000",
"name": "Официант",
"parent_id": null,
"updated_at": "2026-03-12T07:48:07.436177Z"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Показать сотрудника
Ответ
Поля ответа
data
object
id
string
ID сотрудника Front-офиса.
name
string
Имя сотрудника.
email
string
Email сотрудника.
phone
string
Телефон сотрудника.
updated_at
string
Дата последнего обновления.
parent
object
id
ID родительской группа.
name
Название родительской группа.
Пример ответа
{
"data": {
"id": "31000000-0000-0000-0000-000000000000",
"name": "Официант",
"email": "",
"phone": "",
"updated_at": "2026-03-12T07:48:07.436177Z",
"parent": null
}
}
Прочее
# Способы оплаты
API для работы со справочником способов оплаты.
# Список способов оплаты
Ответ
Поля ответа
data
object
id
string
ID способа оплаты.
name
string
Название способа оплаты на кассе.
system_name
string
Название способа оплаты в бэк-офисе.
type
integer
Тип способа оплаты.
1— Наличные2— Безналичные3— Бонусы4— Долг
terminal_type
integer
Тип терминала для безналичной оплаты.
0— Отсутствует1— Kaspi2— Halyk3— Forte (Pax)4— Forte (Sunmi)
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": [
{
"id": "8b5fcc99-98e1-4d64-915d-dfecfbe2aa72",
"name": "Бонусы 5%",
"system_name": "Бонусы 5%",
"type": 3,
"terminal_type": 0,
"updated_at": "2026-03-12T07:30:58.472553Z"
},
{
"id": "8b5fcc99-98e1-4d64-915d-dfecfbe2aa72",
"name": "Бонусы 5%",
"system_name": "Бонусы 5%",
"type": 3,
"terminal_type": 0,
"updated_at": "2026-03-12T07:30:58.472553Z"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Создать способ оплаты
Ответ
Поля ответа
data
object
id
string
ID способа оплаты.
name
string
Название способа оплаты на кассе.
system_name
string
Название способа оплаты в бэк-офисе.
updated_at
string
Дата последнего обновления.
type
object
value
Тип способа оплаты.
1— Наличные2— Безналичные3— Бонусы4— Долг
label
Описание типа способа оплаты.
terminal_type
object
value
Тип терминала для безналичной оплаты.
0— Отсутствует1— Kaspi2— Halyk3— Forte (Pax)4— Forte (Sunmi)
label
Описание типа терминала.
Пример ответа
{
"data": {
"id": "8b5fcc99-98e1-4d64-915d-dfecfbe2aa72",
"name": "Бонусы 5%",
"system_name": "Бонусы 5%",
"updated_at": "2026-03-12T07:30:58.472553Z",
"type": {
"value": 3,
"label": "Бонусы"
},
"terminal_type": {
"value": 0,
"label": "Отсутствует"
}
}
}
# Показать способ оплаты
Ответ
Поля ответа
data
object
id
string
ID способа оплаты.
name
string
Название способа оплаты на кассе.
system_name
string
Название способа оплаты в бэк-офисе.
updated_at
string
Дата последнего обновления.
type
object
value
Тип способа оплаты.
1— Наличные2— Безналичные3— Бонусы4— Долг
label
Описание типа способа оплаты.
terminal_type
object
value
Тип терминала для безналичной оплаты.
0— Отсутствует1— Kaspi2— Halyk3— Forte (Pax)4— Forte (Sunmi)
label
Описание типа терминала.
Пример ответа
{
"data": {
"id": "8b5fcc99-98e1-4d64-915d-dfecfbe2aa72",
"name": "Бонусы 5%",
"system_name": "Бонусы 5%",
"updated_at": "2026-03-12T07:30:58.472553Z",
"type": {
"value": 3,
"label": "Бонусы"
},
"terminal_type": {
"value": 0,
"label": "Отсутствует"
}
}
}
# Редактировать способ оплаты
Ответ
Поля ответа
data
object
id
string
ID способа оплаты.
name
string
Название способа оплаты на кассе.
system_name
string
Название способа оплаты в бэк-офисе.
updated_at
string
Дата последнего обновления.
type
object
value
Тип способа оплаты.
1— Наличные2— Безналичные3— Бонусы4— Долг
label
Описание типа способа оплаты.
terminal_type
object
value
Тип терминала для безналичной оплаты.
0— Отсутствует1— Kaspi2— Halyk3— Forte (Pax)4— Forte (Sunmi)
label
Описание типа терминала.
Пример ответа
{
"data": {
"id": "8b5fcc99-98e1-4d64-915d-dfecfbe2aa72",
"name": "Бонусы 5%",
"system_name": "Бонусы 5%",
"updated_at": "2026-03-12T07:30:58.472553Z",
"type": {
"value": 3,
"label": "Бонусы"
},
"terminal_type": {
"value": 0,
"label": "Отсутствует"
}
}
}
# Удалить способ оплаты
# Принтеры
API для работы со справочником принтеров.
# Список принтеров
Ответ
Поля ответа
data
object
id
string
ID принтера.
name
string
Название принтера.
system_name
string
Системное название принтера.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": [
{
"id": "9d6b9526-865d-45c3-a11c-acf8d9a4d59b",
"name": "Бар",
"system_name": "bar",
"updated_at": "2026-03-12T07:30:59.011717Z"
},
{
"id": "9d6b9526-865d-45c3-a11c-acf8d9a4d59b",
"name": "Бар",
"system_name": "bar",
"updated_at": "2026-03-12T07:30:59.011717Z"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Создать принтер
Ответ
Поля ответа
data
object
id
string
ID принтера.
name
string
Название принтера.
system_name
string
Системное название принтера.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": {
"id": "9d6b9526-865d-45c3-a11c-acf8d9a4d59b",
"name": "Бар",
"system_name": "bar",
"updated_at": "2026-03-12T07:30:59.011717Z"
}
}
# Показать принтер
Ответ
Поля ответа
data
object
id
string
ID принтера.
name
string
Название принтера.
system_name
string
Системное название принтера.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": {
"id": "9d6b9526-865d-45c3-a11c-acf8d9a4d59b",
"name": "Бар",
"system_name": "bar",
"updated_at": "2026-03-12T07:30:59.011717Z"
}
}
# Редактировать принтер
Ответ
Поля ответа
data
object
id
string
ID принтера.
name
string
Название принтера.
system_name
string
Системное название принтера.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": {
"id": "9d6b9526-865d-45c3-a11c-acf8d9a4d59b",
"name": "Бар",
"system_name": "bar",
"updated_at": "2026-03-12T07:30:59.011717Z"
}
}
# Удалить принтер
Рабочий процесс
# Счета / чеки
API для работы со справочником счетов / чеков.
# Список счетов / чеков
Ответ
Поля ответа
data
object
id
string
ID счёта.
num
integer
Номер заказа.
status
integer
Статус.
0— Открыт1— Распечатан3— Оплачен
opened_at
string
Время открытия счёта.
closed_at
Время закрытия счёта.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": [
{
"id": "9b27df58-f64b-4baa-9f26-d0a9a67a7206",
"num": 2,
"status": 0,
"opened_at": "2026-03-12T07:47:56.000000Z",
"closed_at": null,
"shift_id": "54ac0af2-b181-413d-9623-58449243e41a",
"client_id": "389562f5-0a98-4ce3-b114-e01d1b77e24d",
"table_id": "bd00e5a9-e4b5-435d-a35f-8f16e7bce615",
"cashbox_id": null,
"updated_at": "2026-03-12T07:48:06.720678Z"
},
{
"id": "9b27df58-f64b-4baa-9f26-d0a9a67a7206",
"num": 2,
"status": 0,
"opened_at": "2026-03-12T07:47:56.000000Z",
"closed_at": null,
"shift_id": "54ac0af2-b181-413d-9623-58449243e41a",
"client_id": "389562f5-0a98-4ce3-b114-e01d1b77e24d",
"table_id": "bd00e5a9-e4b5-435d-a35f-8f16e7bce615",
"cashbox_id": null,
"updated_at": "2026-03-12T07:48:06.720678Z"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Создать счёт / чек
Ответ
Поля ответа
data
object
id
string
ID счёта.
num
integer
Номер заказа.
discount
integer
Процент скидки.
service
integer
Процент наценки.
opened_at
string
Время открытия счёта.
closed_at
Время закрытия счёта.
updated_at
string
Дата последнего обновления.
status
object
value
Код статуса.
0— Открыт1— Распечатан3— Оплачен
label
Описание статуса.
payments
object
accepted
Принято оплаты.
cash
Оплата наличными.
cashless
Оплата безналичными.
bonus
Оплата бонусами.
Пример ответа
{
"data": {
"id": "9b27df58-f64b-4baa-9f26-d0a9a67a7206",
"num": 2,
"discount": 0,
"service": 0,
"opened_at": "2026-03-12T07:47:56.000000Z",
"closed_at": null,
"updated_at": "2026-03-12T07:48:06.720678Z",
"status": {
"value": 0,
"label": "Открыт"
},
"payments": {
"accepted": 0,
"cash": 0,
"cashless": 0,
"bonus": 0,
"other": 0
},
"shift": {
"id": "54ac0af2-b181-413d-9623-58449243e41a",
"opened_at": "2026-03-12T07:43:40.000000Z",
"closed_at": "2026-03-12T07:48:04.000000Z"
},
"client": {
"id": "389562f5-0a98-4ce3-b114-e01d1b77e24d",
"name": "Частное лицо"
},
"table": {
"id": "bd00e5a9-e4b5-435d-a35f-8f16e7bce615",
"name": "Стол 4"
},
"cashbox": null,
"delivery": null,
"items": [
{
"id": "fd2f1a95-4239-459f-9ad9-a6694680e8cc",
"name": "Латте 0,5",
"count": 1,
"price": 1500
}
]
}
}
# Показать счёт / чек
Ответ
Поля ответа
data
object
id
string
ID счёта.
num
integer
Номер заказа.
discount
integer
Процент скидки.
service
integer
Процент наценки.
opened_at
string
Время открытия счёта.
closed_at
Время закрытия счёта.
updated_at
string
Дата последнего обновления.
status
object
value
Код статуса.
0— Открыт1— Распечатан3— Оплачен
label
Описание статуса.
payments
object
accepted
Принято оплаты.
cash
Оплата наличными.
cashless
Оплата безналичными.
bonus
Оплата бонусами.
Пример ответа
{
"data": {
"id": "9b27df58-f64b-4baa-9f26-d0a9a67a7206",
"num": 2,
"discount": 0,
"service": 0,
"opened_at": "2026-03-12T07:47:56.000000Z",
"closed_at": null,
"updated_at": "2026-03-12T07:48:06.720678Z",
"status": {
"value": 0,
"label": "Открыт"
},
"payments": {
"accepted": 0,
"cash": 0,
"cashless": 0,
"bonus": 0,
"other": 0
},
"shift": {
"id": "54ac0af2-b181-413d-9623-58449243e41a",
"opened_at": "2026-03-12T07:43:40.000000Z",
"closed_at": "2026-03-12T07:48:04.000000Z"
},
"client": {
"id": "389562f5-0a98-4ce3-b114-e01d1b77e24d",
"name": "Частное лицо"
},
"table": {
"id": "bd00e5a9-e4b5-435d-a35f-8f16e7bce615",
"name": "Стол 4"
},
"cashbox": null,
"delivery": null,
"items": [
{
"id": "fd2f1a95-4239-459f-9ad9-a6694680e8cc",
"name": "Латте 0,5",
"count": 1,
"price": 1500
}
]
}
}
# Закрыть счёт / чек
Ответ
Поля ответа
data
object
id
string
ID счёта.
num
integer
Номер заказа.
discount
integer
Процент скидки.
service
integer
Процент наценки.
opened_at
string
Время открытия счёта.
closed_at
Время закрытия счёта.
updated_at
string
Дата последнего обновления.
status
object
value
Код статуса.
0— Открыт1— Распечатан3— Оплачен
label
Описание статуса.
payments
object
accepted
Принято оплаты.
cash
Оплата наличными.
cashless
Оплата безналичными.
bonus
Оплата бонусами.
Пример ответа
{
"data": {
"id": "9b27df58-f64b-4baa-9f26-d0a9a67a7206",
"num": 2,
"discount": 0,
"service": 0,
"opened_at": "2026-03-12T07:47:56.000000Z",
"closed_at": null,
"updated_at": "2026-03-12T07:48:06.720678Z",
"status": {
"value": 0,
"label": "Открыт"
},
"payments": {
"accepted": 0,
"cash": 0,
"cashless": 0,
"bonus": 0,
"other": 0
},
"shift": {
"id": "54ac0af2-b181-413d-9623-58449243e41a",
"opened_at": "2026-03-12T07:43:40.000000Z",
"closed_at": "2026-03-12T07:48:04.000000Z"
},
"client": {
"id": "389562f5-0a98-4ce3-b114-e01d1b77e24d",
"name": "Частное лицо"
},
"table": {
"id": "bd00e5a9-e4b5-435d-a35f-8f16e7bce615",
"name": "Стол 4"
},
"cashbox": null,
"delivery": null,
"items": [
{
"id": "fd2f1a95-4239-459f-9ad9-a6694680e8cc",
"name": "Латте 0,5",
"count": 1,
"price": 1500
}
]
}
}
# Смены
API для работы со сменами.
# Список смен
Ответ
Поля ответа
data
object
id
string
ID смены.
opened_at
string
Время открытия смены.
closed_at
string
Время закрытия смены.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": [
{
"id": "54ac0af2-b181-413d-9623-58449243e41a",
"user_id": "31000000-0000-0000-0000-000000000000",
"tradepoint_id": "c16e7a99-b421-4476-b5c4-21e7196ecc5e",
"workplace_group_id": null,
"opened_at": "2026-03-12T07:43:40.000000Z",
"closed_at": "2026-03-12T07:48:04.000000Z",
"updated_at": "2026-03-12T07:48:07.175258Z"
},
{
"id": "54ac0af2-b181-413d-9623-58449243e41a",
"user_id": "31000000-0000-0000-0000-000000000000",
"tradepoint_id": "c16e7a99-b421-4476-b5c4-21e7196ecc5e",
"workplace_group_id": null,
"opened_at": "2026-03-12T07:43:40.000000Z",
"closed_at": "2026-03-12T07:48:04.000000Z",
"updated_at": "2026-03-12T07:48:07.175258Z"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 2,
"total": 2
}
}
# Создать смену
Ответ
Поля ответа
data
object
id
string
ID смены.
opened_at
string
Время открытия смены.
closed_at
string
Время закрытия смены.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": {
"id": "54ac0af2-b181-413d-9623-58449243e41a",
"opened_at": "2026-03-12T07:43:40.000000Z",
"closed_at": "2026-03-12T07:48:04.000000Z",
"updated_at": "2026-03-12T07:48:07.175258Z",
"user": {
"id": "31000000-0000-0000-0000-000000000000",
"name": "Официант"
},
"tradepoint": {
"id": "c16e7a99-b421-4476-b5c4-21e7196ecc5e",
"name": "Ресторан \"Победа\""
},
"workplace_group": null
}
}
# Показать смену
Ответ
Поля ответа
data
object
id
string
ID смены.
opened_at
string
Время открытия смены.
closed_at
string
Время закрытия смены.
updated_at
string
Дата последнего обновления.
Пример ответа
{
"data": {
"id": "54ac0af2-b181-413d-9623-58449243e41a",
"opened_at": "2026-03-12T07:43:40.000000Z",
"closed_at": "2026-03-12T07:48:04.000000Z",
"updated_at": "2026-03-12T07:48:07.175258Z",
"user": {
"id": "31000000-0000-0000-0000-000000000000",
"name": "Официант"
},
"tradepoint": {
"id": "c16e7a99-b421-4476-b5c4-21e7196ecc5e",
"name": "Ресторан \"Победа\""
},
"workplace_group": null
}
}
# Закрыть смену