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

Раздел "Категории"¶

Получение списка категорий¶

Метод: GET
URL: https://beta.api.gigma.ru/tables/categories
Авторизация: Bearer token

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

page - текущая страница (для пагинации)
per_page - кол-во элементов на странице
query - поисковая строка
date_from - "дата с..." (от даты добавления в систему)
date_to - "дата по..." (от даты добавления в систему)

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

https://beta.api.gigma.ru/tables/categories?query=сей&date_from=30-01-2024

Ответ¶

При успешном действии возвращается HTTP код 200.

href="#__codelineno-0-1">{ "columns": [ { "id": 61, "table_id": 8, "order": 0, "key": "code", "has_icon": 0, "text": "Код" }, { "id": 79, "table_id": 8, "order": 1, "key": "date", "has_icon": 0, "text": "Дата" }, { "id": 62, "table_id": 8, "order": 2, "key": "parent", "has_icon": 1, "text": "Главная" }, { "id": 63, "table_id": 8, "order": 3, "key": "name", "has_icon": 1, "text": "Подчиненная" }, { "id": 80, "table_id": 8, "order": 4, "key": "creator", "has_icon": 1, "text": "Создал" }, { "id": 64, "table_id": 8, "order": 5, "key": "type", "has_icon": 0, "text": "Тип" } ], "categories": [ { "id": 1, "code": "123452", "date": "10.04.2024", "parent": null, "name": { "icon": "http:\/\/localhost:8000\/\/storage\/uploads\/default.jpg", "value": "Аксессуары" }, "creator": { "icon": "http:\/\/localhost:8000\/storage\/uploads\/default.svg", "value": "Полищук Артём" }, "type": "Категория" }, { "id": 2, "code": "12344", "date": "10.04.2024", "parent": { "icon": "http:\/\/localhost:8000\/\/storage\/uploads\/default.jpg", "value": "Аксессуары" }, "name": { "icon": "http:\/\/localhost:8000\/\/storage\/uploads\/default.jpg", "value": "Для макияжа" }, "creator": { "icon": "http:\/\/localhost:8000\/storage\/uploads\/default.svg", "value": "Полищук Артём" }, "type": "Категория" } ], "pagination": { "total": 2, "per_page": 10, "current_page": 1, "last_page": 2, "from": 1, "to": 10 } }

Описание полей ответа¶

columns - объект, содержащий информацию для генерации таблиц
data.id - первичный ключ (ID приложения)
data.date - дата/время добавления
data.code - код в системе
data.parent - информация о родительской категории
data.name - объект с информацией об названии категории (icon - фото, value - название)
data.creator - объект с информацией об создателе (icon - аватар, value - ФИО)
data.type - тип категории
pagination - объект с информацией о пагинации и её текущем статусе

Получение выбранной категории¶

Метод: GET
URL: https://beta.api.gigma.ru/tables/categories/{id}
Авторизация: Bearer token

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

Параметры не передаются.

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

https://beta.api.gigma.ru/tables/categories/1

Ответ¶

При успешном действии возвращается HTTP код 200.

{
    "category": {
        "id": 1,
        "code": "12345",
        "name": "Аксессуары",
        "description": " ",
        "parent": null,
        "photo": {
            "id": 13,
            "name": "default.jpg",
            "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\/default.jpg",
            "created_at": "2024-04-14T20:04:32.000000Z",
            "updated_at": "2024-04-14T20:04:32.000000Z"
        },
        "avatar": null,
        "tags": []
    }
}

Описание полей ответа¶

