Введение

Публичный API Rosta.

API находится на стадии alpha-тестирования.

Аутентификация

Для аутентификации необходимо отправлять заголовок Authorization со значением "Bearer {API_KEY}".

Инфраструктура

# Торговые точки

API для работы со справочником торговых точек.

# Список торговых точек

Запрос   

GET /tradepoints

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/tradepoints
GET https://next.rosta.kz/api/client/public/tradepoints?show_removed=1

Ответ

Поля ответа

data   object     
id   string     

ID торговой точки.

name   string     

Название торговой точки.

doc_prefix   string     

Префикс документов.

warehouse_id   string     
is_removed   boolean     

Удалена ли запись.

updated_at   string     

Дата последнего обновления.

Пример ответа

{
    "data": [
        {
            "id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
            "name": "Магазин \"Clothes\" ",
            "doc_prefix": "",
            "warehouse_id": "62f8ec81-5cf6-4072-bd89-cfd033454f0e",
            "is_removed": false,
            "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",
            "is_removed": false,
            "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
    }
}

# Показать торговую точку

Запрос   

GET /tradepoints/{id}

Параметры URL

id   string     

ID торговой точки.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/tradepoints/00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

data   object     
id   string     

ID торговой точки.

name   string     

Название торговой точки.

service   integer     

Процент наценки.

discount   integer     

Процент скидки.

address   string     

Адрес торговой точки.

doc_prefix   string     

Префикс документов.

updated_at   string     

Дата последнего обновления.

warehouse   object     
id        
name        

Название склада.

Пример ответа

{
    "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 для работы со справочником рабочих мест.

# Список групп рабочих мест

Запрос   

GET /workplaces/groups

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/workplaces/groups
GET https://next.rosta.kz/api/client/public/workplaces/groups?show_removed=1

Ответ

Пример ответа

{
    "data": [
        {
            "id": null,
            "name": null,
            "updated_at": null,
            "tradepoint_id": null,
            "is_removed": null
        },
        {
            "id": null,
            "name": null,
            "updated_at": null,
            "tradepoint_id": null,
            "is_removed": null
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

# Показать группу рабочих мест

Запрос   

GET /workplaces/groups/{id}

Параметры URL

id   string     

ID группы рабочих мест.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/workplaces/groups/00000000-0000-0000-0000-000000000001

Ответ

Пример ответа

{
    "data": {
        "id": null,
        "name": null,
        "updated_at": null,
        "tradepoint": null
    }
}

# Список рабочих мест

Запрос   

GET /workplaces

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/workplaces
GET https://next.rosta.kz/api/client/public/workplaces?show_removed=1

Ответ

Поля ответа

data   object     
id   string     

ID рабочего места.

name   string     

Название рабочего места.

parent_id        
cashbox_id   string     
tradepoint_id   string     
is_removed   boolean     

Удалена ли запись.

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",
            "is_removed": false,
            "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",
            "is_removed": false,
            "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
    }
}

# Показать рабочее место

Запрос   

GET /workplaces/{id}

Параметры URL

id   string     

ID рабочего места.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/workplaces/00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

data   object     
id   string     

ID рабочего места.

name   string     

Название рабочего места.

updated_at   string     

Дата последнего обновления.

parent   object     
name        
cashbox   object     
id        
name        

Название кассы.

tradepoint   object     
id        
name        

Название торговой точки.

Пример ответа

{
    "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 для работы со справочником складов.

# Список складов

Запрос   

GET /warehouses

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/warehouses
GET https://next.rosta.kz/api/client/public/warehouses?show_removed=1

Ответ

Поля ответа

data   object     
id   string     

ID склада.

name   string     

Название склада.

tradepoint_id   string     
is_removed   boolean     

Удалена ли запись.

updated_at   string     

Дата последнего обновления.

Пример ответа

{
    "data": [
        {
            "id": "62f8ec81-5cf6-4072-bd89-cfd033454f0e",
            "name": "Магазин ",
            "tradepoint_id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
            "is_removed": false,
            "updated_at": "2026-03-12T07:30:49.841854Z"
        },
        {
            "id": "62f8ec81-5cf6-4072-bd89-cfd033454f0e",
            "name": "Магазин ",
            "tradepoint_id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
            "is_removed": false,
            "updated_at": "2026-03-12T07:30:49.841854Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

# Создать склад

Запрос   

POST /warehouses

Тело запроса

name   string     

Название склада. Количество символов в значении поля value не может превышать 50.
Пример: Основной склад

is_limit   boolean  необязательно    

Ограничивать продажи.
Пример: true

tradepoint_id   string     

ID торговой точки.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

POST https://next.rosta.kz/api/client/public/warehouses
{
    "name": "Основной склад",
    "is_limit": true,
    "tradepoint_id": "00000000-0000-0000-0000-000000000001"
}

Ответ

Поля ответа

data   object     
id   string     

ID склада.

name   string     

Название склада.

is_limit   boolean     

Ограничены ли продажи.

updated_at   string     

Дата последнего обновления.

tradepoint   object     
id        
name        

Название торговой точки.

Пример ответа

{
    "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\" "
        }
    }
}

# Показать склад

Запрос   

GET /warehouses/{id}

Параметры URL

id   string     

ID склада.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/warehouses/00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

data   object     
id   string     

ID склада.

name   string     

Название склада.

is_limit   boolean     

Ограничены ли продажи.

updated_at   string     

Дата последнего обновления.

tradepoint   object     
id        
name        

Название торговой точки.

Пример ответа

{
    "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\" "
        }
    }
}

# Редактировать склад

Запрос   

PUT /warehouses/{id}

PATCH /warehouses/{id}

Параметры URL

id   string     

ID склада.
Пример: 00000000-0000-0000-0000-000000000001

Тело запроса

name   string     

Название склада. Количество символов в значении поля value не может превышать 50.
Пример: Основной склад

is_limit   boolean  необязательно    

Ограничивать продажи.
Пример: true

tradepoint_id   string     

ID торговой точки.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

PUT https://next.rosta.kz/api/client/public/warehouses/00000000-0000-0000-0000-000000000001
{
    "name": "Основной склад",
    "is_limit": true,
    "tradepoint_id": "00000000-0000-0000-0000-000000000001"
}

Ответ

Поля ответа

data   object     
id   string     

ID склада.

name   string     

Название склада.

is_limit   boolean     

Ограничены ли продажи.

updated_at   string     

Дата последнего обновления.

tradepoint   object     
id        
name        

Название торговой точки.

Пример ответа

{
    "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\" "
        }
    }
}

# Удалить склад

Запрос   

DELETE /warehouses/{id}

Параметры URL

id   string     

ID склада.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

DELETE https://next.rosta.kz/api/client/public/warehouses/00000000-0000-0000-0000-000000000001

# Остатки склада

Запрос   

POST /warehouses/{id}/items

Параметры URL

id   string     

ID склада.
Пример: 00000000-0000-0000-0000-000000000001

Тело запроса

date   string  необязательно    

Дата выборки. Значение поля value должно быть корректной датой.
Пример: 2025-06-29 06:46:18

items   object[]  необязательно    

Список товаров.
item_id   string  необязательно    

ID [товара].
Пример: 00000000-0000-0000-0000-000000000001

attribute_id   string  необязательно    

ID [атрибута].
Пример: 00000000-0000-0000-0000-000000000001

date   string  необязательно    

Дата выборки. Значение поля value должно быть корректной датой.
Пример: 2025-06-29 06:46:18

Пример запроса

POST https://next.rosta.kz/api/client/public/warehouses/00000000-0000-0000-0000-000000000001/items
{
    "date": "2025-06-29 06:46:18",
    "items": [
        {
            "item_id": "00000000-0000-0000-0000-000000000001",
            "attribute_id": "00000000-0000-0000-0000-000000000001",
            "date": "2025-06-29 06:46:18"
        }
    ]
}

Ответ

Поля ответа

data   object     
id   string     

ID склада.

name   string     

Название склада.

is_limit   boolean     

Ограничены ли продажи.

updated_at   string     

Дата последнего обновления.

tradepoint   object     
id        
name        

Название торговой точки.

Пример ответа

{
    "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 для работы со справочником помещений.

# Список помещений

Запрос   

GET /rooms

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/rooms
GET https://next.rosta.kz/api/client/public/rooms?show_removed=1

Ответ

Поля ответа

data   object     
id   string     

ID помещения.

name   string     

Название помещения.

parent_id        

ID родительского помещения.

is_tradepoint   boolean     

Является ли торговой точкой.

is_removed   boolean     

Удалена ли запись.

updated_at   string     

Дата последнего обновления.

Пример ответа

{
    "data": [
        {
            "id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
            "name": "Магазин \"Clothes\" ",
            "parent_id": null,
            "is_tradepoint": true,
            "is_removed": false,
            "updated_at": "2026-03-12 07:32:35.577666"
        },
        {
            "id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
            "name": "Магазин \"Clothes\" ",
            "parent_id": null,
            "is_tradepoint": true,
            "is_removed": false,
            "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
    }
}

# Создать помещение

Запрос   

POST /rooms

Тело запроса

name   string     

Название помещения. Количество символов в значении поля value не может превышать 100.
Пример: Главный зал

parent_id   string     

ID родительского помещения.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

POST https://next.rosta.kz/api/client/public/rooms
{
    "name": "Главный зал",
    "parent_id": "00000000-0000-0000-0000-000000000001"
}

Ответ

Поля ответа

data   object     
id   string     

ID помещения.

name   string     

Название помещения.

is_tradepoint   boolean     

Является ли торговой точкой.

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
    }
}

# Показать помещение

Запрос   

GET /rooms/{id}

Параметры URL

id   string     

ID помещения.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/rooms/00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

data   object     
id   string     

ID помещения.

name   string     

Название помещения.

is_tradepoint   boolean     

Является ли торговой точкой.

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
    }
}

# Редактировать помещение

Запрос   

PUT /rooms/{id}

PATCH /rooms/{id}

Параметры URL

id   string     

ID помещения.
Пример: 00000000-0000-0000-0000-000000000001

Тело запроса

name   string     

Название помещения. Количество символов в значении поля value не может превышать 100.
Пример: Главный зал

parent_id   string     

ID родительского помещения.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

PUT https://next.rosta.kz/api/client/public/rooms/00000000-0000-0000-0000-000000000001
{
    "name": "Главный зал",
    "parent_id": "00000000-0000-0000-0000-000000000001"
}

Ответ

Поля ответа

data   object     
id   string     

ID помещения.

name   string     

Название помещения.

is_tradepoint   boolean     

Является ли торговой точкой.

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
    }
}

# Удалить помещение

Запрос   

DELETE /rooms/{id}

Параметры URL

id   string     

ID помещения.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

DELETE https://next.rosta.kz/api/client/public/rooms/00000000-0000-0000-0000-000000000001

# Столы

API для работы со справочником столов.

# Список столов

Запрос   

GET /tables

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/tables
GET https://next.rosta.kz/api/client/public/tables?show_removed=1

Ответ

Поля ответа

data   object     
id   string     

ID стола.

name   string     

Название стола.

room_id   string     

ID родительского помещения.

is_removed   boolean     

Удалена ли запись.

updated_at   string     

Дата последнего обновления.

