Приложения¶
Получение списка приложений¶
Метод: GET
URL: https://beta.api.gigma.ru/applications
Авторизация: Bearer token
Параметры запроса¶
page- текущая страница (для пагинации)per_page- кол-во элементов на страницеquery- поисковая строкаdate_from- "дата с..." (от даты добавления в систему)date_to- "дата по..." (от даты добавления в систему)
Пример запроса¶
https://beta.api.gigma.ru/applications?query=сей
Ответ¶
При успешном действии возвращается HTTP код 200.
{
"applications": [
{
"id": 10,
"branch": {
"id": 1,
"code": "12334",
"avatar": {
"id": 422,
"name": "png-transparent-web-development-digital-marketing-web-design-search-engine-optimization-web-design-angle-search-engine-optimization-web-design.png",
"type": {
"id": 2,
"name": "Аватар",
"avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "http:\/\/localhost:8000\/storage\/uploads\/9qzh2GCaYpRpaxXnql0JZYpIesu3qlvQLV2OBhcN.png",
"created_at": "2024-07-16T06:54:59.000000Z",
"updated_at": "2024-07-16T06:54:59.000000Z"
},
"title": "Продажа косметики",
"inn": "5403057658",
"name": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ \"АЙТЕКО\"",
"responsible_user": {
"id": 2,
"first_name": "Алексей",
"last_name": "Жуков",
"middle_name": "Игоревич",
"name": "Жуков Алексей"
},
"kpp": "540301001",
"phone_1": "79139121349",
"phone_2": "71231231231",
"email": "2141349@mail.ru",
"head": "Снегирёв Алексей Игоревич",
"address": "630073, Новосибирская область, город Новосибирск, Новогодняя ул., д. 20\/1, кв. 26",
"legal_address": "630073, Новосибирская область, город Новосибирск, Новогодняя ул., д. 20\/1, кв. 26",
"created_at": "2024-03-27T07:26:29.000000Z"
},
"is_website": false,
"photo": {
"id": 83,
"name": "1636190403_8-papik-pro-p-logotip-kosmetiki-foto-9.jpg",
"type": {
"id": 2,
"name": "Аватар",
"avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "http:\/\/localhost:8000\/storage\/uploads\/uPINajA2l2XPB44ojjTEd88wRKxRwsWXIlrgg2iX.jpg",
"created_at": "2024-06-27T07:46:42.000000Z",
"updated_at": "2024-06-27T07:46:42.000000Z"
},
"code": "5135135",
"name": "Сей момент",
"is_token_active": true,
"token": "QV2fPvBKzS3RtQCVMOyVmIMuOd2hU2SO",
"warehouses": [
{
"id": 1,
"code": null,
"photo": null,
"owned_by_us": true,
"address": "Петухова 155\/1 к4",
"storage_capacity": 100000,
"storage_unit": {
"id": 2,
"name": "Кубический метр",
"abbreviation": "м³"
},
"city": {
"id": 2,
"name": "Новосибирск",
"avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
"created_at": "2024-04-19T09:18:41.000000Z"
},
"counterparty": null
},
{
"id": 2,
"code": null,
"photo": null,
"owned_by_us": true,
"address": "Ленина 25",
"storage_capacity": 100000,
"storage_unit": {
"id": 2,
"name": "Кубический метр",
"abbreviation": "м³"
},
"city": {
"id": 2,
"name": "Новосибирск",
"avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
"created_at": "2024-04-19T09:18:41.000000Z"
},
"counterparty": null
}
],
"sales_strategy": {
"id": 1,
"name": "Продать остатки",
"avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
"created_at": "2024-06-20T10:01:33.000000Z"
}
}
]
}
Описание полей ответа¶
Описание полей ответа приведено в запросе
Получение выбранного приложения¶
Метод: GET
URL: https://beta.api.gigma.ru/applications/{id}
Авторизация: Bearer token
Параметры запроса¶
Параметры отсутствуют.
Пример запроса¶
https://beta.api.gigma.ru/applications/1
Ответ¶
При успешном действии возвращается HTTP код 200.
{
"application": {
"id": 1,
"branch": {
"id": 1,
"code": "1349",
"avatar": {
"id": 40,
"name": "organic-cosmetics_icon-icons.com_49218.png",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "http:\/\/localhost:8000\/storage\/uploads\/organic-cosmetics_icon-icons.com_49218.png",
"created_at": "2024-06-17T16:05:02.000000Z",
"updated_at": "2024-06-17T16:05:02.000000Z"
},
"title": "Продажа косметики",
"inn": "5403057658",
"name": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ \"АЙТЕКО\"",
"kpp": "540301001",
"phone_1": "79139121349",
"phone_2": "",
"email": "2141349@mail.ru",
"head": "Снегирёв Алексей Игоревич",
"address": "630073, Новосибирская область, город Новосибирск, Новогодняя ул., д. 20\/1, кв. 26",
"legal_address": "630073, Новосибирская область, город Новосибирск, Новогодняя ул., д. 20\/1, кв. 26",
"created_at": "2024-03-27T07:26:29.000000Z"
},
"is_website": false,
"photo": null,
"code": "",
"name": "Мобильное приложение Сей-Момент",
"is_token_active": false,
"token": "QV2fPvBKzS3RtQCVMOyVmIMuOd2hU2SO",
"warehouses": [
{
"id": 1,
"photo": null,
"owned_by_us": true,
"address": "Петухова 155\/1 к4",
"storage_capacity": 100000,
"city_id": {
"id": 2,
"name": "Новосибирск",
"avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
"created_at": "2024-04-19T09:18:41.000000Z"
}
}
],
"sales_strategy": {
"id": 1,
"name": "Продать остатки",
"avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
"created_at": "2024-06-20T09:58:07.000000Z"
}
}
}
Описание полей ответа¶
id- первичный ключ (ID приложения)branch- объект с информацией о бизнесе. Для получения информации о возвращаемых полях см. запросis_website- булевый признак. true - веб-сайт, false - приложениеphoto- объект с информацией о фотографии. Для получения информации о полях см. запросcode- код приложенияname- название приложенияis_token_active- булевый признак того, активен ли токен приложенияtoken- токен приложенияwarehouses- массив объектов, содержащих информацию о складе. Для получение информации о возвращаемых полях см. запросsales_strategy- объект с информацией о стратегии продаж. Для получения информации о возвращаемых полях см. запрос
Категории товаров приложения¶
Получение списка категорий приложения (табличное представление)¶
Метод: GET
URL: https://beta.api.gigma.ru/tables/applications/{id}/categories
Авторизация: Bearer token
Параметры запроса¶
page- текущая страница (для пагинации)per_page- кол-во элементов на страницеquery- поисковая строка
Пример запроса¶
https://beta.api.gigma.ru/tables/applications/14/categories?query=Уход
Ответ¶
При успешном действии возвращается HTTP код 200.
{
"columns": [
{
"id": 118,
"table_id": 15,
"order": 0,
"key": "id",
"has_icon": 0,
"text": "№"
},
{
"id": 119,
"table_id": 15,
"order": 1,
"key": "date",
"has_icon": 0,
"text": "Дата"
},
{
"id": 120,
"table_id": 15,
"order": 2,
"key": "parent",
"has_icon": 1,
"text": "Главная"
},
{
"id": 121,
"table_id": 15,
"order": 3,
"key": "name",
"has_icon": 1,
"text": "Подчиненная"
},
{
"id": 122,
"table_id": 15,
"order": 4,
"key": "creator",
"has_icon": 1,
"text": "Создал"
},
{
"id": 123,
"table_id": 15,
"order": 5,
"key": "priority",
"has_icon": 0,
"text": "Приоритет"
}
],
"categories": [
{
"id": 1,
"date": "02.08.2024",
"parent": null,
"name": {
"icon": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
"value": "Уход за кожей лица"
},
"creator": {
"icon": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
"value": "Жуков Алексей"
},
"priority": 1
}
],
"pagination": {
"total": 1,
"per_page": 10,
"current_page": 1,
"last_page": 1,
"from": 1,
"to": 1
}
}
Описание полей ответа¶
id- первичный ключ (ID категории)description- описание категории (элемента меню) в формате HTMLparent- объект с информацией о родительской категории (элементе меню) (id - первичный ключ; name - название категории)creator- объект с информацией о создателе (id - первичный ключ; name - имя создателя)priority- приоритет категории (элемента меню) по отношению к другим категориям (ниже значение - выше приоритет)
Получение списка категорий приложения¶
Метод: GET
URL: https://beta.api.gigma.ru/applications/{id}/categories
Авторизация: Bearer token
Параметры запроса¶
Пример запроса¶
https://beta.api.gigma.ru/applications/14/categories
Ответ¶
При успешном действии возвращается HTTP код 200.
{
"categories": [
{
"id": 36,
"code": "4",
"name": "Декоративная",
"description": "<p>Декоративная косметика<\/p>",
"parent": null,
"photo": {
"id": 801,
"name": "decorative_cosmetics.png",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "http:\/\/localhost:8000\/storage\/uploads\/decorative_cosmetics.png",
"created_at": "2024-08-05T09:13:24.000000Z",
"updated_at": "2024-08-05T09:13:24.000000Z"
},
"avatar": null,
"tags": [
{
"id": 2,
"name": "Аксессуар",
"avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
"created_at": "2024-04-10T07:03:08.000000Z"
}
]
},
{
"id": 35,
"code": "33",
"name": "Уход за кожей вокруг глаз",
"description": "<p>Уход за кожей вокруг глаз<\/p>",
"parent": null,
"photo": {
"id": 810,
"name": "eye_skin_care.png",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "http:\/\/localhost:8000\/storage\/uploads\/eye_skin_care.png",
"created_at": "2024-08-05T09:13:24.000000Z",
"updated_at": "2024-08-05T09:13:24.000000Z"
},
"avatar": null,
"tags": [
{
"id": 2,
"name": "Аксессуар",
"avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
"created_at": "2024-04-10T07:03:08.000000Z"
}
]
}
],
"categoriesCount": 2
}
Описание полей ответа¶
Описание возвращаемых полей полностью аналогично данному
Добавление категории приложения¶
Метод: POST
URL: https://beta.api.gigma.ru/applications/{id}/categories
Авторизация: Bearer token
Параметры запроса¶
category_id- ID добавляемой категории из запроса с параметром query
Пример запроса¶
https://beta.api.gigma.ru/applications/14/categories
Ответ¶
При успешном действии возвращается HTTP код 200.
{
"category": {
"id": 35,
"code": "33",
"name": "Уход за кожей вокруг глаз",
"description": "<p>Уход за кожей вокруг глаз<\/p>",
"parent": null,
"photo": {
"id": 810,
"name": "eye_skin_care.png",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "http:\/\/localhost:8000\/storage\/uploads\/eye_skin_care.png",
"created_at": "2024-08-05T09:13:24.000000Z",
"updated_at": "2024-08-05T09:13:24.000000Z"
},
"avatar": null,
"tags": [
{
"id": 2,
"name": "Аксессуар",
"avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
"created_at": "2024-04-10T07:03:08.000000Z"
}
]
}
}
Описание полей ответа¶
Описание возвращаемых полей полностью аналогично данному
Получение выбранной категории приложения¶
Метод: POST
URL: https://beta.api.gigma.ru/applications/{id}/categories/{id}
Авторизация: Bearer token
Параметры запроса¶
Параметры не передаются.
Пример запроса¶
https://beta.api.gigma.ru/applications/14/categories/35
Ответ¶
При успешном действии возвращается HTTP код 200.
{
"category": {
"id": 35,
"code": "33",
"name": "Уход за кожей вокруг глаз",
"description": "<p>Уход за кожей вокруг глаз<\/p>",
"parent": null,
"photo": {
"id": 810,
"name": "eye_skin_care.png",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "http:\/\/localhost:8000\/storage\/uploads\/eye_skin_care.png",
"created_at": "2024-08-05T09:13:24.000000Z",
"updated_at": "2024-08-05T09:13:24.000000Z"
},
"avatar": null,
"tags": [
{
"id": 2,
"name": "Аксессуар",
"avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
"created_at": "2024-04-10T07:03:08.000000Z"
}
]
}
}
Описание полей ответа¶
Описание возвращаемых полей полностью аналогично данному
Удаление выбранной категории приложения¶
Метод: DELETE
URL: https://beta.api.gigma.ru/applications/{id}/categories/{id}
Авторизация: Bearer token
Параметры запроса¶
Параметры не передаются.
Пример запроса¶
https://beta.api.gigma.ru/applications/14/categories/35
Ответ¶
При успешном действии возвращается HTTP код 200.
Описание полей ответа¶
message- информационное сообщение.
Увеличение приоритета выбранной категории приложения¶
Метод: POST
URL: https://beta.api.gigma.ru/applications/{id}/categories/{id}/up
Авторизация: Bearer token
Параметры запроса¶
Параметры не передаются.
Пример запроса¶
https://beta.api.gigma.ru/applications/14/categories/35/up
Ответ¶
При успешном действии возвращается HTTP код 200.
Описание полей ответа¶
message- информационное сообщение.
Уменьшение приоритета выбранной категории приложения¶
Метод: POST
URL: https://beta.api.gigma.ru/applications/{id}/categories/{id}/down
Авторизация: Bearer token
Параметры запроса¶
Параметры не передаются.
Пример запроса¶
https://beta.api.gigma.ru/applications/14/categories/35/down
Ответ¶
При успешном действии возвращается HTTP код 200.
Описание полей ответа¶
message- информационное сообщение.
Торговые марки приложения¶
Получение списка торговых марок приложения (табличное представление)¶
Метод: GET
URL: https://beta.api.gigma.ru/tables/applications/{id}/brands
Авторизация: Bearer token
Параметры запроса¶
page- текущая страница (для пагинации)per_page- кол-во элементов на страницеquery- поисковая строка
Пример запроса¶
https://beta.api.gigma.ru/tables/applications/14/brands?query=Уход
Ответ¶
При успешном действии возвращается HTTP код 200.
{
"columns": [
{
"id": 144,
"table_id": 18,
"order": 0,
"key": "code",
"has_icon": 0,
"text": "Код"
},
{
"id": 147,
"table_id": 18,
"order": 1,
"key": "date",
"has_icon": 0,
"text": "Дата"
},
{
"id": 145,
"table_id": 18,
"order": 2,
"key": "name",
"has_icon": 1,
"text": "Название"
},
{
"id": 146,
"table_id": 18,
"order": 3,
"key": "creator",
"has_icon": 1,
"text": "Создал"
}
],
"brands": [
{
"id": 35,
"code": 35,
"date": "25.12.2024",
"name": {
"icon": "http:\/\/localhost:8000\/\/storage\/uploads\/otFWtpqfjEaBmD3e8NhWRdw76CvhUav0ONmUHOvn.jpg",
"value": "Супер"
},
"creator": {
"icon": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
"value": "Иванов Иван",
"link": "https:\/\/beta.erp.itecho.ru\/users\/list-users\/67"
},
"priority": 0
}
],
"pagination": {
"total": 1,
"per_page": 10,
"current_page": 1,
"last_page": 1,
"from": 1,
"to": 1
}
}
Описание полей ответа¶
id- первичный ключ (ID категории)date- дата добавления в системуname- название торговой маркиcreator- объект с информацией о создателе (id - первичный ключ; name - имя создателя)priority- приоритет категории (элемента меню) по отношению к другим категориям (ниже значение - выше приоритет)
Получение списка торговых марок приложения¶
Метод: GET
URL: https://beta.api.gigma.ru/applications/{id}/brands
Авторизация: Bearer token
Параметры запроса¶
Пример запроса¶
https://beta.api.gigma.ru/applications/14/brands
Ответ¶
При успешном действии возвращается HTTP код 200.
{
"brands": [
{
"id": 35,
"name": "Супер",
"avatar": "http:\/\/localhost:8000\/\/storage\/uploads\/otFWtpqfjEaBmD3e8NhWRdw76CvhUav0ONmUHOvn.jpg",
"created_at": "2024-11-26T08:43:26.000000Z"
}
],
"brandsCount": 1
}
Описание полей ответа¶
Описание возвращаемых полей полностью аналогично данному
Добавление торговой марки приложения¶
Метод: POST
URL: https://beta.api.gigma.ru/applications/{id}/brands
Авторизация: Bearer token
Параметры запроса¶
brand_id- ID добавляемой торговой марки из запроса с параметром query
Пример запроса¶
https://beta.api.gigma.ru/applications/14/brands
Ответ¶
При успешном действии возвращается HTTP код 200.
{
"brand": {
"id": 35,
"name": "Супер",
"avatar": "http:\/\/localhost:8000\/\/storage\/uploads\/otFWtpqfjEaBmD3e8NhWRdw76CvhUav0ONmUHOvn.jpg",
"created_at": "2024-11-26T08:43:26.000000Z"
}
}
Описание полей ответа¶
Описание возвращаемых полей полностью аналогично данному
Получение выбранной торговой марки приложения¶
Метод: POST
URL: https://beta.api.gigma.ru/applications/{id}/brands/{id}
Авторизация: Bearer token
Параметры запроса¶
Параметры не передаются.
Пример запроса¶
https://beta.api.gigma.ru/applications/14/brands/35
Ответ¶
При успешном действии возвращается HTTP код 200.
{
"brand": {
"id": 35,
"name": "Супер",
"avatar": "http:\/\/localhost:8000\/\/storage\/uploads\/otFWtpqfjEaBmD3e8NhWRdw76CvhUav0ONmUHOvn.jpg",
"created_at": "2024-11-26T08:43:26.000000Z"
}
}
Описание полей ответа¶
Описание возвращаемых полей полностью аналогично данному
Удаление выбранной торговой марки приложения¶
Метод: DELETE
URL: https://beta.api.gigma.ru/applications/{id}/brands/{id}
Авторизация: Bearer token
Параметры запроса¶
Параметры не передаются.
Пример запроса¶
https://beta.api.gigma.ru/applications/14/brands/35
Ответ¶
При успешном действии возвращается HTTP код 200.
Описание полей ответа¶
message- информационное сообщение.
Увеличение приоритета выбранной торговой марки приложения¶
Метод: POST
URL: https://beta.api.gigma.ru/applications/{id}/brands/{id}/up
Авторизация: Bearer token
Параметры запроса¶
Параметры не передаются.
Пример запроса¶
https://beta.api.gigma.ru/applications/14/brands/35/up
Ответ¶
При успешном действии возвращается HTTP код 200.
Описание полей ответа¶
message- информационное сообщение.
Уменьшение приоритета выбранной торговой марки приложения¶
Метод: POST
URL: https://beta.api.gigma.ru/applications/{id}/brands/{id}/down
Авторизация: Bearer token
Параметры запроса¶
Параметры не передаются.
Пример запроса¶
https://beta.api.gigma.ru/applications/14/brands/35/down
Ответ¶
При успешном действии возвращается HTTP код 200.
Описание полей ответа¶
message- информационное сообщение.
Меню приложения¶
Получение меню приложения (табличное представление)¶
Метод: GET
URL: https://beta.api.gigma.ru/tables/applications/{id}/menu_items
Авторизация: Bearer token
Параметры запроса¶
page- текущая страница (для пагинации)per_page- кол-во элементов на страницеquery- поисковая строка
Пример запроса¶
https://beta.api.gigma.ru/tables/applications/14/menu_items
Ответ¶
При успешном действии возвращается HTTP код 200.
{
"columns": [
{
"id": 158,
"table_id": 21,
"order": 0,
"key": "code",
"has_icon": 0,
"text": "Код"
},
{
"id": 159,
"table_id": 21,
"order": 1,
"key": "date",
"has_icon": 0,
"text": "Дата"
},
{
"id": 160,
"table_id": 21,
"order": 2,
"key": "name",
"has_icon": 0,
"text": "Название"
},
{
"id": 161,
"table_id": 21,
"order": 3,
"key": "path",
"has_icon": 0,
"text": "Путь"
},
{
"id": 162,
"table_id": 21,
"order": 4,
"key": "slug",
"has_icon": 0,
"text": "Slug"
},
{
"id": 163,
"table_id": 21,
"order": 5,
"key": "creator",
"has_icon": 0,
"text": "Создал"
}
],
"items": [
{
"id": {
"icon": null,
"value": 1,
"url": ""
},
"code": 1,
"date": "2025-02-03T11:07:11.000000Z",
"name": {
"icon": "https:\/\/beta.api.gigma.ru\/\/storage\/uploads\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
"value": "Обувь"
},
"path": "> Главная > Обувь",
"slug": "shoes",
"creator": {
"icon": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/default.svg",
"value": "Иванов Иван"
}
}
],
"pagination": {
"total": 1,
"per_page": 10,
"current_page": 1,
"last_page": 1,
"from": 1,
"to": 1
}
}
Описание полей ответа¶
id- первичный ключdate- дата добавленияname- имя пункта менюpath- путь к элементу менюslug- ссылка на пункт менюcreator- объект с информацией о создателе (id - первичный ключ; name - имя создателя)
Получение списка меню приложения¶
Метод: GET
URL: https://beta.api.gigma.ru/applications/{id}/menu_items
Авторизация: Bearer token
Параметры запроса¶
Пример запроса¶
https://beta.api.gigma.ru/applications/14/menu_items
Ответ¶
При успешном действии возвращается HTTP код 200.
{
"menuItems": [
{
"id": 1,
"code": 1,
"avatar": {
"id": 1,
"name": "logo.svg",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T04:00:46.000000Z"
},
"path": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
"link": null,
"created_at": "2024-04-14T17:04:32.000000Z",
"updated_at": "2024-04-14T17:04:32.000000Z"
},
"preview": {
"id": 1,
"name": "logo.svg",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T04:00:46.000000Z"
},
"path": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
"link": null,
"created_at": "2024-04-14T17:04:32.000000Z",
"updated_at": "2024-04-14T17:04:32.000000Z"
},
"name": "Обувь",
"slug": "shoes",
"children": [],
"created_at": "2025-02-03T11:07:11.000000Z"
}
],
"menuItemsCount": 1
}
Описание полей ответа¶
Описание возвращаемых полей полностью аналогично данному
Добавление пункта в меню приложения¶
Метод: POST
URL: https://beta.api.gigma.ru/applications/{id}/menu_items
Авторизация: Bearer token
Параметры запроса¶
name- имя пункта менюslug- ссылка на пункт менюparent_id- ID родительского элемента меню из запросаavatar_id- ID загруженного при помощи запроса файлаpreview_id- ID загруженного при помощи запроса файла
Пример запроса¶
https://beta.api.gigma.ru/applications/14/menu_items
Ответ¶
При успешном действии возвращается HTTP код 200.
{
"item": {
"id": 1,
"code": 1,
"avatar": {
"id": 1,
"name": "logo.svg",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T04:00:46.000000Z"
},
"path": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
"link": null,
"created_at": "2024-04-14T17:04:32.000000Z",
"updated_at": "2024-04-14T17:04:32.000000Z"
},
"preview": {
"id": 1,
"name": "logo.svg",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T04:00:46.000000Z"
},
"path": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
"link": null,
"created_at": "2024-04-14T17:04:32.000000Z",
"updated_at": "2024-04-14T17:04:32.000000Z"
},
"name": "Обувь",
"slug": "shoes",
"parent": null,
"created_at": "2025-02-03T11:07:11.000000Z"
}
}
Описание полей ответа¶
Описание возвращаемых полей полностью аналогично данному
Обновление выбранного пункта меню приложения¶
Метод: POST
URL: https://beta.api.gigma.ru/applications/{id}/menu_items/{id}
Авторизация: Bearer token
Параметры запроса¶
name- имя пункта менюslug- ссылка на пункт менюparent_id- ID родительского элемента меню из запросаavatar_id- ID загруженного при помощи запроса файлаpreview_id- ID загруженного при помощи запроса файла
Пример запроса¶
https://beta.api.gigma.ru/applications/14/menu_items/10
Ответ¶
При успешном действии возвращается HTTP код 200.
{
"item": {
"id": 10,
"code": 10,
"avatar": {
"id": 1,
"name": "logo.svg",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
"link": null,
"created_at": "2024-04-14T20:04:32.000000Z",
"updated_at": "2024-04-14T20:04:32.000000Z"
},
"preview": {
"id": 1,
"name": "logo.svg",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
"link": null,
"created_at": "2024-04-14T20:04:32.000000Z",
"updated_at": "2024-04-14T20:04:32.000000Z"
},
"name": "Одежда",
"slug": "test",
"parent": {
"id": 1,
"code": 1,
"avatar": null,
"preview": null,
"name": "Одежда",
"slug": "test",
"parent": null,
"created_at": "2025-02-03T07:05:15.000000Z"
},
"created_at": "2025-02-03T07:14:05.000000Z"
}
}
Описание полей ответа¶
Описание возвращаемых полей полностью аналогично данному
Получение выбранного пункта меню¶
Метод: POST
URL: https://beta.api.gigma.ru/applications/{id}/menu_items/{id}
Авторизация: Bearer token
Параметры запроса¶
Параметры не передаются.
Пример запроса¶
https://beta.api.gigma.ru/applications/14/menu_items/1
Ответ¶
При успешном действии возвращается HTTP код 200.
{
"item": {
"id": 1,
"code": 1,
"avatar": {
"id": 1,
"name": "logo.svg",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T04:00:46.000000Z"
},
"path": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
"link": null,
"created_at": "2024-04-14T17:04:32.000000Z",
"updated_at": "2024-04-14T17:04:32.000000Z"
},
"preview": {
"id": 1,
"name": "logo.svg",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T04:00:46.000000Z"
},
"path": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
"link": null,
"created_at": "2024-04-14T17:04:32.000000Z",
"updated_at": "2024-04-14T17:04:32.000000Z"
},
"name": "Обувь",
"slug": "shoes",
"parent": null,
"created_at": "2025-02-03T11:07:11.000000Z"
}
}
Описание полей ответа¶
Описание возвращаемых полей полностью аналогично данному
Удаление выбранного пункта меню приложения¶
Метод: DELETE
URL: https://beta.api.gigma.ru/applications/{id}/menu_items/{id}
Авторизация: Bearer token
Параметры запроса¶
Параметры не передаются.
Пример запроса¶
https://beta.api.gigma.ru/applications/14/menu_items/1
Ответ¶
При успешном действии возвращается HTTP код 200.
Описание полей ответа¶
message- информационное сообщение.
Увеличение приоритета выбранной пункта меню приложения¶
Метод: POST
URL: https://beta.api.gigma.ru/applications/{id}/menu_items/{id}/up
Авторизация: Bearer token
Параметры запроса¶
Параметры не передаются.
Пример запроса¶
https://beta.api.gigma.ru/applications/14/menu_items/1/up
Ответ¶
При успешном действии возвращается HTTP код 200.
{
"item": {
"id": 45,
"code": 6,
"avatar": {
"id": 1,
"name": "logo.svg",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
"link": null,
"created_at": "2024-04-14T20:04:32.000000Z",
"updated_at": "2024-04-14T20:04:32.000000Z"
},
"preview": {
"id": 1,
"name": "logo.svg",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
"link": null,
"created_at": "2024-04-14T20:04:32.000000Z",
"updated_at": "2024-04-14T20:04:32.000000Z"
},
"name": "Обувь",
"slug": "test",
"parent": null,
"created_at": "2025-02-03T08:35:44.000000Z"
}
}
Описание полей ответа¶
Описание возвращаемых полей полностью аналогично данному
Уменьшение приоритета выбранного пункта меню приложения¶
Метод: POST
URL: https://beta.api.gigma.ru/applications/{id}/menu_items/{id}/down
Авторизация: Bearer token
Параметры запроса¶
Параметры не передаются.
Пример запроса¶
https://beta.api.gigma.ru/applications/14/menu_items/1/down
Ответ¶
При успешном действии возвращается HTTP код 200.
{
"item": {
"id": 45,
"code": 6,
"avatar": {
"id": 1,
"name": "logo.svg",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
"link": null,
"created_at": "2024-04-14T20:04:32.000000Z",
"updated_at": "2024-04-14T20:04:32.000000Z"
},
"preview": {
"id": 1,
"name": "logo.svg",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
"link": null,
"created_at": "2024-04-14T20:04:32.000000Z",
"updated_at": "2024-04-14T20:04:32.000000Z"
},
"name": "Обувь",
"slug": "test",
"parent": null,
"created_at": "2025-02-03T08:35:44.000000Z"
}
}
Описание полей ответа¶
Описание возвращаемых полей полностью аналогично данному