id - первичный ключ (ID категории)
code - уникальный код
name - название категории
description - описание категории (в формате HTML)
parent - объект с информацией о родительской категории (id - первичный ключ; name - название категории)
photo - объект с информацией о фотографии. Для получения информации о возвращаемых полях [[#Получение выбранного файла|см. запрос]]
avatar - объект с информацией об аватаре. Для получения информации о возвращаемых полях [[#Получение выбранного файла|см. запрос]]
tags - получение массива объектов типа Тег. Для получения информации о возвращаемых полях [[#Получение списка тегов|см. запрос]]

Обновление выбранной категории¶

Метод: PUT
URL: https://beta.api.gigma.ru/categories/{id}
Авторизация: Bearer token

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

code - уникальный код в системе
name - название категории
description - описание категории (в формате HTML)
parent_id - родительская категория (из этого же запроса)
avatar_id - ID аватара (в шапке страницы) из [[#Добавление файла|запроса]]
photo_id - ID фотографии из [[#Добавление файла|запроса]]
tag_id[] - массив ID тегов номенклатуры из [[#Получение списка тегов|запроса]]

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

https://beta.api.gigma.ru/categories/17

{
    "code": 123452,
    "name": "Аксессуары",
    "description": "Любимые напитки",
    "parent_id": 1,
    "avatar_id": null,
    "photo_id": 2,
    "tag_id": []
}

Ответ¶

При успешном действии возвращается HTTP код 200.

{
    "category": {
        "id": 17,
        "code": 123452,
        "name": "Аксессуары",
        "description": " ",
        "parent": null,
        "photo": {
            "id": 2,
            "name": "default.jpg",
            "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\/default.jpg",
            "created_at": "2024-04-14T20:04:32.000000Z",
            "updated_at": "2024-04-14T20:04:32.000000Z"
        },
        "avatar": null,
        "tags": []
    }
}

Описание полей ответа¶

id - первичный ключ (ID категории)
code - уникальный код
name - название категории
description - описание категории (в формате HTML)
parent - объект с информацией о родительской категории (id - первичный ключ; name - название категории)
photo - объект с информацией о фотографии. Для получения информации о возвращаемых полях [[#Получение выбранного файла|см. запрос]]
avatar - объект с информацией об аватаре. Для получения информации о возвращаемых полях [[#Получение выбранного файла|см. запрос]]
tags - получение массива объектов типа Тег. Для получения информации о возвращаемых полях [[#Получение списка тегов|см. запрос]]

Добавление категории¶

Метод: POST
URL: https://beta.api.gigma.ru/categories
Авторизация: Bearer token

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

code - уникальный код в системе
name - название категории
description - описание категории (в формате HTML)
parent_id - родительская категория (из этого же запроса)
avatar_id - ID аватара (в шапке страницы) из [[#Добавление файла|запроса]]
photo_id - ID фотографии из [[#Добавление файла|запроса]]
tag_id[] - массив ID тегов номенклатуры из [[#Получение списка тегов|запроса]]

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

https://beta.api.gigma.ru/categories

{
    "code": 123456,
    "name": "Чай/Кофе/Какао",
    "description": "Любимые напитки",
    "parent_id": 1,
    "avatar_id": 1,
    "photo_id": 2,
    "tag_id": [1, 2]
}

Ответ¶

При успешном действии возвращается HTTP код `201`.

{
    "category": {
        "id": 17,
        "code": 123456,
        "name": "Чай\/Кофе\/Какао",
        "description": "Любимые напитки",
        "parent": {
            "id": 1,
            "name": "Аксессуары"
        },
        "photo": {
            "id": 2,
            "name": "logo.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\/igbcW8dPebcrVfnbC2A2Zptf1nruFcF8Nmf8sVTG.png",
            "created_at": "2024-04-14T20:11:00.000000Z",
            "updated_at": "2024-04-14T20:11:00.000000Z"
        },
        "avatar": {
            "id": 1,
            "name": "logo.svg",
            "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\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
            "created_at": "2024-04-14T20:04:32.000000Z",
            "updated_at": "2024-04-14T20:04:32.000000Z"
        },
        "tags": [
            {
                "id": 1,
                "name": "Кожа",
                "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "created_at": "2024-04-10T07:03:08.000000Z"
            },
            {
                "id": 2,
                "name": "Аксессуар",
                "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "created_at": "2024-04-10T07:03:08.000000Z"
            }
        ]
    }
}

Описание полей ответа¶

id - первичный ключ (ID категории)
code - уникальный код
name - название категории
description - описание категории (в формате HTML)
data.date - дата/время добавления
parent - объект с информацией о родительской категории (id - первичный ключ; name - название категории)
photo - объект с информацией о фотографии. Для получения информации о возвращаемых полях [[#Получение выбранного файла|см. запрос]]
avatar - объект с информацией об аватаре. Для получения информации о возвращаемых полях [[#Получение выбранного файла|см. запрос]]
tags - получение массива объектов типа Тег. Для получения информации о возвращаемых полях [[#Получение списка тегов|см. запрос]]

Получение истории изменений по выбранной категории¶

Метод: GET
URL: https://beta.api.gigma.ru/categories/{id}/history
Авторизация: Bearer token

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

Параметры не передаются.

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

https://beta.api.gigma.ru/categories/1/history

Ответ¶

При успешном действии возвращается HTTP код 200.

{
    "histories": [
        {
            "id": 170,
            "icon": "done",
            "color": "success",
            "title": "Редактирование",
            "description": "Редактирование: Полищук Артём",
            "datetime": "28.06.2024 06:09"
        },
        {
            "id": 171,
            "icon": "done",
            "color": "success",
            "title": "Редактирование",
            "description": "Редактирование: Полищук Артём",
            "datetime": "28.06.2024 06:09"
        },
        {
            "id": 172,
            "icon": "done",
            "color": "success",
            "title": "Редактирование",
            "description": "Редактирование: Полищук Артём",
            "datetime": "28.06.2024 06:23"
        },
        {
            "id": 173,
            "icon": "done",
            "color": "success",
            "title": "Редактирование",
            "description": "Редактирование: Полищук Артём",
            "datetime": "28.06.2024 06:23"
        }
    ],
    "historiesCount": 4
}

Описание полей ответа¶

id - первичный ключ (номер заказа)
icon - иконка
color - цвет
title - заголовок
description - описание
datetime - дата выполнения действия

Раздел "Теги"¶

Получение списка тегов¶

Метод: GET
URL: https://beta.api.gigma.ru/tags
Авторизация: Bearer token

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

Параметры не передаются.

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

https://beta.api.gigma.ru/tags

Ответ¶

При успешном действии возвращается HTTP код 200.

{
    "tags": [
        {
            "id": 1,
            "name": "Кожа",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-04-10T07:03:08.000000Z"
        },
        {
            "id": 2,
            "name": "Аксессуар",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-04-10T07:03:08.000000Z"
        },
        {
            "id": 3,
            "name": "Тушь",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-04-10T07:03:08.000000Z"
        },
        {
            "id": 4,
            "name": "Хит лета",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-04-10T07:03:08.000000Z"
        },
        {
            "id": 5,
            "name": "Вечная молодость",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-04-10T07:03:08.000000Z"
        },
        {
            "id": 6,
            "name": "Философский камень",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-04-10T07:03:08.000000Z"
        }
    ],
    "tagsCount": 6
}

Описание полей ответа¶

id - первичный ключ (ID тега);
name - название тега;
avatar - URL путь к изображению;
created_at - дата/время добавления.

Раздел "Типы"¶

Получение списка типов номенклатурных позиций¶

Метод: GET
URL: https://beta.api.gigma.ru/nomenclature_types
Авторизация: Bearer token

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

Параметры не передаются.

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

https://beta.api.gigma.ru/nomenclature_types

Ответ¶

При успешном действии возвращается HTTP код 200.

{
    "nomenclatureTypes": [
        {
            "id": 1,
            "name": "Услуга",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-07-08T07:01:41.000000Z"
        },
        {
            "id": 2,
            "name": "Товар",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-07-08T07:01:41.000000Z"
        }
    ],
    "nomenclatureTypesCount": 2
}

Описание полей ответа¶

id - первичный ключ (ID типа);
name - название типа;
avatar - URL путь к изображению;
created_at - дата/время добавления.

Раздел "Виды"¶

Получение списка видов номенклатурных позиций¶

Метод: GET
URL: https://beta.api.gigma.ru/nomenclature_kinds
Авторизация: Bearer token

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

Параметры не передаются.

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

https://beta.api.gigma.ru/nomenclature_kinds

Ответ¶

При успешном действии возвращается HTTP код 200.

{
    "nomenclatureKinds": [
        {
            "id": 1,
            "name": "Услуга",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-07-08T07:01:41.000000Z"
        },
        {
            "id": 2,
            "name": "Товар",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-07-08T07:01:41.000000Z"
        }
    ],
    "nomenclatureKindsCount": 2
}

Описание полей ответа¶

id - первичный ключ (ID типа);
name - название типа;
avatar - URL путь к изображению;
created_at - дата/время добавления.

Получение списка номенклатуры (табличное представление)¶

Метод: GET
URL: https://beta.api.gigma.ru/tables/nomenclatures
Авторизация: Bearer token

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

query - поисковая строка
type_id[] - массив для фильтрации номенклатуры по ID типа из справочника
kind_id[] - массив для фильтрации номенклатуры по ID вида из справочника
is_import - булевый признак того, является ли товар импортным (1 - да, 0 - нет)

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

https://beta.api.gigma.ru/tables/nomenclatures?query=BANILA

Ответ¶

При успешном действии возвращается HTTP код 200.

{
    "columns": [
        {
            "id": 65,
            "table_id": 9,
            "order": 0,
            "key": "code",
            "has_icon": 0,
            "text": "Код"
        },
        {
            "id": 66,
            "table_id": 9,
            "order": 1,
            "key": "name",
            "has_icon": 1,
            "text": "Наименование"
        },
        {
            "id": 67,
            "table_id": 9,
            "order": 2,
            "key": "type",
            "has_icon": 1,
            "text": "Тип"
        },
        {
            "id": 68,
            "table_id": 9,
            "order": 3,
            "key": "kind",
            "has_icon": 1,
            "text": "Вид"
        },
        {
            "id": 69,
            "table_id": 9,
            "order": 4,
            "key": "brand",
            "has_icon": 1,
            "text": "Торговая марка"
        },
        {
            "id": 70,
            "table_id": 9,
            "order": 5,
            "key": "unit",
            "has_icon": 0,
            "text": "Ед. изм"
        },
        {
            "id": 71,
            "table_id": 9,
            "order": 6,
            "key": "is_import",
            "has_icon": 0,
            "text": "Импорт"
        },
        {
            "id": 72,
            "table_id": 9,
            "order": 7,
            "key": "country",
            "has_icon": 0,
            "text": "Страна"
        }
    ],
    "nomenclatures": [
        {
            "id": 1,
            "code": "72925",
            "name": {
                "icon": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/default.svg",
                "value": "BANILA CO Glow Fit Foundation Brush"
            },
            "type": {
                "icon": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/default.svg",
                "value": "Товар"
            },
            "kind": {
                "icon": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/default.svg",
                "value": "Товар"
            },
            "brand": {
                "icon": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/default.svg",
                "value": "BANILA CO"
            },
            "unit": "ед",
            "is_import": "Нет",
            "country": "Россия"
        }
    ]
}

Описание полей ответа¶

columns - объект, содержащий информацию для генерации таблиц
current_page - текущая страница
data.id - первичный ключ
data.code - уникальный код товара
data.type - объект с информацией о типе товара/услуги (icon - аватар, value - тип)
data.kind - объект с информацией о виде товара/услуги (icon - аватар, value - вид)
data.brand - объект с информацией о торговой марке (icon - аватар, value - торговая марка)
data.unit - единица измерения
data.country - страна
first_page_url - URL 1-й страницы
last_page_url - URL последней страницы
next_page_url - URL следующей страницы
path - запрос
per_page - кол-во элементов на странице
prev_page_url - URL предыдущей страницы
from - номер первого элемента на выбранной странице
to - номер крайнего элемента на выбранной странице
total - общее кол-во записей

Получение списка номенклатуры¶

Метод: GET
URL: https://beta.api.gigma.ru/nomenclatures
Авторизация: Bearer token

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

page - текущая страница (для пагинации)
per_page - кол-во элементов на странице
query - поисковая строка
type_id[] - массив для фильтрации номенклатуры по ID типа из справочника
kind_id[] - массив для фильтрации номенклатуры по ID вида из справочника
is_import - булевый признак того, является ли товар импортным (1 - да, 0 - нет)

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

https://beta.api.gigma.ru/nomenclatures?query=BANILA

Ответ¶

При успешном действии возвращается HTTP код 200.

{
    "nomenclatures": {
        "current_page": 1,
        "data": [
            {
                "id": 28413,
                "code": null,
                "name": "Тоник ультраувлажняющий 300 мл Hyaluron Layer Toner Mooltox MEDI-PEEL",
                "avatar": {
                    "id": 2856,
                    "name": "696d674d61696e5f38646363626362646466363034303338386538393561373734396535636238618dcc0941e9b0c3bfullhd.webp",
                    "type": {
                        "id": 2,
                        "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\/zjsjQPO97dKSO3Ehcj6JGMsulecTarpb3wehfJsV.webp",
                    "link": null,
                    "created_at": "2025-02-03T12:36:22.000000Z",
                    "updated_at": "2025-02-03T12:36:22.000000Z"
                },
                "preview": {
                    "id": 2854,
                    "name": "696d674d61696e5f38646363626362646466363034303338386538393561373734396535636238618dcc0941e9b0c3bfullhd.webp",
                    "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\/AZ0iF0grOvdspRJeRyMro8GFhI4nLgalZMIlGGrl.webp",
                    "link": null,
                    "created_at": "2025-02-03T12:35:32.000000Z",
                    "updated_at": "2025-02-03T12:35:32.000000Z"
                },
                "description": null,
                "category": {
                    "id": 241,
                    "code": "111",
                    "name": "Уход за кожей вокруг глаз",
                    "description": "<p>уход<\/p>",
                    "parent": null,
                    "photo": {
                        "id": 2885,
                        "name": "Уход за кожей вокруг глаз.png",
                        "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\/gIoMn9mYnYxs6W0iY1N0GIEXTrDSQbnr0cGgIFfJ.png",
                        "link": null,
                        "created_at": "2025-02-07T09:58:03.000000Z",
                        "updated_at": "2025-02-07T09:58:03.000000Z"
                    },
                    "avatar": {
                        "id": 2884,
                        "name": "Уход за кожей вокруг глаз.png",
                        "type": {
                            "id": 2,
                            "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\/60sWWrjh9jkUMBbDhHFwXcpG0311Vz8KP71NcWeY.png",
                        "link": null,
                        "created_at": "2025-02-07T09:58:03.000000Z",
                        "updated_at": "2025-02-07T09:58:03.000000Z"
                    },
                    "tags": []
                },
                "specification": null,
                "country": {
                    "id": 1,
                    "name": "Россия",
                    "avatar": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/default.svg",
                    "created_at": "2024-04-10T06:59:28.000000Z"
                },
                "type": {
                    "id": 2,
                    "name": "Товар",
                    "avatar": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/default.svg",
                    "created_at": "2024-07-08T07:01:41.000000Z"
                },
                "kind": {
                    "id": 2,
                    "name": "Товар",
                    "avatar": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/default.svg",
                    "created_at": "2024-07-08T07:01:41.000000Z"
                },
                "branch": {
                    "id": 38,
                    "code": "1",
                    "avatar": {
                        "id": 2830,
                        "name": "woman-hair-dyeing-1024.webp",
                        "type": {
                            "id": 2,
                            "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\/44P5prcblh9G7dwQMBOux3P2pVHemeiOat11QMcT.webp",
                        "link": null,
                        "created_at": "2025-01-29T03:56:30.000000Z",
                        "updated_at": "2025-01-29T03:56:30.000000Z"
                    },
                    "title": "Торговля косметикой",
                    "inn": "930800053647",
                    "name": "ИП Дерюгин Дмитрий Александрович",
                    "responsible_user": null,
                    "kpp": null,
                    "phone_1": "77949302867",
                    "phone_2": "7",
                    "email": "seimoment@mail.ru",
                    "head": "ИП Дерюгин Дмитрий Александрович",
                    "address": "Донецкая Народная Респ, г Донецк",
                    "legal_address": "Донецкая Народная Респ, г Донецк",
                    "created_at": "2025-01-23T05:59:24.000000Z"
                },
                "tags": [],
                "photos": [],
                "unit": {
                    "id": 12,
                    "name": "Единица",
                    "abbreviation": "ед"
                },
                "brand": {
                    "id": 102,
                    "name": "Mooltox",
                    "avatar": "https:\/\/beta.api.gigma.ru\/\/storage\/uploads\/YVPj9gqb9rgXH8k1Vccf6OHADyxoR0ZmVWX80pQn.jpg",
                    "created_at": "2025-02-03T12:34:09.000000Z"
                },
                "price": "2000.00",
                "cost_price": null,
                "discount": null,
                "vat": {
                    "id": 1,
                    "name": "Без НДС",
                    "avatar": "https:\/\/beta.api.gigma.ru\/storage\/uploads\/default.svg",
                    "created_at": "2024-08-12T09:15:32.000000Z"
                },
                "markup": "0.00",
                "created_at": "2025-01-27T06:33:53.000000Z",
                "updated_at": "2025-02-24T16:26:54.000000Z"
            }
        ],
        "first_page_url": "http:\/\/192.168.0.43:8000\/nomenclatures?page=1",
        "from": 1,
        "last_page": 1600,
        "last_page_url": "http:\/\/192.168.0.43:8000\/nomenclatures?page=1600",
        "links": [
            {
                "url": null,
                "label": "&laquo; Предыдущая",
                "active": false
            },
            {
                "url": "http:\/\/192.168.0.43:8000\/nomenclatures?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "http:\/\/192.168.0.43:8000\/nomenclatures?page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "http:\/\/192.168.0.43:8000\/nomenclatures?page=3",
                "label": "3",
                "active": false
            },
            {
                "url": "http:\/\/192.168.0.43:8000\/nomenclatures?page=4",
                "label": "4",
                "active": false
            },
            {
                "url": "http:\/\/192.168.0.43:8000\/nomenclatures?page=5",
                "label": "5",
                "active": false
            },
            {
                "url": "http:\/\/192.168.0.43:8000\/nomenclatures?page=6",
                "label": "6",
                "active": false
            },
            {
                "url": "http:\/\/192.168.0.43:8000\/nomenclatures?page=7",
                "label": "7",
                "active": false
            },
            {
                "url": "http:\/\/192.168.0.43:8000\/nomenclatures?page=8",
                "label": "8",
                "active": false
            },
            {
                "url": "http:\/\/192.168.0.43:8000\/nomenclatures?page=9",
                "label": "9",
                "active": false
            },
            {
                "url": "http:\/\/192.168.0.43:8000\/nomenclatures?page=10",
                "label": "10",
                "active": false
            },
            {
                "url": null,
                "label": "...",
                "active": false
            },
            {
                "url": "http:\/\/192.168.0.43:8000\/nomenclatures?page=1599",
                "label": "1599",
                "active": false
            },
            {
                "url": "http:\/\/192.168.0.43:8000\/nomenclatures?page=1600",
                "label": "1600",
                "active": false
            },
            {
                "url": "http:\/\/192.168.0.43:8000\/nomenclatures?page=2",
                "label": "Следующая &raquo;",
                "active": false
            }
        ],
        "next_page_url": "http:\/\/192.168.0.43:8000\/nomenclatures?page=2",
        "path": "http:\/\/192.168.0.43:8000\/nomenclatures",
        "per_page": 1,
        "prev_page_url": null,
        "to": 1,
        "total": 1600
    }
}

Описание полей ответа¶

current_page - текущая страница
data.id - первичный ключ
data.code - уникальный код товара
data.type - объект с информацией о типе товара/услуги (icon - аватар, value - тип)
data.kind - объект с информацией о виде товара/услуги (icon - аватар, value - вид)
data.brand - объект с информацией о торговой марке (icon - аватар, value - торговая марка)
data.unit - единица измерения
data.country - страна
path - запрос
per_page - кол-во элементов на странице
prev_page_url - URL предыдущей страницы
from - номер первого элемента на выбранной странице
to - номер крайнего элемента на выбранной странице
total - общее кол-во записей

Добавление номенклатурной позиции¶

Метод: POST
URL: https://beta.api.gigma.ru/nomenclatures
Авторизация: Bearer token

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

avatar_id - ID файла после его загрузки на сервер при помощи запроса
code - уникальный код номенклатурной позиции
name - название номенклатурной позиции
description - описание номенклатурной позиции (HTML)
category_id - ID категории из справочника
specification - спецификации номенклатурной позиции (HTML)
type_id - ID типа номенклатурной позиции из запроса
kind_id - ID вида номенклатурной позиции из запроса
branch_id - ID бизнеса из запроса
tags[] - массив ID тегов из запроса
country_id - ID страны из справочника
preview_id - ID файла после его загрузки на сервер при помощи запроса
photos[] - массив объектов, содержищих поля file_id, order. ID файлов после их загрузки на сервер при помощи запроса, order - порядковый номер файла
brand_id - ID производителя из справочника
storage_unit_id - ID единицы измерения из запроса
price[обязательно, если kind_id = 1] - стоимость товара (числовой с точностью до двух знаков после запятой)
cost_price - себестоимость товара (числовой с точностью до двух знаков после запятой)
markup - наценка (целочисленное значение)
discount - скидка (целочисленное значение)
vat_id - ID НДС. Для получения списка значения используйте запрос

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

https://beta.api.gigma.ru/nomenclatures

{
    "avatar_id": 1,
    "code": "3563342122924",
    "name": "Кофе 2",
    "description": "Кофе Jacobs Monarch Millicano – уникальный продукт среди себе подобных. Молотый в растворимом – напиток нового поколения, который предлагает продегустировать своим поклонникам торговая марка Jacobs. Гранулированный кофе, быстрорастворимый в крутом кипятке, позволяет моментально приготовить чашку бодрящего утреннего напитка. При заваривании гранулы раскрываются, выпуская на свободу частицы натурального молотого кофе средней обжарки мельчайшей фракции. Они насыщают вкус терпкой горчинкой, характерной для арабики, и обогащают аромат. Не пугайтесь, увидев на дне чашки мелкий осадок, он говорит о том, что частички молотого кофе действительно принимали участие в приготовлении тонизирующего напитка. Сочетать Jacobs Monarch Millicano рекомендуем с молоком или нежирными сливками, к вечернему кофе идеально подойдёт капля-другая сливочного ликёра или долька лимона. Производитель рекомендует хранить молотый кофе вдали от прямого воздействия солнечных лучей, поэтому рекомендуем банку убирать в тёмный шкаф и не забывать",
    "category_id": 106,
    "specification": "Вкусный, красивый, дешёвый",
    "type_id": 1,
    "kind_id": 1,
    "storage_unit_id": 1,
    "tags": [
        1,
        2,
        3
    ],
    "country_id": 1,
    "preview_id": 2,
    "photos": [
        {
            "photo_id": 1,
            "order": 1
        },
        {
            "photo_id": 2,
            "order": 2
        },
        {
            "photo_id": 3,
            "order": 3
        }
    ],
    "cost_price": 200.1,
    "price": 230.4,
    "markup": 100,
    "discount": 50,
    "vat_id": 1
}

Ответ¶

При успешном действии возвращается HTTP код 200.

{
    "nomenclature": {
        "id": 11580,
        "code": "3563342122924",
        "name": "Кофе 2",
        "avatar": {
            "id": 1,
            "name": "logo.svg",
            "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\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
            "link": null,
            "created_at": "2024-04-14T20:04:32.000000Z",
            "updated_at": "2024-04-14T20:04:32.000000Z"
        },
        "preview": {
            "id": 2,
            "name": "logo.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\/igbcW8dPebcrVfnbC2A2Zptf1nruFcF8Nmf8sVTG.png",
            "link": null,
            "created_at": "2024-04-14T20:11:00.000000Z",
            "updated_at": "2024-04-14T20:11:00.000000Z"
        },
        "description": "Кофе Jacobs Monarch Millicano – уникальный продукт среди себе подобных. Молотый в растворимом – напиток нового поколения, который предлагает продегустировать своим поклонникам торговая марка Jacobs. Гранулированный кофе, быстрорастворимый в крутом кипятке, позволяет моментально приготовить чашку бодрящего утреннего напитка. При заваривании гранулы раскрываются, выпуская на свободу частицы натурального молотого кофе средней обжарки мельчайшей фракции. Они насыщают вкус терпкой горчинкой, характерной для арабики, и обогащают аромат. Не пугайтесь, увидев на дне чашки мелкий осадок, он говорит о том, что частички молотого кофе действительно принимали участие в приготовлении тонизирующего напитка. Сочетать Jacobs Monarch Millicano рекомендуем с молоком или нежирными сливками, к вечернему кофе идеально подойдёт капля-другая сливочного ликёра или долька лимона. Производитель рекомендует хранить молотый кофе вдали от прямого воздействия солнечных лучей, поэтому рекомендуем банку убирать в тёмный шкаф и не забывать",
        "category": {
            "id": 106,
            "code": "56",
            "name": "Обувь",
            "description": "<p>Обувь <\/p>",
            "parent": null,
            "photo": {
                "id": 1888,
                "name": "image.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\/wmulTvh8w388azHDRHzrbR8SXUxvit1f1sa5sjR5.png",
                "link": null,
                "created_at": "2024-10-22T05:51:24.000000Z",
                "updated_at": "2024-10-22T05:51:24.000000Z"
            },
            "avatar": {
                "id": 1114,
                "name": "450x600 (1).webp",
                "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\/xhoBbHw4Sk6ft2pBVXDj3MvYhUkFbVDDJRO7mNGc.webp",
                "link": null,
                "created_at": "2024-10-02T10:22:35.000000Z",
                "updated_at": "2024-10-02T10:22:35.000000Z"
            },
            "tags": []
        },
        "specification": "Вкусный, красивый, дешёвый",
        "country": {
            "id": 1,
            "name": "Россия",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-04-10T06:59:28.000000Z"
        },
        "type": {
            "id": 1,
            "name": "Материал",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-07-08T07:01:41.000000Z"
        },
        "kind": {
            "id": 1,
            "name": "Услуга",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-07-08T07:01:41.000000Z"
        },
        "branch": null,
        "tags": [
            {
                "id": 1,
                "name": "Кожа",
                "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "created_at": "2024-04-10T07:03:08.000000Z"
            },
            {
                "id": 2,
                "name": "Аксессуар",
                "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "created_at": "2024-04-10T07:03:08.000000Z"
            },
            {
                "id": 3,
                "name": "Тушь",
                "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "created_at": "2024-04-10T07:03:08.000000Z"
            }
        ],
        "photos": [
            {
                "id": 1,
                "name": "logo.svg",
                "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\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
                "link": null,
                "order": 1,
                "created_at": "2024-04-14T20:04:32.000000Z",
                "updated_at": "2024-04-14T20:04:32.000000Z"
            },
            {
                "id": 2,
                "name": "logo.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\/igbcW8dPebcrVfnbC2A2Zptf1nruFcF8Nmf8sVTG.png",
                "link": null,
                "order": 2,
                "created_at": "2024-04-14T20:11:00.000000Z",
                "updated_at": "2024-04-14T20:11:00.000000Z"
            },
            {
                "id": 3,
                "name": "Container.svg",
                "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\/J89936UEJYHmqaWyN8TA2JfTfFHWGvt2jequMsyd.svg",
                "link": null,
                "order": 3,
                "created_at": "2024-04-18T13:37:45.000000Z",
                "updated_at": "2024-04-18T13:37:45.000000Z"
            }
        ],
        "unit": {
            "id": 1,
            "name": "Литр",
            "abbreviation": "л"
        },
        "brand": null,
        "created_at": "2024-12-10T15:18:11.000000Z",
        "updated_at": "2024-12-10T15:18:11.000000Z"
    }
}

Описание полей ответа¶

Описание полей ответа приведено в запросе

Обновление выбранной номенклатурной позиции¶

Метод: PUT
URL: https://beta.api.gigma.ru/nomenclatures/{id}
Авторизация: Bearer token

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

avatar_id - ID файла после его загрузки на сервер при помощи [[#Добавление файла|запроса]]
code - уникальный код номенклатурной позиции
name - название номенклатурной позиции
description - описание номенклатурной позиции (HTML)
category_id - ID категории из справочника
specification - спецификации номенклатурной позиции (HTML)
type_id - ID типа номенклатурной позиции из запроса
kind_id - ID вида номенклатурной позиции из запроса
branch_id - ID бизнеса из [[#Получение списка проектов (бизнесов)|запроса]]
tags[] - массив ID тегов из запроса
country_id - ID страны из справочника
preview_id - ID файла после его загрузки на сервер при помощи запроса
photos[] - массив объектов, содержищих поля file_id, order. ID файлов после их загрузки на сервер при помощи запроса, order - порядковый номер файла
brand_id - ID производителя из справочника
storage_unit_id - ID единицы измерения из запроса
price[обязательно, если kind_id = 1] - стоимость товара (числовой с точностью до двух знаков после запятой)
cost_price - себестоимость товара (числовой с точностью до двух знаков после запятой)
markup - наценка (целочисленное значение)
discount - скидка (целочисленное значение)
vat_id - ID НДС. Для получения списка значения используйте запрос

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

https://beta.api.gigma.ru/nomenclatures/11580

{
    "avatar_id": 1,
    "code": "3563342122924",
    "name": "Кофе 2",
    "description": "Кофе Jacobs Monarch Millicano – уникальный продукт среди себе подобных. Молотый в растворимом – напиток нового поколения, который предлагает продегустировать своим поклонникам торговая марка Jacobs. Гранулированный кофе, быстрорастворимый в крутом кипятке, позволяет моментально приготовить чашку бодрящего утреннего напитка. При заваривании гранулы раскрываются, выпуская на свободу частицы натурального молотого кофе средней обжарки мельчайшей фракции. Они насыщают вкус терпкой горчинкой, характерной для арабики, и обогащают аромат. Не пугайтесь, увидев на дне чашки мелкий осадок, он говорит о том, что частички молотого кофе действительно принимали участие в приготовлении тонизирующего напитка. Сочетать Jacobs Monarch Millicano рекомендуем с молоком или нежирными сливками, к вечернему кофе идеально подойдёт капля-другая сливочного ликёра или долька лимона. Производитель рекомендует хранить молотый кофе вдали от прямого воздействия солнечных лучей, поэтому рекомендуем банку убирать в тёмный шкаф и не забывать",
    "category_id": 106,
    "specification": "Вкусный, красивый, дешёвый",
    "type_id": 1,
    "kind_id": 1,
    "storage_unit_id": 1,
    "tags": [
        1,
        2,
        3
    ],
    "country_id": 1,
    "preview_id": 2,
    "photos": [
        {
            "photo_id": 1,
            "order": 1
        },
        {
            "photo_id": 2,
            "order": 2
        },
        {
            "photo_id": 3,
            "order": 3
        }
    ],
    "price": 230.4,
    "cost_price": 200.1,
    "markup": 100,
    "discount": 50,
    "vat_id": 1
}

Ответ¶

При успешном действии возвращается HTTP код 200.

{
    "nomenclature": {
        "id": 11580,
        "code": "3563342122924",
        "name": "Кофе 2",
        "avatar": {
            "id": 1,
            "name": "logo.svg",
            "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\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
            "link": null,
            "created_at": "2024-04-14T20:04:32.000000Z",
            "updated_at": "2024-04-14T20:04:32.000000Z"
        },
        "preview": {
            "id": 2,
            "name": "logo.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\/igbcW8dPebcrVfnbC2A2Zptf1nruFcF8Nmf8sVTG.png",
            "link": null,
            "created_at": "2024-04-14T20:11:00.000000Z",
            "updated_at": "2024-04-14T20:11:00.000000Z"
        },
        "description": "К",
        "category": {
            "id": 106,
            "code": "56",
            "name": "Обувь",
            "description": "<p>Обувь <\/p>",
            "parent": null,
            "photo": {
                "id": 1888,
                "name": "image.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\/wmulTvh8w388azHDRHzrbR8SXUxvit1f1sa5sjR5.png",
                "link": null,
                "created_at": "2024-10-22T05:51:24.000000Z",
                "updated_at": "2024-10-22T05:51:24.000000Z"
            },
            "avatar": {
                "id": 1114,
                "name": "450x600 (1).webp",
                "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\/xhoBbHw4Sk6ft2pBVXDj3MvYhUkFbVDDJRO7mNGc.webp",
                "link": null,
                "created_at": "2024-10-02T10:22:35.000000Z",
                "updated_at": "2024-10-02T10:22:35.000000Z"
            },
            "tags": []
        },
        "specification": "Вкусный, красивый, дешёвый",
        "country": {
            "id": 1,
            "name": "Россия",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-04-10T06:59:28.000000Z"
        },
        "type": {
            "id": 1,
            "name": "Материал",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-07-08T07:01:41.000000Z"
        },
        "kind": {
            "id": 1,
            "name": "Услуга",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-07-08T07:01:41.000000Z"
        },
        "branch": null,
        "tags": [
            {
                "id": 1,
                "name": "Кожа",
                "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "created_at": "2024-04-10T07:03:08.000000Z"
            }
        ],
        "photos": [],
        "unit": {
            "id": 1,
            "name": "Литр",
            "abbreviation": "л"
        },
        "brand": null,
        "created_at": "2024-12-10T15:18:11.000000Z",
        "updated_at": "2024-12-10T15:19:00.000000Z"
    }
}

Описание полей ответа¶

Описание полей ответа приведено в запросе

Получение выбранной номенклатурной позиции¶

Метод: GET
URL: https://beta.api.gigma.ru/nomenclatures/{id}
Авторизация: Bearer token

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

Параметры не передаются.

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

https://beta.api.gigma.ru/nomenclatures/61

Ответ¶

При успешном действии возвращается HTTP код 200.

{
    "nomenclature": {
        "id": 11580,
        "code": "3563342122924",
        "name": "Кофе 2",
        "avatar": {
            "id": 1,
            "name": "logo.svg",
            "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\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
            "link": null,
            "created_at": "2024-04-14T20:04:32.000000Z",
            "updated_at": "2024-04-14T20:04:32.000000Z"
        },
        "preview": {
            "id": 2,
            "name": "logo.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\/igbcW8dPebcrVfnbC2A2Zptf1nruFcF8Nmf8sVTG.png",
            "link": null,
            "created_at": "2024-04-14T20:11:00.000000Z",
            "updated_at": "2024-04-14T20:11:00.000000Z"
        },
        "description": "К",
        "category": {
            "id": 106,
            "code": "56",
            "name": "Обувь",
            "description": "<p>Обувь <\/p>",
            "parent": null,
            "photo": {
                "id": 1888,
                "name": "image.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\/wmulTvh8w388azHDRHzrbR8SXUxvit1f1sa5sjR5.png",
                "link": null,
                "created_at": "2024-10-22T05:51:24.000000Z",
                "updated_at": "2024-10-22T05:51:24.000000Z"
            },
            "avatar": {
                "id": 1114,
                "name": "450x600 (1).webp",
                "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\/xhoBbHw4Sk6ft2pBVXDj3MvYhUkFbVDDJRO7mNGc.webp",
                "link": null,
                "created_at": "2024-10-02T10:22:35.000000Z",
                "updated_at": "2024-10-02T10:22:35.000000Z"
            },
            "tags": []
        },
        "specification": "Вкусный, красивый, дешёвый",
        "country": {
            "id": 1,
            "name": "Россия",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-04-10T06:59:28.000000Z"
        },
        "type": {
            "id": 1,
            "name": "Материал",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-07-08T07:01:41.000000Z"
        },
        "kind": {
            "id": 1,
            "name": "Услуга",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-07-08T07:01:41.000000Z"
        },
        "branch": null,
        "tags": [
            {
                "id": 1,
                "name": "Кожа",
                "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "created_at": "2024-04-10T07:03:08.000000Z"
            }
        ],
        "photos": [],
        "unit": {
            "id": 1,
            "name": "Литр",
            "abbreviation": "л"
        },
        "brand": null,
        "price": "230.40",
        "discount": 50,
        "vat": {
            "id": 1,
            "name": "Без НДС",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-08-12T09:15:32.000000Z"
        },
        "markup": "100.00",
        "created_at": "2024-12-10T15:18:11.000000Z",
        "updated_at": "2024-12-10T15:19:00.000000Z"
    }
}

Описание полей ответа¶

id - первичный ключ;
code - уникальный код номенклатурной позиции;
name - название номенклатурной позиции;
avatar - объект с информацией о загруженном файле;
preview - объект с информацией о загруженном файле;
description - описание номенклатурной позиции;
category - объект с информацией о категории номенклатурной позиции;
specification - спецификации номенклатурной позиции;
country - объект с информацией о стране производства;
type - объект с информацией о типе номенклатурной позиции;
kind - объект с информацией о виде номенклатурной позиции;
branch - объект с информацией о бизнесе;
tags - массив объектов с информацией о тегах;
photos - массив объектов с информацией о загруженных файлах;
unit - объект с информацией о единицах измерения товара;
brand - объект с информацией о торговой марке;
price - стоимость услуги (применяется только для услуг);
discount - скидка (применяется только для услуг);
vat - объект с информацией о применяемом НДС (применяется только для услуг);
markup - объект с информацией о наценке (применяется только для услуг);
created_at - дата/время добавления записи в систему;
updated_at - дата/время последнего обновления записи в системе.

Получение истории изменений по выбранной номенклатурной позиции¶

Метод: GET
URL: https://beta.api.gigma.ru/nomenclatures/{id}/history
Авторизация: Bearer token

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

Параметры не передаются.

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

https://beta.api.gigma.ru/nomenclatures/58/history

Ответ¶

При успешном действии возвращается HTTP код 200.

{
    "histories": [
        {
            "id": 170,
            "icon": "done",
            "color": "success",
            "title": "Редактирование",
            "description": "Редактирование: Полищук Артём",
            "datetime": "28.06.2024 06:09"
        },
    ],
    "historiesCount": 1
}

Описание полей ответа¶

id - первичный ключ (номер заказа)
icon - иконка
color - цвет
title - заголовок
description - описание
datetime - дата выполнения действия

Раздел "Экспорт/Импорт"¶

Экспорт файла с перечнем номенклатуры¶

Метод: POST
URL: https://beta.api.gigma.ru/nomenclatures/export
Авторизация: Bearer token

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

Передаваемые параметры отсутствуют.

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

https://beta.api.gigma.ru/nomenclatures/export

Ответ¶

При успешном действии возвращается файл в бинарном виде. Сохранить его в разрешении ".xlsx" Пример возвращаемого файла: https://disk.yandex.com/i/hkgq69CGpp2qXg

Импорт файла с перечнем номенклатуры¶

Метод: POST
URL: https://beta.api.gigma.ru/nomenclatures/import
Авторизация: Bearer token

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

file - файл в разрешении ".xlsx". Формат файла: https://disk.yandex.com/i/hkgq69CGpp2qXg

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

https://beta.api.gigma.ru/nomenclatures/import Content-Type: multipart/form-data file => FILE

Ответ¶

{
    "message": "Import successful"
}

Описание полей ответа¶

message - информационное поле