Пример ответа

{
    "data": [
        {
            "id": "e1d2a19a-e565-4c4a-a80c-118602d41f72",
            "name": "Стол 7",
            "room_id": "a4965983-d869-42bf-8c23-6b3027cd304d",
            "is_removed": false,
            "updated_at": "2026-03-12 07:30:59.644310"
        },
        {
            "id": "e1d2a19a-e565-4c4a-a80c-118602d41f72",
            "name": "Стол 7",
            "room_id": "a4965983-d869-42bf-8c23-6b3027cd304d",
            "is_removed": false,
            "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
    }
}

# Создать стол

Запрос   

POST /tables

Тело запроса

name   string     

Название стола. Количество символов в значении поля value не может превышать 50.
Пример: Стол 42

discount   number  необязательно    

Процент скидки. Значение поля value должно быть не меньше 0. Значение поля value не может быть больше 100.
Пример: 5

service   number  необязательно    

Процент наценки. Значение поля value должно быть не меньше 0. Значение поля value не может быть больше 100.
Пример: 15

room_id   string     


Пример: architecto

Пример запроса

POST https://next.rosta.kz/api/client/public/tables
{
    "name": "Стол 42",
    "discount": 5,
    "service": 15,
    "room_id": "architecto"
}

Ответ

Поля ответа

data   object     
id   string     

ID стола.

name   string     

Название стола.

full_name   string     

Полное название стола.

service        

Процент наценки.

discount        

Процент скидки.

updated_at   string     

Дата последнего обновления.

room   object     
id        

ID родительского помещения.

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": "Терраса"
        }
    }
}

# Показать стол

Запрос   

GET /tables/{id}

Параметры URL

id   string     

ID стола.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/tables/00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

data   object     
id   string     

ID стола.

name   string     

Название стола.

full_name   string     

Полное название стола.

service        

Процент наценки.

discount        

Процент скидки.

updated_at   string     

Дата последнего обновления.

room   object     
id        

ID родительского помещения.

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": "Терраса"
        }
    }
}

# Редактировать стол

Запрос   

PUT /tables/{id}

PATCH /tables/{id}

Параметры URL

id   string     

ID стола.
Пример: 00000000-0000-0000-0000-000000000001

Тело запроса

name   string     

Название стола. Количество символов в значении поля value не может превышать 50.
Пример: Стол 42

discount   number  необязательно    

Процент скидки. Значение поля value должно быть не меньше 0. Значение поля value не может быть больше 100.
Пример: 5

service   number  необязательно    

Процент наценки. Значение поля value должно быть не меньше 0. Значение поля value не может быть больше 100.
Пример: 15

room_id   string     


Пример: architecto

Пример запроса

PUT https://next.rosta.kz/api/client/public/tables/00000000-0000-0000-0000-000000000001
{
    "name": "Стол 42",
    "discount": 5,
    "service": 15,
    "room_id": "architecto"
}

Ответ

Поля ответа

data   object     
id   string     

ID стола.

name   string     

Название стола.

full_name   string     

Полное название стола.

service        

Процент наценки.

discount        

Процент скидки.

updated_at   string     

Дата последнего обновления.

room   object     
id        

ID родительского помещения.

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": "Терраса"
        }
    }
}

# Удалить стол

Запрос   

DELETE /tables/{id}

Параметры URL

id   string     

ID стола.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

DELETE https://next.rosta.kz/api/client/public/tables/00000000-0000-0000-0000-000000000001

# Кассы

API для работы со справочником касс.

# Список касс

Запрос   

GET /cashboxes

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/cashboxes
GET https://next.rosta.kz/api/client/public/cashboxes?show_removed=1

Ответ

Поля ответа

data   object     
id   string     

ID кассы.

name   string     

Название кассы.

type   integer     

Тип кассы.

Одно из:
  • -1 — Неизвестно
  • 0 — Стандартная
  • 1 — Webkassa
  • 2 — Trinity
  • 3 — E-Kassa
  • 4 — Kaspi Касса
  • 5 — Multikassa
tradepoint_id   string     
is_removed   boolean     

Удалена ли запись.

updated_at   string     

Дата последнего обновления.

Пример ответа

{
    "data": [
        {
            "id": "af909040-eee2-4fb4-b090-8acee5cdad14",
            "name": "Касса",
            "type": 0,
            "tradepoint_id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
            "is_removed": false,
            "updated_at": "2026-03-12T07:30:49.853993Z"
        },
        {
            "id": "af909040-eee2-4fb4-b090-8acee5cdad14",
            "name": "Касса",
            "type": 0,
            "tradepoint_id": "c2cd33cb-1189-4c11-b5ae-3e8375dbee52",
            "is_removed": false,
            "updated_at": "2026-03-12T07:30:49.853993Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

# Создать кассу

Запрос   

POST /cashboxes

Тело запроса

name   string     

Название кассы. Количество символов в значении поля value не может превышать 50.
Пример: Моя касса

tradepoint_id   string     

ID торговой точки.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

POST https://next.rosta.kz/api/client/public/cashboxes
{
    "name": "Моя касса",
    "tradepoint_id": "00000000-0000-0000-0000-000000000001"
}

Ответ

Поля ответа

data   object     
id   string     

ID кассы.

name   string     

Название кассы.

updated_at   string     

Дата последнего обновления.

type   object     
value        

Тип кассы.

Одно из:
  • -1 — Неизвестно
  • 0 — Стандартная
  • 1 — Webkassa
  • 2 — Trinity
  • 3 — E-Kassa
  • 4 — Kaspi Касса
  • 5 — Multikassa
label        

Описание типа кассы.

tradepoint   object     
id        
name        

Название торговой точки.

Пример ответа

{
    "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\" "
        }
    }
}

# Показать кассу

Запрос   

GET /cashboxes/{id}

Параметры URL

id   string     

ID кассы.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/cashboxes/00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

data   object     
id   string     

ID кассы.

name   string     

Название кассы.

updated_at   string     

Дата последнего обновления.

type   object     
value        

Тип кассы.

Одно из:
  • -1 — Неизвестно
  • 0 — Стандартная
  • 1 — Webkassa
  • 2 — Trinity
  • 3 — E-Kassa
  • 4 — Kaspi Касса
  • 5 — Multikassa
label        

Описание типа кассы.

tradepoint   object     
id        
name        

Название торговой точки.

Пример ответа

{
    "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\" "
        }
    }
}

# Редактировать кассу

Запрос   

PUT /cashboxes/{id}

PATCH /cashboxes/{id}

Параметры URL

id   string     

ID кассы.
Пример: 00000000-0000-0000-0000-000000000001

Тело запроса

name   string     

Название кассы. Количество символов в значении поля value не может превышать 50.
Пример: Моя касса

tradepoint_id   string     

ID торговой точки.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

PUT https://next.rosta.kz/api/client/public/cashboxes/00000000-0000-0000-0000-000000000001
{
    "name": "Моя касса",
    "tradepoint_id": "00000000-0000-0000-0000-000000000001"
}

Ответ

Поля ответа

data   object     
id   string     

ID кассы.

name   string     

Название кассы.

updated_at   string     

Дата последнего обновления.

type   object     
value        

Тип кассы.

Одно из:
  • -1 — Неизвестно
  • 0 — Стандартная
  • 1 — Webkassa
  • 2 — Trinity
  • 3 — E-Kassa
  • 4 — Kaspi Касса
  • 5 — Multikassa
label        

Описание типа кассы.

tradepoint   object     
id        
name        

Название торговой точки.

Пример ответа

{
    "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\" "
        }
    }
}

# Удалить кассу

Запрос   

DELETE /cashboxes/{id}

Параметры URL

id   string     

ID кассы.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

DELETE https://next.rosta.kz/api/client/public/cashboxes/00000000-0000-0000-0000-000000000001

Номенклатура

# Товары и услуги

API для работы со справочником номенклатуры.

# Список товаров / услуг

Запрос   

GET /items

Параметры запроса

price_type_id   string  необязательно    

ID вида цены для отображения.
По-умолчанию — Розница.
Пример: 00000000-0000-0000-0000-000000000001

parent_id   string  необязательно    

ID родительской группы.
Пример: 00000000-0000-0000-0000-000000000001

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

page_size   integer  необязательно    

Количество элементов на странице.
По-умолчанию — 20. Значение поля value должно быть не меньше 1. Значение поля value не может быть больше 500.
Пример: 150

Пример запроса

GET https://next.rosta.kz/api/client/public/items
GET https://next.rosta.kz/api/client/public/items?price_type_id=00000000-0000-0000-0000-000000000001&parent_id=00000000-0000-0000-0000-000000000001&show_removed=1&page_size=150

Ответ

Поля ответа

data   object     
id   string     

ID товара.

name   string     

Название товара.

price   integer     

Цена товара.

article        

Артикул товара.

type_id   string     
unit_id   string     
parent_id   string     

ID родительской группы.

is_removed   boolean     

Удалена ли запись.

updated_at   string     

Дата последнего обновления.

Пример ответа

{
    "data": [
        {
            "id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
            "name": "Футболка приталенная",
            "price": 25000,
            "article": null,
            "type_id": "8d57db04-83fd-4515-aef3-caef839038c5",
            "unit_id": "00000000-0000-0000-0000-000020493d02",
            "parent_id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
            "is_removed": false,
            "updated_at": "2026-03-12T07:30:57.315235Z"
        },
        {
            "id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
            "name": "Футболка приталенная",
            "price": 25000,
            "article": null,
            "type_id": "8d57db04-83fd-4515-aef3-caef839038c5",
            "unit_id": "00000000-0000-0000-0000-000020493d02",
            "parent_id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
            "is_removed": false,
            "updated_at": "2026-03-12T07:30:57.315235Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

# Создать товар / услугу

Запрос   

POST /items

Тело запроса

name   string     

Наименование товара. Количество символов в значении поля value не может превышать 255.
Пример: Футболка

is_visible   boolean  необязательно    

Использовать в продажах.
Пример: true

is_quick   boolean  необязательно    

Показывать в быстрых товарах.
Пример: false

is_weight   boolean  необязательно    

Весовой товар.
Пример: false

parent_id   string  необязательно    

ID родительской группы.
Пример: 00000000-0000-0000-0000-000000000001

unit_id   string     

ID единицы измерения.
Пример: 00000000-0000-0000-0000-000000000001

type_id   string     

ID вида номенклатуры.
Пример: 00000000-0000-0000-0000-000000000001

prices   object[]     

Список цен.
id   string     

ID вида цены.
Пример: 00000000-0000-0000-0000-000000000001

value   number     

Цена. Значение поля value должно быть не меньше 0.
Пример: 1000

Пример запроса

POST https://next.rosta.kz/api/client/public/items
{
    "name": "Футболка",
    "is_visible": true,
    "is_quick": false,
    "is_weight": false,
    "parent_id": "00000000-0000-0000-0000-000000000001",
    "unit_id": "00000000-0000-0000-0000-000000000001",
    "type_id": "00000000-0000-0000-0000-000000000001",
    "prices": [
        {
            "id": "00000000-0000-0000-0000-000000000001",
            "value": 1000
        }
    ]
}

Ответ

Поля ответа

data   object     
id   string     

ID товара.

name   string     

Название товара.

price   integer     

Цена товара.

article        

Артикул товара.

is_weight   boolean     

Весовой товар.

is_quick   boolean     

Показывать в быстрых товарах.

updated_at   string     

Дата последнего обновления.

type   object     
id        
name        
unit   object     
id        
name        

Краткое название единицы измерения.

full_name        

Полное название единицы измерения.

parent   object     
id        

ID родительской группы.

name        

Название родительской группы.

Пример ответа

{
    "data": {
        "id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
        "name": "Футболка приталенная",
        "price": 25000,
        "article": null,
        "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": "Футболки"
        }
    }
}

# Показать товар / услугу

Запрос   

GET /items/{id}

Параметры URL

id   string     

ID товара.
Пример: 00000000-0000-0000-0000-000000000001

Параметры запроса

price_type_id   string  необязательно    

ID вида цены для отображения.
По-умолчанию — Розница.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/items/00000000-0000-0000-0000-000000000001
GET https://next.rosta.kz/api/client/public/items/00000000-0000-0000-0000-000000000001?price_type_id=00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

data   object     
id   string     

ID товара.

name   string     

Название товара.

price   integer     

Цена товара.

article        

Артикул товара.

is_weight   boolean     

Весовой товар.

is_quick   boolean     

Показывать в быстрых товарах.

updated_at   string     

Дата последнего обновления.

type   object     
id        
name        
unit   object     
id        
name        

Краткое название единицы измерения.

full_name        

Полное название единицы измерения.

parent   object     
id        

ID родительской группы.

name        

Название родительской группы.

Пример ответа

{
    "data": {
        "id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
        "name": "Футболка приталенная",
        "price": 25000,
        "article": null,
        "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": "Футболки"
        }
    }
}

# Редактировать товар / услугу

Запрос   

PUT /items/{id}

PATCH /items/{id}

Параметры URL

id   string     

ID товара.
Пример: 00000000-0000-0000-0000-000000000001

Тело запроса

name   string     

Наименование товара. Количество символов в значении поля value не может превышать 255.
Пример: Футболка

is_visible   boolean  необязательно    

Использовать в продажах.
Пример: true

is_quick   boolean  необязательно    

Показывать в быстрых товарах.
Пример: false

is_weight   boolean  необязательно    

Весовой товар.
Пример: false

parent_id   string  необязательно    

ID родительской группы.
Пример: 00000000-0000-0000-0000-000000000001

unit_id   string     

ID единицы измерения.
Пример: 00000000-0000-0000-0000-000000000001

type_id   string     

ID вида номенклатуры.
Пример: 00000000-0000-0000-0000-000000000001

prices   object[]     

Список цен.
id   string     

ID вида цены.
Пример: 00000000-0000-0000-0000-000000000001

value   number     

Цена. Значение поля value должно быть не меньше 0.
Пример: 1000

Пример запроса

PUT https://next.rosta.kz/api/client/public/items/00000000-0000-0000-0000-000000000001
{
    "name": "Футболка",
    "is_visible": true,
    "is_quick": false,
    "is_weight": false,
    "parent_id": "00000000-0000-0000-0000-000000000001",
    "unit_id": "00000000-0000-0000-0000-000000000001",
    "type_id": "00000000-0000-0000-0000-000000000001",
    "prices": [
        {
            "id": "00000000-0000-0000-0000-000000000001",
            "value": 1000
        }
    ]
}

Ответ

Поля ответа

data   object     
id   string     

ID товара.

name   string     

Название товара.

price   integer     

Цена товара.

article        

Артикул товара.

is_weight   boolean     

Весовой товар.

is_quick   boolean     

Показывать в быстрых товарах.

updated_at   string     

Дата последнего обновления.

type   object     
id        
name        
unit   object     
id        
name        

Краткое название единицы измерения.

full_name        

Полное название единицы измерения.

parent   object     
id        

ID родительской группы.

name        

Название родительской группы.

Пример ответа

{
    "data": {
        "id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
        "name": "Футболка приталенная",
        "price": 25000,
        "article": null,
        "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": "Футболки"
        }
    }
}

# Удалить товар / услугу

Запрос   

DELETE /items/{id}

Параметры URL

id   string     

ID товара.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

DELETE https://next.rosta.kz/api/client/public/items/00000000-0000-0000-0000-000000000001

# Группы номенклатуры

API для работы со справочником групп/категорий номенклатуры.

# Список групп

Запрос   

GET /items/groups

Параметры запроса

parent_id   string  необязательно    

ID родительской группы.
Пример: 00000000-0000-0000-0000-000000000001

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/items/groups
GET https://next.rosta.kz/api/client/public/items/groups?parent_id=00000000-0000-0000-0000-000000000001&show_removed=1

Ответ

Поля ответа

data   object     
id   string     

ID группы товаров.

name   string     

Название группы.

parent_id        

ID родительской группы.

is_removed   boolean     

Удалена ли запись.

updated_at   string     

Дата последнего обновления.

Пример ответа

{
    "data": [
        {
            "id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
            "name": "Футболки",
            "parent_id": null,
            "is_removed": false,
            "updated_at": "2026-03-12T07:30:57.972226Z"
        },
        {
            "id": "d1c251a4-580a-42ee-b9ee-88f2972e983c",
            "name": "Футболки",
            "parent_id": null,
            "is_removed": false,
            "updated_at": "2026-03-12T07:30:57.972226Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

# Создать группу

Запрос   

POST /items/groups

Тело запроса

name   string     

Название группы. Количество символов в значении поля value не может превышать 255.
Пример: Одежда

is_quick   boolean  необязательно    

Показывать в быстрых товарах.
Пример: false

parent_id   string  необязательно    

ID родительской группы.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

POST https://next.rosta.kz/api/client/public/items/groups
{
    "name": "Одежда",
    "is_quick": false,
    "parent_id": "00000000-0000-0000-0000-000000000001"
}

Ответ

Поля ответа

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
    }
}

# Показать группу

Запрос   

GET /items/groups/{id}

Параметры URL

id   string     

ID группы.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/items/groups/00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

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
    }
}

# Редактировать группу

Запрос   

PUT /items/groups/{id}

PATCH /items/groups/{id}

Параметры URL

id   string     

ID группы.
Пример: 00000000-0000-0000-0000-000000000001

Тело запроса

name   string     

Название группы. Количество символов в значении поля value не может превышать 255.
Пример: Одежда

is_quick   boolean  необязательно    

Показывать в быстрых товарах.
Пример: false

parent_id   string  необязательно    

ID родительской группы.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

PUT https://next.rosta.kz/api/client/public/items/groups/00000000-0000-0000-0000-000000000001
{
    "name": "Одежда",
    "is_quick": false,
    "parent_id": "00000000-0000-0000-0000-000000000001"
}

Ответ

Поля ответа

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
    }
}

# Удалить группу

Запрос   

DELETE /items/groups/{id}

Параметры URL

id   string     

ID группы.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

DELETE https://next.rosta.kz/api/client/public/items/groups/00000000-0000-0000-0000-000000000001

# Характеристики

API для работы со справочником характеристик номенклатуры.

# Список характеристик

Запрос   

GET /items/attributes

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

page_size   integer  необязательно    

Количество элементов на странице.
По-умолчанию — 20. Значение поля value должно быть не меньше 1. Значение поля value не может быть больше 500.
Пример: 150

Пример запроса

GET https://next.rosta.kz/api/client/public/items/attributes
GET https://next.rosta.kz/api/client/public/items/attributes?show_removed=1&page_size=150

Ответ

Поля ответа

data   object     
id   string     

ID характеристики.

name   string     

Название характеристики.

full_name   string     

Полное название характеристики.

item_id   string     

ID связанного товара.

is_removed   boolean     

Удалена ли запись.

updated_at   string     

Дата последнего обновления.

Пример ответа

{
    "data": [
        {
            "id": "84d76dc7-9908-43b2-a045-e089e2b649cf",
            "name": "44, Чёрный",
            "full_name": "Размер: 44, Цвет: Чёрный",
            "item_id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
            "is_removed": false,
            "updated_at": "2026-03-12T07:30:57.514922Z"
        },
        {
            "id": "84d76dc7-9908-43b2-a045-e089e2b649cf",
            "name": "44, Чёрный",
            "full_name": "Размер: 44, Цвет: Чёрный",
            "item_id": "2b33108b-14f9-4a8f-b502-08b9f7a89d2d",
            "is_removed": false,
            "updated_at": "2026-03-12T07:30:57.514922Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

# Показать характеристику

Запрос   

GET /items/attributes/{id}

Параметры URL

id   string     

ID характеристики.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/items/attributes/00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

data   object     
id   string     

ID характеристики.

name   string     

Название характеристики.

full_name   string     

Полное название характеристики.

updated_at   string     

Дата последнего обновления.

item   object     
id        

ID связанного товара.

name        

Название связанного товара.

Пример ответа

{
    "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 для работы со справочником штрихкодов.

# Список штрихкодов

Запрос   

GET /barcodes

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

page_size   integer  необязательно    

Количество элементов на странице.
По-умолчанию — 20. Значение поля value должно быть не меньше 1. Значение поля value не может быть больше 500.
Пример: 150

Пример запроса

GET https://next.rosta.kz/api/client/public/barcodes
GET https://next.rosta.kz/api/client/public/barcodes?show_removed=1&page_size=150

Ответ

Поля ответа

data   object     
id   string     

ID штрихкода.

barcode   string     

Штрихкод.

ntin        

NTIN из национального каталога товаров.

item_id   string     
attribute_id   string     
is_removed   boolean     

Удалена ли запись.

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",
            "is_removed": false,
            "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",
            "is_removed": false,
            "updated_at": "2026-03-12T07:30:56.354493Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

# Создать штрихкод

Запрос   

POST /barcodes

Тело запроса

barcode   string     

Штрихкод. Количество символов в значении поля value не может превышать 255.
Пример: 2000000000000

item_id   string     

ID товара.
Пример: 00000000-0000-0000-0000-000000000001

attribute_id   string  необязательно    

ID характеристики.
Пример: 00000000-0000-0000-0000-000000000001

ntin   string  необязательно    

NTIN из национального каталога товаров. Количество символов в значении поля value не может превышать 13.
Пример: 0200000000000

Пример запроса

POST https://next.rosta.kz/api/client/public/barcodes
{
    "barcode": "2000000000000",
    "item_id": "00000000-0000-0000-0000-000000000001",
    "attribute_id": "00000000-0000-0000-0000-000000000001",
    "ntin": "0200000000000"
}

Ответ

Поля ответа

data   object     
id   string     

ID штрихкода.

barcode   string     

Штрихкод.

ntin        

NTIN из национального каталога товаров.

updated_at   string     

Дата последнего обновления.

item   object     
id        
name        

Название товара.

attribute   object     
name        

Пример ответа

{
    "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, Чёрный"
        }
    }
}

# Показать штрихкод

Запрос   

GET /barcodes/{id}

Параметры URL

id   string     

ID штрихкода.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/barcodes/00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

data   object     
id   string     

ID штрихкода.

barcode   string     

Штрихкод.

ntin        

NTIN из национального каталога товаров.

updated_at   string     

Дата последнего обновления.

item   object     
id        
name        

Название товара.

attribute   object     
name        

Пример ответа

{
    "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, Чёрный"
        }
    }
}

# Удалить штрихкод

Запрос   

DELETE /barcodes/{id}

Параметры URL

id   string     

ID штрихкода.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

DELETE https://next.rosta.kz/api/client/public/barcodes/00000000-0000-0000-0000-000000000001

# Виды цен

API для работы со справочником видов цен.

# Список видов цен

Запрос   

GET /price-types

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/price-types
GET https://next.rosta.kz/api/client/public/price-types?show_removed=1

Ответ

Поля ответа

data   object     
id   string     

ID вида цены.

name   string     

Название вида цены.

is_removed   boolean     

Удалена ли запись.

updated_at   string     

Дата последнего обновления.

Пример ответа

{
    "data": [
        {
            "id": "00000000-0000-0000-0000-000000000004",
            "name": "Оптом",
            "is_removed": false,
            "updated_at": "2026-03-11T05:12:16.267134Z"
        },
        {
            "id": "00000000-0000-0000-0000-000000000004",
            "name": "Оптом",
            "is_removed": false,
            "updated_at": "2026-03-11T05:12:16.267134Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

# Создать вид цены

Запрос   

POST /price-types

Тело запроса

name   string     

Название вида цены. Количество символов в значении поля value не может превышать 50.
Пример: Новый вид цены

Пример запроса

POST https://next.rosta.kz/api/client/public/price-types
{
    "name": "Новый вид цены"
}

Ответ

Поля ответа

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"
    }
}

# Показать вид цены

Запрос   

GET /price-types/{id}

Параметры URL

id   string     

ID вида цен.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/price-types/00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

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"
    }
}

# Редактировать вид цены

Запрос   

PUT /price-types/{id}

PATCH /price-types/{id}

Параметры URL

id   string     

ID вида цен.
Пример: 00000000-0000-0000-0000-000000000001

Тело запроса

name   string     

Название вида цены. Количество символов в значении поля value не может превышать 50.
Пример: Новый вид цены

Пример запроса

PUT https://next.rosta.kz/api/client/public/price-types/00000000-0000-0000-0000-000000000001
{
    "name": "Новый вид цены"
}

Ответ

Поля ответа

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"
    }
}

# Удалить вид цены

Запрос   

DELETE /price-types/{id}

Параметры URL

id   string     

ID вида цен.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

DELETE https://next.rosta.kz/api/client/public/price-types/00000000-0000-0000-0000-000000000001

# Модификаторы

API для работы со справочником модификаторов.

# Список модификаторов.

Запрос   

GET /items/modifiers

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/items/modifiers
GET https://next.rosta.kz/api/client/public/items/modifiers?show_removed=1

Ответ

Поля ответа

data   object     
id        

ID модификатора.

parent_item_id        

ID товара для модификатора.

item_id        

ID товара.

has_price        

Есть ли цена да/нет.

is_removed        

Удалена ли запись.

updated_at        

Дата последнего обновления.

Пример ответа

{
    "data": [
        {
            "id": null,
            "parent_item_id": null,
            "item_id": null,
            "has_price": null,
            "is_removed": null,
            "updated_at": null
        },
        {
            "id": null,
            "parent_item_id": null,
            "item_id": null,
            "has_price": null,
            "is_removed": null,
            "updated_at": null
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

# Создать модификатор.

Запрос   

POST /items/modifiers

Тело запроса

parent_item_id   string     

ID товара для модификатора.
Пример: 00000000-0000-0000-0000-000000000001

item_id   string     

ID товара.
Пример: 00000000-0000-0000-0000-000000000001

has_price   boolean  необязательно    

Есть ли цена да/нет.
Пример: true

Пример запроса

POST https://next.rosta.kz/api/client/public/items/modifiers
{
    "parent_item_id": "00000000-0000-0000-0000-000000000001",
    "item_id": "00000000-0000-0000-0000-000000000001",
    "has_price": true
}

Ответ

Поля ответа

data   object     
id        

ID модификатора.

parent_item_id        

ID товара для модификатора.

item_id        

ID товара.

has_price        

Есть ли цена да/нет.

updated_at        

Дата последнего обновления.

Пример ответа

{
    "data": {
        "id": null,
        "parent_item": null,
        "item": null,
        "has_price": null,
        "is_removed": null,
        "updated_at": null
    }
}

# Показать модификатор.

Запрос   

GET /items/modifiers/{id}

Параметры URL

id   string     

ID модификатора.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/items/modifiers/00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

data   object     
id        

ID модификатора.

parent_item_id        

ID товара для модификатора.

item_id        

ID товара.

has_price        

Есть ли цена да/нет.

updated_at        

Дата последнего обновления.

Пример ответа

{
    "data": {
        "id": null,
        "parent_item": null,
        "item": null,
        "has_price": null,
        "is_removed": null,
        "updated_at": null
    }
}

# Редактировать модификатор.

Запрос   

PUT /items/modifiers/{id}

PATCH /items/modifiers/{id}

Параметры URL

id   string     

ID модификатора.
Пример: 00000000-0000-0000-0000-000000000001

Тело запроса

parent_item_id   string     

ID товара для модификатора.
Пример: 00000000-0000-0000-0000-000000000001

item_id   string     

ID товара.
Пример: 00000000-0000-0000-0000-000000000001

has_price   boolean  необязательно    

Есть ли цена да/нет.
Пример: true

Пример запроса

PUT https://next.rosta.kz/api/client/public/items/modifiers/00000000-0000-0000-0000-000000000001
{
    "parent_item_id": "00000000-0000-0000-0000-000000000001",
    "item_id": "00000000-0000-0000-0000-000000000001",
    "has_price": true
}

Ответ

Поля ответа

data   object     
id        

ID модификатора.

parent_item_id        

ID товара для модификатора.

item_id        

ID товара.

has_price        

Есть ли цена да/нет.

updated_at        

Дата последнего обновления.

Пример ответа

{
    "data": {
        "id": null,
        "parent_item": null,
        "item": null,
        "has_price": null,
        "is_removed": null,
        "updated_at": null
    }
}

# Удалить модификатор.

Запрос   

DELETE /items/modifiers/{id}

Параметры URL

id   string     

ID модификатора.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

DELETE https://next.rosta.kz/api/client/public/items/modifiers/00000000-0000-0000-0000-000000000001

# Виды номенклатуры

API для работы со справочником видов номенклатуры.

# Список видов

Запрос   

GET /items/types

Пример запроса

GET https://next.rosta.kz/api/client/public/items/types

Ответ

Поля ответа

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
    }
}

# Создать вид

Запрос   

POST /items/types

Тело запроса

name   string     

Название вида номенклатуры. Количество символов в значении поля value не может превышать 50.
Пример: Электроника

type   integer     

Тип вида номенклатуры.
Пример: 0

Одно из:
  • 1 — Продукт
  • 2 — Услуга
  • 3 — Маркируемый товар
  • 4 — Тарификатор
parent_id   string  необязательно    

ID родительского вида.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

POST https://next.rosta.kz/api/client/public/items/types
{
    "name": "Электроника",
    "type": 0,
    "parent_id": "00000000-0000-0000-0000-000000000001"
}

Ответ

Поля ответа

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
    }
}

# Показать вид

Запрос   

GET /items/types/{id}

Параметры URL

id   string     

ID вида.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/items/types/00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

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
    }
}

# Удалить вид

Запрос   

DELETE /items/types/{id}

Параметры URL

id   string     

ID вида.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

DELETE https://next.rosta.kz/api/client/public/items/types/00000000-0000-0000-0000-000000000001

# Единицы измерения

API для работы со справочником единиц измерения.

# Список ед. измерения

Запрос   

GET /units

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/units
GET https://next.rosta.kz/api/client/public/units?show_removed=1

Ответ

Поля ответа

data   object     
id   string     

ID единицы измерения.

name   string     

Краткое название единицы измерения.

full_name   string     

Полное название единицы измерения.

is_removed   boolean     

Удалена ли запись.

Пример ответа

{
    "data": [
        {
            "id": "eb6524be-27cd-4900-87a1-46c6aa5b409f",
            "name": "мин",
            "full_name": "Минута",
            "is_removed": false
        },
        {
            "id": "eb6524be-27cd-4900-87a1-46c6aa5b409f",
            "name": "мин",
            "full_name": "Минута",
            "is_removed": false
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

# Создать ед. измерения

Запрос   

POST /units

Тело запроса

name   string     

Краткое название единицы измерения. Количество символов в значении поля value не может превышать 20.
Пример: мг

full_name   string     

Полное название единицы измерения. Количество символов в значении поля value не может превышать 100.
Пример: миллиграммы

Пример запроса

POST https://next.rosta.kz/api/client/public/units
{
    "name": "мг",
    "full_name": "миллиграммы"
}

Ответ

Поля ответа

data   object     
id   string     

ID единицы измерения.

name   string     

Краткое название единицы измерения.

full_name   string     

Полное название единицы измерения.

is_removed   boolean     

Удалена ли запись.

Пример ответа

{
    "data": {
        "id": "eb6524be-27cd-4900-87a1-46c6aa5b409f",
        "name": "мин",
        "full_name": "Минута",
        "is_removed": false
    }
}

# Показать ед. измерения

Запрос   

GET /units/{id}

Параметры URL

id   string     

ID единицы измерения.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/units/00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

data   object     
id   string     

ID единицы измерения.

name   string     

Краткое название единицы измерения.

full_name   string     

Полное название единицы измерения.

is_removed   boolean     

Удалена ли запись.

Пример ответа

{
    "data": {
        "id": "eb6524be-27cd-4900-87a1-46c6aa5b409f",
        "name": "мин",
        "full_name": "Минута",
        "is_removed": false
    }
}

# Редактировать ед. измерения

Запрос   

PUT /units/{id}

PATCH /units/{id}

Параметры URL

id   string     

ID единицы измерения.
Пример: 00000000-0000-0000-0000-000000000001

Тело запроса

name   string     

Краткое название единицы измерения. Количество символов в значении поля value не может превышать 20.
Пример: мг

full_name   string     

Полное название единицы измерения. Количество символов в значении поля value не может превышать 100.
Пример: миллиграммы

Пример запроса

PUT https://next.rosta.kz/api/client/public/units/00000000-0000-0000-0000-000000000001
{
    "name": "мг",
    "full_name": "миллиграммы"
}

Ответ

Поля ответа

data   object     
id   string     

ID единицы измерения.

name   string     

Краткое название единицы измерения.

full_name   string     

Полное название единицы измерения.

is_removed   boolean     

Удалена ли запись.

Пример ответа

{
    "data": {
        "id": "eb6524be-27cd-4900-87a1-46c6aa5b409f",
        "name": "мин",
        "full_name": "Минута",
        "is_removed": false
    }
}

# Удалить ед. измерения

Запрос   

DELETE /units/{id}

Параметры URL

id   string     

ID единицы измерения.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

DELETE https://next.rosta.kz/api/client/public/units/00000000-0000-0000-0000-000000000001

Контрагенты

# Контрагенты

API для работы со справочником контрагентов.

# Бонусы контрагентов

Запрос   

GET /contractors/bonuses

Пример запроса

GET https://next.rosta.kz/api/client/public/contractors/bonuses

Ответ

Пример ответа

{
    "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
    }
}

# Список контрагентов

Запрос   

GET /contractors

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/contractors
GET https://next.rosta.kz/api/client/public/contractors?show_removed=1

Ответ

Поля ответа

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 — Юридическое лицо (нерезидент)
parent_id   string     

ID родительской группы.

is_removed   boolean     

Удалена ли запись.

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",
            "is_removed": false,
            "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",
            "is_removed": false,
            "updated_at": "2026-03-12T07:30:57.175944Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

# Создать контрагента

Запрос   

POST /contractors

Тело запроса

name   string  необязательно    

Имя контрагента. Количество символов в значении поля value не может превышать 100.
Пример: Жанибек

full_name   string  необязательно    

Полное имя контрагента. Количество символов в значении поля value не может превышать 100.
Пример: Жанибек Петрович

legal_address   string  необязательно    

Юридический адрес. Количество символов в значении поля value не может превышать 256.
Пример: Казахстан, г. Алматы, ул. Розыбакиева 113

actual_address   string  необязательно    

Фактический адрес. Количество символов в значении поля value не может превышать 256.
Пример: Казахстан, г. Алматы, ул. Розыбакиева 113

bin   string  необязательно    

БИН контрагента. Количество символов в значении поля value не может превышать 12.
Пример: 171040002285

card_no   string  необязательно    

Код карты. Количество символов в поле value должно быть от 1 до 100.
Пример: 1234567890

comment   string  необязательно    

Комментарий. Количество символов в значении поля value не может превышать 1000.
Пример: Поставщик

birthdate   string  необязательно    

День рождения контрагента. Значение поля value должно быть корректной датой.
Пример: 1992-07-21

discount   number  необязательно    

Процент скидки. Значение поля value должно быть не меньше 0. Значение поля value не может быть больше 100.
Пример: 5

service   number  необязательно    

Процент наценки. Значение поля value должно быть не меньше 0. Значение поля value не может быть больше 100.
Пример: 15

type   string     

Тип контрагента.
Пример: 31000000-0000-0000-0000-000000000000

Одно из:
  • 31000000-0000-0000-0000-000000000000 — Физическое лицо
  • 32000000-0000-0000-0000-000000000000 — Юридическое лицо
  • 33000000-0000-0000-0000-000000000000 — Юридическое лицо (нерезидент)
parent_id   string  необязательно    

ID родительской группы.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

POST https://next.rosta.kz/api/client/public/contractors
{
    "name": "Жанибек",
    "full_name": "Жанибек Петрович",
    "legal_address": "Казахстан, г. Алматы, ул. Розыбакиева 113",
    "actual_address": "Казахстан, г. Алматы, ул. Розыбакиева 113",
    "bin": "171040002285",
    "card_no": "1234567890",
    "comment": "Поставщик",
    "birthdate": "1992-07-21",
    "discount": 5,
    "service": 15,
    "type": "31000000-0000-0000-0000-000000000000",
    "parent_id": "00000000-0000-0000-0000-000000000001"
}

Ответ

Поля ответа

data   object     
id   string     

ID контрагентов.

name   string     

Имя контрагентов.

service        

Процент наценки.

discount        

Процент скидки.

bin        

БИН.

card_no        

Код карты.

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        

Описание типа контрагента.

parent   object     
id        

ID родительской группы.

name        

Название родительской группы.

Пример ответа

{
    "data": {
        "id": "a4d61291-e007-404d-9a3e-0bcbed6c1035",
        "name": "Мария",
        "full_name": "Мария",
        "service": null,
        "discount": null,
        "bin": null,
        "card_no": 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": "Постоянные клиенты"
        }
    }
}

# Показать контрагента

Запрос   

GET /contractors/{id}

Параметры URL

id   string     

ID контрагента.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/contractors/00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

data   object     
id   string     

ID контрагентов.

name   string     

Имя контрагентов.

service        

Процент наценки.

discount        

Процент скидки.

bin        

БИН.

card_no        

Код карты.

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        

Описание типа контрагента.

parent   object     
id        

ID родительской группы.

name        

Название родительской группы.

Пример ответа

{
    "data": {
        "id": "a4d61291-e007-404d-9a3e-0bcbed6c1035",
        "name": "Мария",
        "full_name": "Мария",
        "service": null,
        "discount": null,
        "bin": null,
        "card_no": 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": "Постоянные клиенты"
        }
    }
}

# Редактировать контрагента

Запрос   

PUT /contractors/{id}

PATCH /contractors/{id}

Параметры URL

id   string     

ID контрагента.
Пример: 00000000-0000-0000-0000-000000000001

Тело запроса

name   string  необязательно    

Имя контрагента. Количество символов в значении поля value не может превышать 100.
Пример: Жанибек

full_name   string  необязательно    

Полное имя контрагента. Количество символов в значении поля value не может превышать 100.
Пример: Жанибек Петрович

legal_address   string  необязательно    

Юридический адрес. Количество символов в значении поля value не может превышать 256.
Пример: Казахстан, г. Алматы, ул. Розыбакиева 113

actual_address   string  необязательно    

Фактический адрес. Количество символов в значении поля value не может превышать 256.
Пример: Казахстан, г. Алматы, ул. Розыбакиева 113

bin   string  необязательно    

БИН контрагента. Количество символов в значении поля value не может превышать 12.
Пример: 171040002285

card_no   string  необязательно    

Код карты. Количество символов в поле value должно быть от 1 до 100.
Пример: 1234567890

comment   string  необязательно    

Комментарий. Количество символов в значении поля value не может превышать 1000.
Пример: Поставщик

birthdate   string  необязательно    

День рождения контрагента. Значение поля value должно быть корректной датой.
Пример: 1992-07-21

discount   number  необязательно    

Процент скидки. Значение поля value должно быть не меньше 0. Значение поля value не может быть больше 100.
Пример: 5

service   number  необязательно    

Процент наценки. Значение поля value должно быть не меньше 0. Значение поля value не может быть больше 100.
Пример: 15

type   string     

Тип контрагента.
Пример: 31000000-0000-0000-0000-000000000000

Одно из:
  • 31000000-0000-0000-0000-000000000000 — Физическое лицо
  • 32000000-0000-0000-0000-000000000000 — Юридическое лицо
  • 33000000-0000-0000-0000-000000000000 — Юридическое лицо (нерезидент)
parent_id   string  необязательно    

ID родительской группы.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

PUT https://next.rosta.kz/api/client/public/contractors/00000000-0000-0000-0000-000000000001
{
    "name": "Жанибек",
    "full_name": "Жанибек Петрович",
    "legal_address": "Казахстан, г. Алматы, ул. Розыбакиева 113",
    "actual_address": "Казахстан, г. Алматы, ул. Розыбакиева 113",
    "bin": "171040002285",
    "card_no": "1234567890",
    "comment": "Поставщик",
    "birthdate": "1992-07-21",
    "discount": 5,
    "service": 15,
    "type": "31000000-0000-0000-0000-000000000000",
    "parent_id": "00000000-0000-0000-0000-000000000001"
}

Ответ

Поля ответа

data   object     
id   string     

ID контрагентов.

name   string     

Имя контрагентов.

service        

Процент наценки.

discount        

Процент скидки.

bin        

БИН.

card_no        

Код карты.

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        

Описание типа контрагента.

parent   object     
id        

ID родительской группы.

name        

Название родительской группы.

Пример ответа

{
    "data": {
        "id": "a4d61291-e007-404d-9a3e-0bcbed6c1035",
        "name": "Мария",
        "full_name": "Мария",
        "service": null,
        "discount": null,
        "bin": null,
        "card_no": 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": "Постоянные клиенты"
        }
    }
}

# Удалить контрагента

Запрос   

DELETE /contractors/{id}

Параметры URL

id   string     

ID контрагента.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

DELETE https://next.rosta.kz/api/client/public/contractors/00000000-0000-0000-0000-000000000001

# Группы контрагентов

API для работы со справочником групп контрагентов.

# Список групп

Запрос   

GET /contractors/groups

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/contractors/groups
GET https://next.rosta.kz/api/client/public/contractors/groups?show_removed=1

Ответ

Поля ответа

data   object     
id   string     

ID группы контрагентов.

name   string     

Название группы.

service        

Процент наценки.

discount        

Процент скидки.

parent_id        

ID родительской группы.

is_removed   boolean     

Удалена ли запись.

updated_at   string     

Дата последнего обновления.

Пример ответа

{
    "data": [
        {
            "id": "c75850ee-26db-4121-9e20-d0ad0026de34",
            "name": "Постоянные клиенты",
            "service": null,
            "discount": null,
            "parent_id": null,
            "is_removed": false,
            "updated_at": "2026-03-12T07:30:57.068105Z"
        },
        {
            "id": "c75850ee-26db-4121-9e20-d0ad0026de34",
            "name": "Постоянные клиенты",
            "service": null,
            "discount": null,
            "parent_id": null,
            "is_removed": false,
            "updated_at": "2026-03-12T07:30:57.068105Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

# Создать группу

Запрос   

POST /contractors/groups

Тело запроса

name   string  необязательно    

Название группы. Количество символов в значении поля value не может превышать 50.
Пример: Поставщики

parent_id   string  необязательно    

ID родительской группы.
Пример: 00000000-0000-0000-0000-000000000001

discount   number  необязательно    

Процент скидки. Значение поля value должно быть не меньше 0. Значение поля value не может быть больше 100.
Пример: 5

service   number  необязательно    

Процент наценки. Значение поля value должно быть не меньше 0. Значение поля value не может быть больше 100.
Пример: 15

Пример запроса

POST https://next.rosta.kz/api/client/public/contractors/groups
{
    "name": "Поставщики",
    "parent_id": "00000000-0000-0000-0000-000000000001",
    "discount": 5,
    "service": 15
}

Ответ

Поля ответа

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
    }
}

# Показать группу

Запрос   

GET /contractors/groups/{id}

Параметры URL

id   string     

ID группы.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/contractors/groups/00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

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
    }
}

# Редактировать группу

Запрос   

PUT /contractors/groups/{id}

PATCH /contractors/groups/{id}

Параметры URL

id   string     

ID группы.
Пример: 00000000-0000-0000-0000-000000000001

Тело запроса

name   string  необязательно    

Название группы. Количество символов в значении поля value не может превышать 50.
Пример: Поставщики

parent_id   string  необязательно    

ID родительской группы.
Пример: 00000000-0000-0000-0000-000000000001

discount   number  необязательно    

Процент скидки. Значение поля value должно быть не меньше 0. Значение поля value не может быть больше 100.
Пример: 5

service   number  необязательно    

Процент наценки. Значение поля value должно быть не меньше 0. Значение поля value не может быть больше 100.
Пример: 15

Пример запроса

PUT https://next.rosta.kz/api/client/public/contractors/groups/00000000-0000-0000-0000-000000000001
{
    "name": "Поставщики",
    "parent_id": "00000000-0000-0000-0000-000000000001",
    "discount": 5,
    "service": 15
}

Ответ

Поля ответа

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
    }
}

# Удалить группу

Запрос   

DELETE /contractors/groups/{id}

Параметры URL

id   string     

ID группы.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

DELETE https://next.rosta.kz/api/client/public/contractors/groups/00000000-0000-0000-0000-000000000001

# Контакты контрагентов

API для работы с контактами контрагентов.

# Список контактов

Запрос   

GET /contractors/contacts

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/contractors/contacts
GET https://next.rosta.kz/api/client/public/contractors/contacts?show_removed=1

Ответ

Пример ответа

{
    "data": [
        {
            "id": "9dbefbdd-02cf-4755-b221-44b490f1bf16",
            "type_id": "00000000-0000-0000-0000-000000000001",
            "contractor_id": "9cbfeb92-4f43-4900-b934-6ae1d6eca79e",
            "value": "+77087887878",
            "is_removed": false,
            "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",
            "is_removed": false,
            "updated_at": "2026-03-12T07:30:56.925560Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

# Создать контакт

Запрос   

POST /contractors/contacts

Тело запроса

type_id   string     

ID [типа].
Пример: 00000000-0000-0000-0000-000000000001

Одно из:
  • 00000000-0000-0000-0000-000000000001 — Телефон
  • 00000000-0000-0000-0000-000000000002 — Электронная почта
  • 00000000-0000-0000-0000-000000000003 — Адрес
  • 00000000-0000-0000-0000-000000000004 — Другое
  • 00000000-0000-0000-0000-000000000005 — Веб страница
contractor_id   string     

ID [контрагент].
Пример: 00000000-0000-0000-0000-000000000001

value   string     

Наименование.
Пример: 12345

Пример запроса

POST https://next.rosta.kz/api/client/public/contractors/contacts
{
    "type_id": "00000000-0000-0000-0000-000000000001",
    "contractor_id": "00000000-0000-0000-0000-000000000001",
    "value": "12345"
}

Ответ

Пример ответа

{
    "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"
    }
}

# Показать контакт

Запрос   

GET /contractors/contacts/{id}

Параметры URL

id   string     

ID контакта.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/contractors/contacts/00000000-0000-0000-0000-000000000001

Ответ

Пример ответа

{
    "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"
    }
}

# Редактировать контакт

Запрос   

PUT /contractors/contacts/{id}

PATCH /contractors/contacts/{id}

Параметры URL

id   string     

ID контакта.
Пример: 00000000-0000-0000-0000-000000000001

Тело запроса

type_id   string     

ID [типа].
Пример: 00000000-0000-0000-0000-000000000001

Одно из:
  • 00000000-0000-0000-0000-000000000001 — Телефон
  • 00000000-0000-0000-0000-000000000002 — Электронная почта
  • 00000000-0000-0000-0000-000000000003 — Адрес
  • 00000000-0000-0000-0000-000000000004 — Другое
  • 00000000-0000-0000-0000-000000000005 — Веб страница
contractor_id   string     

ID [контрагент].
Пример: 00000000-0000-0000-0000-000000000001

value   string     

Наименование.
Пример: 12345

Пример запроса

PUT https://next.rosta.kz/api/client/public/contractors/contacts/00000000-0000-0000-0000-000000000001
{
    "type_id": "00000000-0000-0000-0000-000000000001",
    "contractor_id": "00000000-0000-0000-0000-000000000001",
    "value": "12345"
}

Ответ

Пример ответа

{
    "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"
    }
}

# Удалить контакт

Запрос   

DELETE /contractors/contacts/{id}

Параметры URL

id   string     

ID контакта.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

DELETE https://next.rosta.kz/api/client/public/contractors/contacts/00000000-0000-0000-0000-000000000001

Документы

# Поступление на счёт

API для работы с документами поступления на счёт.

# Список документов

Запрос   

GET /documents/cashbankincome

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/documents/cashbankincome
GET https://next.rosta.kz/api/client/public/documents/cashbankincome?show_removed=1

Ответ

Пример ответа

{
    "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
    }
}

# Показать документ

Запрос   

GET /documents/cashbankincome/{id}

Параметры URL

id   string     

ID документа.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/documents/cashbankincome/00000000-0000-0000-0000-000000000001

Ответ

Пример ответа

{
    "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 для работы с документами изъятия со счёта.

# Список документов

Запрос   

GET /documents/cashbankoutcome

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/documents/cashbankoutcome
GET https://next.rosta.kz/api/client/public/documents/cashbankoutcome?show_removed=1

Ответ

Пример ответа

{
    "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
    }
}

# Показать документ

Запрос   

GET /documents/cashbankoutcome/{id}

Параметры URL

id   string     

ID документа.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/documents/cashbankoutcome/00000000-0000-0000-0000-000000000001

Ответ

Пример ответа

{
    "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 для работы с документами поступления в кассу.

# Список документов

Запрос   

GET /documents/cashincome

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/documents/cashincome
GET https://next.rosta.kz/api/client/public/documents/cashincome?show_removed=1

Ответ

Пример ответа

{
    "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
    }
}

# Показать документ

Запрос   

GET /documents/cashincome/{id}

Параметры URL

id   string     

ID документа.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/documents/cashincome/00000000-0000-0000-0000-000000000001

Ответ

Пример ответа

{
    "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 для работы с документами изъятия из кассы.

# Список документов

Запрос   

GET /documents/cashoutcome

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/documents/cashoutcome
GET https://next.rosta.kz/api/client/public/documents/cashoutcome?show_removed=1

Ответ

Пример ответа

{
    "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
    }
}

# Показать документ

Запрос   

GET /documents/cashoutcome/{id}

Параметры URL

id   string     

ID документа.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/documents/cashoutcome/00000000-0000-0000-0000-000000000001

Ответ

Пример ответа

{
    "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 для работы с документами инвентаризации.

# Список документов

Запрос   

GET /documents/inventories

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/documents/inventories
GET https://next.rosta.kz/api/client/public/documents/inventories?show_removed=1

Ответ

Пример ответа

{
    "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,
            "is_removed": 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,
            "is_removed": null,
            "updated_at": null,
            "warehouse": null
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

# Показать документ

Запрос   

GET /documents/inventories/{id}

Параметры URL

id   string     

ID документа.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/documents/inventories/00000000-0000-0000-0000-000000000001

Ответ

Пример ответа

{
    "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 для работы с документами перемещения товаров.

# Список документов

Запрос   

GET /documents/movement

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/documents/movement
GET https://next.rosta.kz/api/client/public/documents/movement?show_removed=1

Ответ

Пример ответа

{
    "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,
            "is_removed": 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,
            "is_removed": 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
    }
}

# Показать документ

Запрос   

GET /documents/movement/{id}

Параметры URL

id   string     

ID документа.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/documents/movement/00000000-0000-0000-0000-000000000001

Ответ

Пример ответа

{
    "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 для работы с документами оприходования.

# Список документов

Запрос   

GET /documents/postings

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/documents/postings
GET https://next.rosta.kz/api/client/public/documents/postings?show_removed=1

Ответ

Пример ответа

{
    "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": "Не перезванивать",
            "is_removed": false,
            "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": "Не перезванивать",
            "is_removed": false,
            "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
    }
}

# Показать документ

Запрос   

GET /documents/postings/{id}

Параметры URL

id   string     

ID документа.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/documents/postings/00000000-0000-0000-0000-000000000001

Ответ

Пример ответа

{
    "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 для работы с документами поступлений товаров и услуг.

# Список документов

Запрос   

GET /documents/receipts

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/documents/receipts
GET https://next.rosta.kz/api/client/public/documents/receipts?show_removed=1

Ответ

Пример ответа

{
    "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,
            "is_removed": 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,
            "is_removed": null,
            "updated_at": null,
            "warehouse": null
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

# Показать документ

Запрос   

GET /documents/receipts/{id}

Параметры URL

id   string     

ID документа.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/documents/receipts/00000000-0000-0000-0000-000000000001

Ответ

Пример ответа

{
    "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 для работы с документами реализации товаров и услуг.

# Список документов

Запрос   

GET /documents/sales

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/documents/sales
GET https://next.rosta.kz/api/client/public/documents/sales?show_removed=1

Ответ

Пример ответа

{
    "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,
            "is_removed": 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,
            "is_removed": null,
            "updated_at": null,
            "warehouse": null
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

# Показать документ

Запрос   

GET /documents/sales/{id}

Параметры URL

id   string     

ID документа.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/documents/sales/00000000-0000-0000-0000-000000000001

Ответ

Пример ответа

{
    "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 для работы со документами списания.

# Список документов

Запрос   

GET /documents/writeoffs

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/documents/writeoffs
GET https://next.rosta.kz/api/client/public/documents/writeoffs?show_removed=1

Ответ

Пример ответа

{
    "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,
            "is_removed": 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,
            "is_removed": null,
            "updated_at": null,
            "warehouse": null
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

# Показать документ

Запрос   

GET /documents/writeoffs/{id}

Параметры URL

id   string     

ID документа.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/documents/writeoffs/00000000-0000-0000-0000-000000000001

Ответ

Пример ответа

{
    "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-офиса.

# Список сотрудников

Запрос   

GET /users/front

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/users/front
GET https://next.rosta.kz/api/client/public/users/front?show_removed=1

Ответ

Поля ответа

data   object     
id   string     

ID сотрудника Front-офиса.

name   string     

Имя сотрудника.

parent_id        

ID родительской группа.

is_removed   boolean     

Удалена ли запись.

updated_at   string     

Дата последнего обновления.

Пример ответа

{
    "data": [
        {
            "id": "31000000-0000-0000-0000-000000000000",
            "name": "Официант",
            "parent_id": null,
            "is_removed": false,
            "updated_at": "2026-03-12T07:48:07.436177Z"
        },
        {
            "id": "31000000-0000-0000-0000-000000000000",
            "name": "Официант",
            "parent_id": null,
            "is_removed": false,
            "updated_at": "2026-03-12T07:48:07.436177Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

# Показать сотрудника

Запрос   

GET /users/front/{id}

Параметры URL

id   string     

ID сотрудника.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/users/front/00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

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 для работы со справочником способов оплаты.

# Список способов оплаты

Запрос   

GET /payment-methods

Пример запроса

GET https://next.rosta.kz/api/client/public/payment-methods

Ответ

Поля ответа

data   object     
id   string     

ID способа оплаты.

name   string     

Название способа оплаты на кассе.

system_name   string     

Название способа оплаты в бэк-офисе.

type   integer     

Тип способа оплаты.

Одно из:
  • 1 — Наличные
  • 2 — Безналичные
  • 3 — Бонусы
  • 4 — Долг
terminal_type   integer     

Тип терминала для безналичной оплаты.

Одно из:
  • 0 — Отсутствует
  • 1 — Kaspi
  • 2 — Halyk
  • 3 — 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
    }
}

# Создать способ оплаты

Запрос   

POST /payment-methods

Тело запроса

name   string     

Название способа оплаты на кассе. Количество символов в значении поля value не может превышать 50.
Пример: Наличные

system_name   string     

Название способа оплаты в бэк-офисе. Количество символов в значении поля value не может превышать 50.
Пример: Наличные

type   integer     

Тип способа оплаты.
Пример: 1

Одно из:
  • 1 — Наличные
  • 2 — Безналичные
  • 3 — Бонусы
  • 4 — Долг
terminal_type   integer     

Тип терминала для безналичной оплаты.
Пример: 1

Одно из:
  • 0 — Отсутствует
  • 1 — Kaspi
  • 2 — Halyk
  • 3 — Forte (Pax)
  • 4 — Forte (Sunmi)

Пример запроса

POST https://next.rosta.kz/api/client/public/payment-methods
{
    "name": "Наличные",
    "system_name": "Наличные",
    "type": 1,
    "terminal_type": 1
}

Ответ

Поля ответа

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 — Kaspi
  • 2 — Halyk
  • 3 — 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": "Отсутствует"
        }
    }
}

# Показать способ оплаты

Запрос   

GET /payment-methods/{id}

Параметры URL

id   string     

ID способа оплаты.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/payment-methods/00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

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 — Kaspi
  • 2 — Halyk
  • 3 — 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": "Отсутствует"
        }
    }
}

# Редактировать способ оплаты

Запрос   

PUT /payment-methods/{id}

PATCH /payment-methods/{id}

Параметры URL

id   string     

ID способа оплаты.
Пример: 00000000-0000-0000-0000-000000000001

Тело запроса

name   string     

Название способа оплаты на кассе. Количество символов в значении поля value не может превышать 50.
Пример: Наличные

system_name   string     

Название способа оплаты в бэк-офисе. Количество символов в значении поля value не может превышать 50.
Пример: Наличные

type   integer     

Тип способа оплаты.
Пример: 1

Одно из:
  • 1 — Наличные
  • 2 — Безналичные
  • 3 — Бонусы
  • 4 — Долг
terminal_type   integer     

Тип терминала для безналичной оплаты.
Пример: 1

Одно из:
  • 0 — Отсутствует
  • 1 — Kaspi
  • 2 — Halyk
  • 3 — Forte (Pax)
  • 4 — Forte (Sunmi)

Пример запроса

PUT https://next.rosta.kz/api/client/public/payment-methods/00000000-0000-0000-0000-000000000001
{
    "name": "Наличные",
    "system_name": "Наличные",
    "type": 1,
    "terminal_type": 1
}

Ответ

Поля ответа

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 — Kaspi
  • 2 — Halyk
  • 3 — 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": "Отсутствует"
        }
    }
}

# Удалить способ оплаты

Запрос   

DELETE /payment-methods/{id}

Параметры URL

id   string     

ID способа оплаты.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

DELETE https://next.rosta.kz/api/client/public/payment-methods/00000000-0000-0000-0000-000000000001

# Принтеры

API для работы со справочником принтеров.

# Список принтеров

Запрос   

GET /printers

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/printers
GET https://next.rosta.kz/api/client/public/printers?show_removed=1

Ответ

Поля ответа

data   object     
id   string     

ID принтера.

name   string     

Название принтера.

system_name   string     

Системное название принтера.

is_removed   boolean     

Удалена ли запись.

updated_at   string     

Дата последнего обновления.

Пример ответа

{
    "data": [
        {
            "id": "9d6b9526-865d-45c3-a11c-acf8d9a4d59b",
            "name": "Бар",
            "system_name": "bar",
            "is_removed": false,
            "updated_at": "2026-03-12T07:30:59.011717Z"
        },
        {
            "id": "9d6b9526-865d-45c3-a11c-acf8d9a4d59b",
            "name": "Бар",
            "system_name": "bar",
            "is_removed": false,
            "updated_at": "2026-03-12T07:30:59.011717Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

# Создать принтер

Запрос   

POST /printers

Тело запроса

name   string     

Название принтера. Количество символов в значении поля value не может превышать 50.
Пример: Принтер на кухне

system_name   string     

Системное имя принтера. Количество символов в значении поля value не может превышать 100.
Пример: HP_LaserJet_Pro_MFP_M227fdw

Пример запроса

POST https://next.rosta.kz/api/client/public/printers
{
    "name": "Принтер на кухне",
    "system_name": "HP_LaserJet_Pro_MFP_M227fdw"
}

Ответ

Поля ответа

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"
    }
}

# Показать принтер

Запрос   

GET /printers/{id}

Параметры URL

id   string     

ID принтера.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/printers/00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

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"
    }
}

# Редактировать принтер

Запрос   

PUT /printers/{id}

PATCH /printers/{id}

Параметры URL

id   string     

ID принтера.
Пример: 00000000-0000-0000-0000-000000000001

Тело запроса

name   string     

Название принтера. Количество символов в значении поля value не может превышать 50.
Пример: Принтер на кухне

system_name   string     

Системное имя принтера. Количество символов в значении поля value не может превышать 100.
Пример: HP_LaserJet_Pro_MFP_M227fdw

Пример запроса

PUT https://next.rosta.kz/api/client/public/printers/00000000-0000-0000-0000-000000000001
{
    "name": "Принтер на кухне",
    "system_name": "HP_LaserJet_Pro_MFP_M227fdw"
}

Ответ

Поля ответа

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"
    }
}

# Удалить принтер

Запрос   

DELETE /printers/{id}

Параметры URL

id   string     

ID принтера.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

DELETE https://next.rosta.kz/api/client/public/printers/00000000-0000-0000-0000-000000000001

Рабочий процесс

# Счета / чеки

API для работы со справочником счетов / чеков.

# Список счетов / чеков

Запрос   

GET /orders

Пример запроса

GET https://next.rosta.kz/api/client/public/orders

Ответ

Поля ответа

data   object     
id   string     

ID счёта.

num   integer     

Номер заказа.

status   integer     

Статус.

Одно из:
  • 0 — Открыт
  • 1 — Распечатан
  • 3 — Оплачен
shift_id   string     
client_id   string     
table_id   string     
cashbox_id        
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
    }
}

# Создать счёт / чек

Запрос   

POST /orders

Тело запроса

shift_id   string     

ID смены.
Пример: 00000000-0000-0000-0000-000000000001

client_id   string  необязательно    

ID клиента.
Пример: 00000000-0000-0000-0000-000000000001

table_id   string  необязательно    

ID стола.
Пример: 00000000-0000-0000-0000-000000000001

address_id   string  необязательно    

ID адреса.
Пример: 00000000-0000-0000-0000-000000000001

phone_id   string  необязательно    

ID телефона.
Пример: 00000000-0000-0000-0000-000000000001

comment   string  необязательно    

Комментарий к заказу. Количество символов в значении поля value не может превышать 255.
Пример: Есть аллергия на арахис

discount   number  необязательно    

Процент скидки по-умолчанию на все позиции. Значение поля value должно быть не меньше 0. Значение поля value не может быть больше 100.
Пример: 25

items   object[]     

Список товаров.
id   string     

ID товара.
Пример: 00000000-0000-0000-0000-000000000001

attribute_id   string  необязательно    

ID характеристики.
Пример: 00000000-0000-0000-0000-000000000001

count   number     

Количество товара. Значение поля value должно быть не меньше 0.
Пример: 5

price   number  необязательно    

Цена. Значение поля value должно быть не меньше 0.
Пример: 100

discount   number  необязательно    

Процент скидки на позицию. Переопределяет скидку по-умолчанию из заказа. Значение поля value должно быть не меньше 0. Значение поля value не может быть больше 100.
Пример: 25

Пример запроса

POST https://next.rosta.kz/api/client/public/orders
{
    "shift_id": "00000000-0000-0000-0000-000000000001",
    "client_id": "00000000-0000-0000-0000-000000000001",
    "table_id": "00000000-0000-0000-0000-000000000001",
    "address_id": "00000000-0000-0000-0000-000000000001",
    "phone_id": "00000000-0000-0000-0000-000000000001",
    "comment": "Есть аллергия на арахис",
    "discount": 25,
    "items": [
        {
            "id": "00000000-0000-0000-0000-000000000001",
            "attribute_id": "00000000-0000-0000-0000-000000000001",
            "count": 5,
            "price": 100,
            "discount": 25
        }
    ]
}

Ответ

Поля ответа

data   object     
id   string     

ID счёта.

num   integer     

Номер заказа.

sum   integer     

Сумма заказа к оплате.

sum_discount   integer     

Сумма скидки.

sum_service   integer     

Сумма наценки.

discount   integer     

Процент скидки по-умолчанию.

service   integer     

Процент наценки.

comment   string     

Комментарий к заказу.

opened_at   string     

Время открытия счёта.

closed_at        

Время закрытия счёта.

updated_at   string     

Дата последнего обновления.

status   object     
value        

Код статуса.

Одно из:
  • 0 — Открыт
  • 1 — Распечатан
  • 3 — Оплачен
label        

Описание статуса.

payments   object     
accepted        

Принято оплаты.

cash        

Оплата наличными.

cashless        

Оплата безналичными.

bonus        

Оплата бонусами.

other        
shift   object     
id        
opened_at        

Время открытия смены.

closed_at        

Время закрытия смены.

client   object     
id        
name        

Имя клиента.

table   object     
id        
name        

Название стола.

cashbox   object     
id        
name        

Название кассы.

Пример ответа

{
    "data": {
        "id": "9b27df58-f64b-4baa-9f26-d0a9a67a7206",
        "num": 2,
        "sum": 1500,
        "sum_discount": 0,
        "sum_service": 0,
        "discount": 0,
        "service": 0,
        "comment": "",
        "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,
                "discount": null
            }
        ]
    }
}

# Показать счёт / чек

Запрос   

GET /orders/{id}

Параметры URL

id   string     

ID счёта / чека.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/orders/00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

data   object     
id   string     

ID счёта.

num   integer     

Номер заказа.

sum   integer     

Сумма заказа к оплате.

sum_discount   integer     

Сумма скидки.

sum_service   integer     

Сумма наценки.

discount   integer     

Процент скидки по-умолчанию.

service   integer     

Процент наценки.

comment   string     

Комментарий к заказу.

opened_at   string     

Время открытия счёта.

closed_at        

Время закрытия счёта.

updated_at   string     

Дата последнего обновления.

status   object     
value        

Код статуса.

Одно из:
  • 0 — Открыт
  • 1 — Распечатан
  • 3 — Оплачен
label        

Описание статуса.

payments   object     
accepted        

Принято оплаты.

cash        

Оплата наличными.

cashless        

Оплата безналичными.

bonus        

Оплата бонусами.

other        
shift   object     
id        
opened_at        

Время открытия смены.

closed_at        

Время закрытия смены.

client   object     
id        
name        

Имя клиента.

table   object     
id        
name        

Название стола.

cashbox   object     
id        
name        

Название кассы.

Пример ответа

{
    "data": {
        "id": "9b27df58-f64b-4baa-9f26-d0a9a67a7206",
        "num": 2,
        "sum": 1500,
        "sum_discount": 0,
        "sum_service": 0,
        "discount": 0,
        "service": 0,
        "comment": "",
        "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,
                "discount": null
            }
        ]
    }
}

# Закрыть счёт / чек

Запрос   

POST /orders/{id}/close

Параметры URL

id   string     

ID счёта / чека.
Пример: 00000000-0000-0000-0000-000000000001

Тело запроса

cashbox_id   string     

ID кассы.
Пример: 00000000-0000-0000-0000-000000000001

payments   object[]     

Список платежей.
method_id   string     

ID способа оплаты.
Пример: 00000000-0000-0000-0000-000000000001

sum   number     

Сумма платежа. Значение поля value должно быть не меньше 0.
Пример: 10000

Пример запроса

POST https://next.rosta.kz/api/client/public/orders/00000000-0000-0000-0000-000000000001/close
{
    "cashbox_id": "00000000-0000-0000-0000-000000000001",
    "payments": [
        {
            "method_id": "00000000-0000-0000-0000-000000000001",
            "sum": 10000
        }
    ]
}

Ответ

Поля ответа

data   object     
id   string     

ID счёта.

num   integer     

Номер заказа.

sum   integer     

Сумма заказа к оплате.

sum_discount   integer     

Сумма скидки.

sum_service   integer     

Сумма наценки.

discount   integer     

Процент скидки по-умолчанию.

service   integer     

Процент наценки.

comment   string     

Комментарий к заказу.

opened_at   string     

Время открытия счёта.

closed_at        

Время закрытия счёта.

updated_at   string     

Дата последнего обновления.

status   object     
value        

Код статуса.

Одно из:
  • 0 — Открыт
  • 1 — Распечатан
  • 3 — Оплачен
label        

Описание статуса.

payments   object     
accepted        

Принято оплаты.

cash        

Оплата наличными.

cashless        

Оплата безналичными.

bonus        

Оплата бонусами.

other        
shift   object     
id        
opened_at        

Время открытия смены.

closed_at        

Время закрытия смены.

client   object     
id        
name        

Имя клиента.

table   object     
id        
name        

Название стола.

cashbox   object     
id        
name        

Название кассы.

Пример ответа

{
    "data": {
        "id": "9b27df58-f64b-4baa-9f26-d0a9a67a7206",
        "num": 2,
        "sum": 1500,
        "sum_discount": 0,
        "sum_service": 0,
        "discount": 0,
        "service": 0,
        "comment": "",
        "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,
                "discount": null
            }
        ]
    }
}

# Смены

API для работы со сменами.

# Список смен

Запрос   

GET /shifts

Параметры запроса

user_id   string  необязательно    

ID сотрудника, открывшего смену.
Пример: 00000000-0000-0000-0000-000000000001

tradepoint_id   string  необязательно    

ID торговой точки.
Пример: 00000000-0000-0000-0000-000000000001

workplace_group_id   string  необязательно    

ID группы рабочих мест.
Пример: 00000000-0000-0000-0000-000000000001

is_closed   boolean  необязательно    

Закрыта ли смена.
Пример: false

Пример запроса

GET https://next.rosta.kz/api/client/public/shifts
GET https://next.rosta.kz/api/client/public/shifts?user_id=00000000-0000-0000-0000-000000000001&tradepoint_id=00000000-0000-0000-0000-000000000001&workplace_group_id=00000000-0000-0000-0000-000000000001&is_closed=

Ответ

Поля ответа

data   object     
id   string     

ID смены.

user_id   string     

ID сотрудника, открывшего смену.

tradepoint_id   string     
workplace_group_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
    }
}

# Создать смену

Запрос   

POST /shifts

Тело запроса

tradepoint_id   string     

ID торговой точки.
Пример: 00000000-0000-0000-0000-000000000001

workplace_group_id   string  необязательно    

ID группы рабочих мест.
Пример: 00000000-0000-0000-0000-000000000001

user_id   string     

ID сотрудника, открывшего смену.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

POST https://next.rosta.kz/api/client/public/shifts
{
    "tradepoint_id": "00000000-0000-0000-0000-000000000001",
    "workplace_group_id": "00000000-0000-0000-0000-000000000001",
    "user_id": "00000000-0000-0000-0000-000000000001"
}

Ответ

Поля ответа

data   object     
id   string     

ID смены.

opened_at   string     

Время открытия смены.

closed_at   string     

Время закрытия смены.

updated_at   string     

Дата последнего обновления.

user   object     
id        

ID сотрудника, открывшего смену.

name        

Имя сотрудника, открывшего смену.

tradepoint   object     
id        
name        

Название торговой точки.

workplace_group   object     
name        

Пример ответа

{
    "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
    }
}

# Показать смену

Запрос   

GET /shifts/{id}

Параметры URL

id   string     

ID смены.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/shifts/00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

data   object     
id   string     

ID смены.

opened_at   string     

Время открытия смены.

closed_at   string     

Время закрытия смены.

updated_at   string     

Дата последнего обновления.

user   object     
id        

ID сотрудника, открывшего смену.

name        

Имя сотрудника, открывшего смену.

tradepoint   object     
id        
name        

Название торговой точки.

workplace_group   object     
name        

Пример ответа

{
    "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
    }
}

# Закрыть смену

Запрос   

POST /shifts/{id}/close

Параметры URL

id   string     

ID смены.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

POST https://next.rosta.kz/api/client/public/shifts/00000000-0000-0000-0000-000000000001/close

# Стоп-листы

API для работы со справочником стоп-листы.

# Список стоп-листов.

Запрос   

GET /stoplists

Параметры запроса

show_removed   boolean  необязательно    

Показывать удалённые.
По-умолчанию — 0.
Пример: true

Пример запроса

GET https://next.rosta.kz/api/client/public/stoplists
GET https://next.rosta.kz/api/client/public/stoplists?show_removed=1

Ответ

Поля ответа

data   object     
id        

ID стоп-листа.

user_id        

ID сотрудника Front-офиса.

item_id        

ID товара.

attribute_id        

ID характеристики.

tradepoint_id        

ID торговой точки.

balance        

Оставшееся кол-во товара.

is_removed        

Удалена ли запись.

created_at        

Дата создания.

updated_at        

Дата последнего обновления.

Пример ответа

{
    "data": [
        {
            "id": null,
            "user_id": null,
            "item_id": null,
            "attribute_id": null,
            "tradepoint_id": null,
            "balance": null,
            "is_removed": null,
            "created_at": null,
            "updated_at": null
        },
        {
            "id": null,
            "user_id": null,
            "item_id": null,
            "attribute_id": null,
            "tradepoint_id": null,
            "balance": null,
            "is_removed": null,
            "created_at": null,
            "updated_at": null
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

# Создать стоп-лист.

Запрос   

POST /stoplists

Тело запроса

user_id   string     

ID сотрудника, открывшего смену.
Пример: 00000000-0000-0000-0000-000000000001

item_id   string     

ID товара.
Пример: 00000000-0000-0000-0000-000000000001

attribute_id   string  необязательно    

ID характеристики.
Пример: 00000000-0000-0000-0000-000000000001

tradepoint_id   string     

ID торговой точки.
Пример: 00000000-0000-0000-0000-000000000001

balance   integer     

Оставшееся кол-во товара. Значение поля value должно быть не меньше 0.
Пример: 100

closed_at   string  необязательно    

Дата закрытия. Значение поля value должно быть корректной датой.
Пример: 2026-10-21 21:59

Пример запроса

POST https://next.rosta.kz/api/client/public/stoplists
{
    "user_id": "00000000-0000-0000-0000-000000000001",
    "item_id": "00000000-0000-0000-0000-000000000001",
    "attribute_id": "00000000-0000-0000-0000-000000000001",
    "tradepoint_id": "00000000-0000-0000-0000-000000000001",
    "balance": 100,
    "closed_at": "2026-10-21 21:59"
}

Ответ

Поля ответа

data   object     
id        

ID стоп-листа.

user_id        

ID сотрудника Front-офиса.

item_id        

ID товара.

attribute_id        

ID характеристики.

tradepoint_id        

ID торговой точки.

balance        

Оставшееся кол-во товара.

created_at        

Дата создания.

closed_at        

Дата закрытия.

deleted_at        

Дата удаления.

updated_at        

Дата последнего обновления.

Пример ответа

{
    "data": {
        "id": null,
        "user": null,
        "item": null,
        "attribute": null,
        "tradepoint": null,
        "balance": null,
        "created_at": null,
        "closed_at": null,
        "deleted_at": null,
        "updated_at": null
    }
}

# Показать стоп-лист.

Запрос   

GET /stoplists/{id}

Параметры URL

id   string     

ID стоп-листа.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

GET https://next.rosta.kz/api/client/public/stoplists/00000000-0000-0000-0000-000000000001

Ответ

Поля ответа

data   object     
id        

ID стоп-листа.

user_id        

ID сотрудника Front-офиса.

item_id        

ID товара.

attribute_id        

ID характеристики.

tradepoint_id        

ID торговой точки.

balance        

Оставшееся кол-во товара.

created_at        

Дата создания.

closed_at        

Дата закрытия.

deleted_at        

Дата удаления.

updated_at        

Дата последнего обновления.

Пример ответа

{
    "data": {
        "id": null,
        "user": null,
        "item": null,
        "attribute": null,
        "tradepoint": null,
        "balance": null,
        "created_at": null,
        "closed_at": null,
        "deleted_at": null,
        "updated_at": null
    }
}

# Редактировать стоп-лист.

Запрос   

PUT /stoplists/{id}

PATCH /stoplists/{id}

Параметры URL

id   string     

ID стоп-листа.
Пример: 00000000-0000-0000-0000-000000000001

Тело запроса

user_id   string     

ID сотрудника, открывшего смену.
Пример: 00000000-0000-0000-0000-000000000001

item_id   string     

ID товара.
Пример: 00000000-0000-0000-0000-000000000001

attribute_id   string  необязательно    

ID характеристики.
Пример: 00000000-0000-0000-0000-000000000001

tradepoint_id   string     

ID торговой точки.
Пример: 00000000-0000-0000-0000-000000000001

balance   integer     

Оставшееся кол-во товара. Значение поля value должно быть не меньше 0.
Пример: 100

closed_at   string  необязательно    

Дата закрытия. Значение поля value должно быть корректной датой.
Пример: 2026-10-21 21:59

Пример запроса

PUT https://next.rosta.kz/api/client/public/stoplists/00000000-0000-0000-0000-000000000001
{
    "user_id": "00000000-0000-0000-0000-000000000001",
    "item_id": "00000000-0000-0000-0000-000000000001",
    "attribute_id": "00000000-0000-0000-0000-000000000001",
    "tradepoint_id": "00000000-0000-0000-0000-000000000001",
    "balance": 100,
    "closed_at": "2026-10-21 21:59"
}

Ответ

Поля ответа

data   object     
id        

ID стоп-листа.

user_id        

ID сотрудника Front-офиса.

item_id        

ID товара.

attribute_id        

ID характеристики.

tradepoint_id        

ID торговой точки.

balance        

Оставшееся кол-во товара.

created_at        

Дата создания.

closed_at        

Дата закрытия.

deleted_at        

Дата удаления.

updated_at        

Дата последнего обновления.

Пример ответа

{
    "data": {
        "id": null,
        "user": null,
        "item": null,
        "attribute": null,
        "tradepoint": null,
        "balance": null,
        "created_at": null,
        "closed_at": null,
        "deleted_at": null,
        "updated_at": null
    }
}

# Удалить стоп-лист.

Запрос   

DELETE /stoplists/{id}

Параметры URL

id   string     

ID стоп-листа.
Пример: 00000000-0000-0000-0000-000000000001

Пример запроса

DELETE https://next.rosta.kz/api/client/public/stoplists/00000000-0000-0000-0000-000000000001