Перейти к содержанию

Справочники

Экраны

Получение списка экранов, к которым применяется проверка права на доступ

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

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

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

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

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

Ответ

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

{
    "screens": [
        {
            "id": 1,
            "name": "Контрагенты",
            "permissions": [
                {
                    "id": 9,
                    "screen": {
                        "id": 1,
                        "name": "Контрагенты",
                        "created_at": "2024-03-27T07:00:46.000000Z"
                    },
                    "name": "view-counterparties",
                    "description": "Просмотр контрагентов",
                    "created_at": "2024-03-27T07:00:46.000000Z"
                },
                {
                    "id": 10,
                    "screen": {
                        "id": 1,
                        "name": "Контрагенты",
                        "created_at": "2024-03-27T07:00:46.000000Z"
                    },
                    "name": "edit-counterparties",
                    "description": "Редактирование контрагентов",
                    "created_at": "2024-03-27T07:00:46.000000Z"
                }
            ]
        },
        {
            "id": 2,
            "name": "Заказы",
            "permissions": [
                {
                    "id": 13,
                    "screen": {
                        "id": 2,
                        "name": "Заказы",
                        "created_at": "2024-03-27T07:00:46.000000Z"
                    },
                    "name": "view-orders",
                    "description": "Просмотр заказов",
                    "created_at": "2024-03-27T07:00:46.000000Z"
                },
                {
                    "id": 14,
                    "screen": {
                        "id": 2,
                        "name": "Заказы",
                        "created_at": "2024-03-27T07:00:46.000000Z"
                    },
                    "name": "edit-orders",
                    "description": "Редактирование заказов",
                    "created_at": "2024-03-27T07:00:46.000000Z"
                }
            ]
        },
        {
            "id": 3,
            "name": "Задачи",
            "permissions": [
                {
                    "id": 15,
                    "screen": {
                        "id": 3,
                        "name": "Задачи",
                        "created_at": "2024-03-27T07:00:46.000000Z"
                    },
                    "name": "view-tasks",
                    "description": "Просмотр задач",
                    "created_at": "2024-03-27T07:00:46.000000Z"
                },
                {
                    "id": 16,
                    "screen": {
                        "id": 3,
                        "name": "Задачи",
                        "created_at": "2024-03-27T07:00:46.000000Z"
                    },
                    "name": "edit-tasks",
                    "description": "Редактирование задач",
                    "created_at": "2024-03-27T07:00:46.000000Z"
                }
            ]
        }
    ],
    "screensCount": 3
}
Описание полей ответа
  • id - первичный ключ
  • name - название экрана
  • permissions - массив объектов, содержащих права доступа пользователя. Для подробной информации о полях объекта permissions см. запрос

Получение выбранного экрана со списком прав доступа

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

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

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

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

https://beta.api.gigma.ru/screens/1

Ответ

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

{
    "screen": {
        "id": 1,
        "name": "Контрагенты",
        "permissions": [
            {
                "id": 9,
                "screen": {
                    "id": 1,
                    "name": "Контрагенты",
                    "created_at": "2024-03-27T07:00:46.000000Z"
                },
                "name": "view-counterparties",
                "description": "Просмотр контрагентов",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            {
                "id": 10,
                "screen": {
                    "id": 1,
                    "name": "Контрагенты",
                    "created_at": "2024-03-27T07:00:46.000000Z"
                },
                "name": "edit-counterparties",
                "description": "Редактирование контрагентов",
                "created_at": "2024-03-27T07:00:46.000000Z"
            }
        ]
    }
}
Описание полей ответа
  • id - первичный ключ
  • name - название экрана
  • permissions - массив объектов, содержащих права доступа пользователя. Для подробной информации о полях объекта permissions см. запрос

Типы контрагентов

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

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

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

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

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

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

Ответ

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

{
    "counterpartyTypes": [
        {
            "id": 1,
            "name": "Заказчик",
            "created_at": "2024-03-27T07:00:46.000000Z"
        },
        {
            "id": 2,
            "name": "Поставщик",
            "created_at": "2024-03-27T07:00:46.000000Z"
        }
    ],
    "counterpartyTypesCount": 2
}
Описание полей ответа
  • id - первичный ключ
  • name - тип контрагента
  • created_at - дата и время добавления в систему

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

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

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

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

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

https://beta.api.gigma.ru/counterparty_types/1

Ответ

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

{
    "counterpartyType": {
        "id": 1,
        "name": "Заказчик",
        "created_at": "2024-03-27T07:00:46.000000Z"
    }
}
Описание полей ответа
  • id - первичный ключ
  • name - тип контрагента
  • created_at - дата и время добавления в систему

Отделы

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

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

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

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

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

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

Ответ

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

{
    "departments": [
        {
            "id": 1,
            "name": "Технический",
            "created_at": "2023-11-13T13:20:36.000000Z"
        },
        {
            "id": 2,
            "name": "Коммерческий",
            "created_at": "2023-11-13T13:20:36.000000Z"
        },
        {
            "id": 3,
            "name": "Конструкторский",
            "created_at": "2023-11-13T13:20:36.000000Z"
        },
        {
            "id": 4,
            "name": "СМО",
            "created_at": "2023-11-13T13:20:36.000000Z"
        },
        {
            "id": 5,
            "name": "Логистика\/склад",
            "created_at": "2023-11-13T13:20:36.000000Z"
        }
    ],
    "departmentsCount": 5
}
Описание полей ответа
  • id - первичный ключ
  • name - название отдела
  • created_at - дата и время добавления в систему

Получение выбранного отдела

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

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

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

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

https://beta.api.gigma.ru/departments/1

Ответ

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

{
    "department": {
        "id": 1,
        "name": "Технический",
        "created_at": "2023-11-13T13:20:36.000000Z"
    }
}
Описание полей ответа
  • id - первичный ключ
  • name - название отдела
  • created_at - дата и время добавления в систему

Добавление отдела

Метод: POST
URL: https://beta.api.gigma.ru/departments
Авторизация: Bearer token (permission: edit-departments)

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

  • name — название отдела.

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

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

{
    "name": "IT"
}

Ответ

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

{
    "department": {
        "id": 6,
        "name": "IT",
        "created_at": "2023-11-13T13:22:07.000000Z"
    }
}
Описание полей ответа
  • id - первичный ключ
  • name - название отдела
  • created_at - дата и время добавления в систему

Редактирование отдела

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

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

  • name — название отдела.

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

https://beta.api.gigma.ru/departments/1 

{
    "name": "IT"
}

Ответ

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

{
    "department": {
        "id": 6,
        "name": "IT",
            "created_at": "2023-11-13T13:22:07.000000Z"
    }
}

Описание полей ответа
  • id - первичный ключ
  • name - название отдела
  • created_at - дата и время добавления в систему

Удаление выбранного отдела

Метод: DELETE
URL: https://beta.api.gigma.ru/departments/{id}
Авторизация: Bearer token (permission: edit-departments)

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

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

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

https://beta.api.gigma.ru/departments/1

Ответ

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

{
    "message": "Department successfully destroyed"
}
Описание полей ответа
  • message - информационное поле

Роли пользователей

Получение списка ролей пользователей

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

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

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

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

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

Ответ

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

{
    "roles": [
        {
            "id": 1,
            "name": "owner",
            "description": "Собственник",
            "created_at": "2024-03-27T07:00:46.000000Z"
        },
        {
            "id": 2,
            "name": "admin",
            "description": "Администратор",
            "created_at": "2024-03-27T07:00:46.000000Z"
        },
        {
            "id": 3,
            "name": "manager",
            "description": "Руководитель отдела",
            "created_at": "2024-03-27T07:00:46.000000Z"
        },
        {
            "id": 4,
            "name": "employee",
            "description": "Сотрудник",
            "created_at": "2024-03-27T07:00:46.000000Z"
        }
    ],
    "rolesCount": 4
}

Описание полей ответа
  • id - первичный ключ
  • name - значение роли
  • description - описание роли (на русском языке)
  • created_at - дата и время добавления

Получение выбранной роли пользователя

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

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

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

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

https://beta.api.gigma.ru/roles/1

Ответ

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

{
    "role": {
        "id": 1,
        "name": "owner",
        "description": "Собственник",
        "created_at": "2024-03-27T07:00:46.000000Z"
    }
}

Описание полей ответа
  • id - первичный ключ
  • name - значение роли
  • description - описание роли (на русском языке)
  • created_at - дата и время добавления

Добавление роли пользователя

Метод: POST
URL: https://beta.api.gigma.ru/roles
Авторизация: Bearer token (permission: edit-roles)

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

  • name — код роли
  • description — описание роли (на русском языке)

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

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

{
    "name": "accountant",
    "description": "Бухгалтер" 
}

Ответ

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

{
    "role": {
        "id": 4,
        "name": "accountant",
        "description": "Бухгалтер",
        "created_at": "2023-11-13T13:24:23.000000Z"
    }
}

Описание полей ответа
  • id - первичный ключ
  • name - значение роли
  • description - описание роли (на русском языке)
  • created_at - дата и время добавления

Редактирование роли пользователя

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

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

  • name — код роли
  • description — описание роли (на русском языке)

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

https://beta.api.gigma.ru/roles/1 

{
    "name": "accountant",
    "description": "Бухгалтер" 
}

Ответ

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

{
    "role": {
        "id": 4,
        "name": "accountant",
        "description": "Бухгалтер",
        "created_at": "2023-11-13T13:24:23.000000Z"
    }
}

Описание полей ответа
  • id - первичный ключ
  • name - значение роли
  • description - описание роли (на русском языке)
  • created_at - дата и время добавления

Удаление выбранной роли пользователя

Метод: DELETE
URL: https://beta.api.gigma.ru/roles/1
Авторизация: Bearer token (permission: edit-roles)

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

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

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

https://beta.api.gigma.ru/roles/1

Ответ

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

{
    "message": "Role successfully deleted"
}

Описание полей ответа
  • message - информационное поле

Типы файлов

Получение списка типов файлов

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

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

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

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

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

Ответ

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

{
    "fileTypes": [
        {
            "id": 1,
            "name": "Трудовой договор",
            "created_at": "2023-11-23T11:50:48.000000Z"
        },
        {
            "id": 2,
            "name": "Аватар",
            "created_at": "2023-11-23T11:50:48.000000Z"
        },
        {
            "id": 3,
            "name": "Документ к заказу",
            "created_at": "2024-01-12T11:55:55.000000Z"
        }
    ],
    "fileTypesCount": 3
}

Описание полей ответа
  • id - первичный ключ
  • name - тип файла
  • created_at - дата и время добавления

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

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

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

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

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

https://beta.api.gigma.ru/file_types/1

Ответ

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

{
    "fileType": {
        "id": 1,
        "name": "Трудовой договор",
        "created_at": "2023-11-17T06:22:25.000000Z"
    }
}

Описание полей ответа
  • id - первичный ключ
  • name - тип файла
  • created_at - дата и время добавления

Права доступа

Получение списка прав доступа

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

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

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

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

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

Ответ

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

{
    "permissions": [
        {
            "id": 1,
            "screen": null,
            "name": "view-admins",
            "description": "Просмотр администраторов",
            "created_at": "2023-11-16T09:07:19.000000Z"
        },
        {
            "id": 2,
            "screen": null,
            "name": "edit-admins",
            "description": "Редактирование администраторов",
            "created_at": "2023-11-16T09:07:19.000000Z"
        },
        {
            "id": 3,
            "screen": null,
            "name": "view-users",
            "description": "Просмотр пользователей",
            "created_at": "2023-11-16T09:07:19.000000Z"
        },
        {
            "id": 4,
            "screen": null,
            "name": "edit-users",
            "description": "Редактирование пользователей",
            "created_at": "2023-11-16T09:07:19.000000Z"
        },
        {
            "id": 5,
            "screen": null,
            "name": "edit-roles",
            "description": "Редактирование ролей",
            "created_at": "2023-11-16T09:07:19.000000Z"
        },
        {
            "id": 6,
            "screen": null,
            "name": "edit-permissions",
            "description": "Редактирование прав доступа",
            "created_at": "2023-11-16T09:07:19.000000Z"
        },
        {
            "id": 7,
            "screen": null,
            "name": "edit-branches",
            "description": "Редактирование филиалов",
            "created_at": "2023-11-16T09:07:19.000000Z"
        },
        {
            "id": 8,
            "screen": null,
            "name": "edit-departments",
            "description": "Редактирование отделов",
            "created_at": "2023-11-16T09:07:19.000000Z"
        },
        {
            "id": 9,
            "screen": {
                "id": 1,
                "name": "контрагенты",
                "created_at": null
            },
            "name": "view-counterparties",
            "description": "Просмотр контрагентов",
            "created_at": "2023-11-16T09:07:19.000000Z"
        },
        {
            "id": 10,
            "screen": {
                "id": 1,
                "name": "контрагенты",
                "created_at": null
            },
            "name": "edit-counterparties",
            "description": "Редактирование контрагентов",
            "created_at": "2023-11-16T09:07:19.000000Z"
        },
        {
            "id": 11,
            "screen": null,
            "name": "view-communications",
            "description": "Просмотр коммуникаций",
            "created_at": "2023-11-16T09:07:19.000000Z"
        },
        {
            "id": 12,
            "screen": null,
            "name": "edit-communications",
            "description": "Редактирование коммуникаций",
            "created_at": "2023-11-16T09:07:19.000000Z"
        },
        {
            "id": 13,
            "screen": {
                "id": 2,
                "name": "Заказы",
                "created_at": null
            },
            "name": "view-orders",
            "description": "Просмотр заказов",
            "created_at": "2023-11-16T09:07:19.000000Z"
        },
        {
            "id": 14,
            "screen": {
                "id": 2,
                "name": "Заказы",
                "created_at": null
            },
            "name": "edit-orders",
            "description": "Редактирование заказов",
            "created_at": "2023-11-16T09:07:19.000000Z"
        },
        {
            "id": 15,
            "screen": {
                "id": 3,
                "name": "Задачи",
                "created_at": null
            },
            "name": "view-tasks",
            "description": "Просмотр задач",
            "created_at": "2023-11-16T09:07:19.000000Z"
        },
        {
            "id": 16,
            "screen": {
                "id": 3,
                "name": "Задачи",
                "created_at": null
            },
            "name": "edit-tasks",
            "description": "Редактирование задач",
            "created_at": "2023-11-16T09:07:19.000000Z"
        }
    ],
    "permissionsCount": 16
}

Описание полей ответа
  • id - первичный ключ
  • name - значение права доступа
  • description - описание права доступа (на русском языке)
  • created_at - дата и время добавления

Получение выбранного права доступа

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

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

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

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

https://beta.api.gigma.ru/permissions/1

Ответ

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

{
    "permission": {
        "id": 1,
        "name": "edit-roles",
        "description": "Редактирование ролей",
        "created_at": "2023-11-13T13:20:36.000000Z"
    }
}

Описание полей ответа
  • id - первичный ключ
  • name - значение права доступа
  • description - описание права доступа (на русском языке)
  • created_at - дата и время добавления

Добавление права доступа

Метод: POST
URL: https://beta.api.gigma.ru/branches
Авторизация: Bearer token (permission: edit-permissions)

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

  • name — значение права доступа
  • description — описание роли (на русском языке)

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

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

{
    "name": "edit-admins",
    "description": "Редактирование списка администраторов"
}

Ответ

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

{
    "permission": {
        "id": 13,
        "name": "edit-admins",
        "description": "Редактирование списка администраторов",
        "created_at": "2023-11-13T13:31:38.000000Z"
    }
}

Описание полей ответа
  • id - первичный ключ
  • name - значение права доступа
  • description - описание роли (на русском языке)
  • created_at - дата и время добавления

Редактирование права доступа

Метод: PUT
URL: https://beta.api.gigma.ru/permissions/1
Авторизация: Bearer token (permission: edit-permissions)

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

  • name — значение права доступа
  • description — описание роли (на русском языке)

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

https://beta.api.gigma.ru/permissions/1 

{
    "name": "edit-admins",
    "description": "Редактирование списка администраторов"
}

Ответ

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

{
    "permission": {
        "id": 13,
        "name": "edit-admins",
        "description": "Редактирование списка администраторов",
        "created_at": "2023-11-13T13:31:38.000000Z"
    }
}

Описание полей ответа
  • id - первичный ключ
  • name - значение права доступа
  • description - описание роли (на русском языке)
  • created_at - дата и время добавления

Удаление выбранного права доступа

Метод: DELETE
URL: https://beta.api.gigma.ru/permissions/1
Авторизация: Bearer token (permission: edit-permissions)

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

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

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

https://beta.api.gigma.ru/permissions/1

Ответ

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

{
    "message": "Permission successfully deleted"
}

Описание полей ответа
  • message - информационное поле

Статусы звонков

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

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

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

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

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

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

Ответ

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

{
    "callStatuses": [
        {
            "id": 1,
            "name": "Создан",
            "created_at": "2023-12-27T22:53:33.000000Z"
        },
        {
            "id": 2,
            "name": "Обработан",
            "created_at": "2023-12-27T22:53:33.000000Z"
        },
        {
            "id": 3,
            "name": "Пропущен",
            "created_at": "2023-12-27T22:53:33.000000Z"
        }
    ],
    "callStatusesCount": 3
}

Описание полей ответа
  • id - первичный ключ
  • name - статус звонка
  • created_at - дата и время добавления

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

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

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

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

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

https://beta.api.gigma.ru/call_statuses/1

Ответ

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

{
    "callStatus": {
        "id": 1,
        "name": "Создан",
        "created_at": "2023-12-27T22:53:33.000000Z"
    }
}

Описание полей ответа
  • id - первичный ключ
  • name - статус звонка
  • created_at - дата и время добавления

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

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

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

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

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

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

Ответ

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

{
    "orderStatuses": [
        {
            "id": 1,
            "name": "Расчёт",
            "created_at": "2024-01-08T05:21:59.000000Z"
        },
        {
            "id": 2,
            "name": "Коммерческое предложение",
            "created_at": "2024-01-08T05:21:59.000000Z"
        },
        {
            "id": 3,
            "name": "Счёт",
            "created_at": "2024-01-08T05:21:59.000000Z"
        },
        {
            "id": 4,
            "name": "Ожидание оплаты",
            "created_at": "2024-01-08T05:21:59.000000Z"
        },
        {
            "id": 5,
            "name": "Замер",
            "created_at": "2024-01-08T05:21:59.000000Z"
        },
        {
            "id": 6,
            "name": "Ожид. матер.",
            "created_at": "2024-01-08T05:21:59.000000Z"
        },
        {
            "id": 7,
            "name": "Производство",
            "created_at": "2024-01-08T05:21:59.000000Z"
        },
        {
            "id": 8,
            "name": "Доставка",
            "created_at": "2024-01-08T05:21:59.000000Z"
        },
        {
            "id": 9,
            "name": "Монтаж",
            "created_at": "2024-01-08T05:21:59.000000Z"
        },
        {
            "id": 10,
            "name": "Приёмка",
            "created_at": "2024-01-08T05:21:59.000000Z"
        }
    ],
    "orderStatusesCount": 10
}
Описание полей ответа
  • id - первичный ключ
  • name - статус заказа
  • created_at - дата и время добавления

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

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

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

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

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

https://beta.api.gigma.ru/order_statuses/1

Ответ

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

{
    "orderStatus": {
        "id": 1,
        "name": "Расчёт",
        "created_at": "2024-01-08T05:21:59.000000Z"
    }
}

Описание полей ответа
  • id - первичный ключ
  • name - статус заказа
  • created_at - дата и время добавления

Статусы задач

Получение списка статусов задач

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

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

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

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

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

Ответ

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

{
    "taskStatuses": [
        {
            "id": 1,
            "name": "Новая",
            "created_at": "2024-01-22T21:52:32.000000Z"
        },
        {
            "id": 2,
            "name": "В работе",
            "created_at": "2024-01-22T21:52:32.000000Z"
        },
        {
            "id": 3,
            "name": "Просрочена",
            "created_at": "2024-01-22T21:52:32.000000Z"
        },
        {
            "id": 4,
            "name": "Выполнена",
            "created_at": "2024-01-22T21:52:32.000000Z"
        }
    ],
    "taskStatusesCount": 4
}

Описание полей ответа
  • id - первичный ключ
  • name - статус задачи
  • created_at - дата и время добавления

Получение выбранного статуса задачи

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

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

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

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

https://beta.api.gigma.ru/task_statuses/1

Ответ

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

{
    "taskStatus": {
        "id": 1,
        "name": "Новая",
        "created_at": "2024-01-22T21:52:32.000000Z"
    }
}

Описание полей ответа
  • id - первичный ключ
  • name - статус задачи
  • created_at - дата и время добавления

Города

Получение списка городов

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

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

  • query - поисковая строка

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

https://beta.api.gigma.ru/cities?query=Москва

Ответ

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

{
    "cities": [
        {
            "id": 1,
            "name": "Москва",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-04-19T09:18:41.000000Z"
        },
        {
            "id": 2,
            "name": "Новосибирск",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-04-19T09:18:41.000000Z"
        },
        {
            "id": 3,
            "name": "Ростов-на-Дону",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-04-19T09:18:41.000000Z"
        }
    ],
    "citiesCount": 3
}

Описание полей ответа
  • id - первичный ключ
  • name - город
  • created_at - дата и время добавления

Получение выбранного города

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

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

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

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

https://beta.api.gigma.ru/cities/1

Ответ

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

{
    "city": {
        "id": 1,
        "name": "Москва",
        "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
        "created_at": "2024-04-19T09:18:41.000000Z"
    }
}

Описание полей ответа
  • id - первичный ключ
  • name - город
  • created_at - дата и время добавления

Страны

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

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

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

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

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

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

Ответ

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

{
    "countries": [
        {
            "id": 1,
            "name": "Россия",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-04-10T06:59:28.000000Z"
        }
    ],
    "countriesCount": 1
}

Описание полей ответа
  • id - первичный ключ
  • name - страна
  • avatar - URL-адрес фотографии
  • created_at - дата и время добавления

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

Получение списка единиц измерения

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

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

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

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

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

Ответ

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

{
    "units": [
        {
            "id": 1,
            "name": "Литр",
            "abbreviation": "л"
        },
        {
            "id": 2,
            "name": "Кубический метр",
            "abbreviation": "м³"
        },
        {
            "id": 3,
            "name": "Галлон",
            "abbreviation": "гал"
        },
        {
            "id": 4,
            "name": "Пинта",
            "abbreviation": "пт"
        },
        {
            "id": 5,
            "name": "Кварта",
            "abbreviation": "кв"
        },
        {
            "id": 6,
            "name": "Баррель",
            "abbreviation": "б"
        },
        {
            "id": 7,
            "name": "Кубический дюйм",
            "abbreviation": "in³"
        },
        {
            "id": 8,
            "name": "Кубический фут",
            "abbreviation": "ft³"
        },
        {
            "id": 9,
            "name": "Миллилитр",
            "abbreviation": "мл"
        },
        {
            "id": 10,
            "name": "Цистерна",
            "abbreviation": "цист"
        }
    ],
    "unitsCount": 10
}

Описание полей ответа
  • id - первичный ключ
  • name - полное название
  • abbreviation - аббревиатура
  • created_at - дата и время добавления

Получение выбранной единицы измерения

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

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

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

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

https://beta.api.gigma.ru/storage_units/1

Ответ

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

{
    "unit": {
        "id": 1,
        "name": "Литр",
        "abbreviation": "л"
    }
}

Описание полей ответа
  • id - первичный ключ
  • name - полное название
  • abbreviation - аббревиатура
  • created_at - дата и время добавления

Торговые марки (бренды)

Получение списка брендов

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

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

  • query - поисковая строка

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

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

Ответ

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

{
    "brands": [
        {
            "id": 45,
            "name": "COCODOR",
            "avatar": "http:\/\/localhost:8000\/\/storage\/uploads\/8M3PQIpdd3n4cQqM7cXUBILlMMTpZPyv8DdRYmAV.webp",
            "branch": {
                "id": 37,
                "title": "Торговля косметикой"
            },
            "created_at": "2024-12-11T12:28:57.000000Z"
        },
    ],
    "brandsCount": 1
}

Описание полей ответа
  • id - первичный ключ
  • name - производитель
  • avatar - URL фотограции производителя
  • branch - объект с информацией о направлении бизнеса
  • created_at - дата и время добавления

Получение выбранного бренда

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

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

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

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

https://beta.api.gigma.ru/brands/45

Ответ

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

{
    "brand": {
        "id": 45,
        "name": "COCODOR",
        "avatar": "http:\/\/localhost:8000\/\/storage\/uploads\/8M3PQIpdd3n4cQqM7cXUBILlMMTpZPyv8DdRYmAV.webp",
        "branch": {
            "id": 37,
            "title": "Торговля косметикой"
        },
        "created_at": "2024-12-11T12:28:57.000000Z"
    }
}

Описание полей ответа
  • id - первичный ключ
  • name - производитель
  • avatar - URL фотограции производителя
  • branch - объект с информацией о направлении бизнеса
  • created_at - дата и время добавления

Добавление бренда

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

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

  • name[обязательно] - название торговой марки;
  • avatar_id - ID фотографии торговой марки из справочника;
  • branch_id - ID бизнеса из справочника;

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

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

{
    "name": "TEST",
    "avatar_id": 1,
    "branch_id": 15,
}

Ответ

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

{
    "brand": {
        "id": 44,
        "name": "TEST",
        "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
        "branch": {
            "id": 15,
            "title": "Торговля косметикой"
        },
        "created_at": "2024-12-10T15:45:05.000000Z"
    }
}

Описание полей ответа
  • id - первичный ключ
  • name - производитель
  • avatar - URL фотограции производителя
  • branch - объект с информацией о направлении бизнеса
  • created_at - дата и время добавления

Обновление бренда

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

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

  • name[обязательно] - название торговой марки;
  • avatar_id - ID фотографии торговой марки из справочника;
  • branch_id - ID бизнеса из справочника;

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

https://beta.api.gigma.ru/brands/44 

{
    "name": "TEST",
    "avatar_id": 1,
    "branch_id": 14,
}

Ответ

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

{
    "brand": {
        "id": 44,
        "name": "TEST",
        "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
        "branch": {
            "id": 14,
            "title": "Торговля одеждой"
        },
        "created_at": "2024-12-10T15:45:05.000000Z"
    }
}

Описание полей ответа
  • id - первичный ключ
  • name - производитель
  • avatar - URL фотограции производителя
  • branch - объект с информацией о направлении бизнеса
  • created_at - дата и время добавления

Способы доставки

Получение списка способов доставки

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

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

  • query - поисковая строка

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

https://beta.api.gigma.ru/counterparty/delivery_types

Ответ

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

{
    "deliveryTypes": [
        {
            "id": 1,
            "name": "Самовывоз",
            "price": "0.00",
            "is_active": 1,
            "created_at": "2024-05-13T05:26:37.000000Z"
        },
        {
            "id": 2,
            "name": "Курьер",
            "price": "300.00",
            "is_active": 0,
            "created_at": "2024-05-13T05:26:37.000000Z"
        },
        {
            "id": 3,
            "name": "СДЭК",
            "price": "300.00",
            "is_active": 0,
            "created_at": "2024-05-13T05:26:37.000000Z"
        },
        {
            "id": 4,
            "name": "Почта России",
            "price": "100.00",
            "is_active": 0,
            "created_at": "2024-05-13T05:26:37.000000Z"
        }
    ],
    "deliveryTypesCount": 4
}

Описание полей ответа
  • id - первичный ключ
  • name - название способа доставки
  • price - стомость доставки (цена от)
  • is_active - флаг, указывающий на то, доступен ли данный способ доставки для оформления
  • created_at - дата и время добавления

Обратите внимание, при выборе способа доставки "Самовывоз", необходимо выполнить [[#Получение списка магазинов|дополнительный запрос]] на получение списка магазинов (пунктов выдачи).

Магазины

Получение списка магазинов (пунктов выдачи)

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

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

  • query - поисковая строка

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

https://beta.api.gigma.ru/counterparty/shops

Ответ

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

{
    "shops": [
        {
            "id": 1,
            "photo": null,
            "name": "Центральный",
            "address": "г. Донецк, ул. Ленина, 1",
            "phone": "+79851234567",
            "schedule": "ПН-ПТ, с 10:00 до 18:00"
        },
        {
            "id": 2,
            "photo": null,
            "name": "Новосибирский",
            "address": "г. Новосибирск, ул. Красный проспект, 65",
            "phone": "+79851234567",
            "schedule": "Ежедневно, с 10:00 до 18:00"
        },
        {
            "id": 3,
            "photo": null,
            "name": "Столичный",
            "address": "г. Москва, ул. Красная Площадь, 1",
            "phone": "+79851234567",
            "schedule": "Ежедневно, круглосуточно"
        }
    ],
    "shopsCount": 3
}

Описание полей ответа
  • id - первичный ключ
  • photo - строка, содержащая ссылку на URL фотографии магазина
  • address - адрес магазина
  • phone - контактный номер телефона
  • schedule - график работы магазина.

Объекты

Получение списка объектов

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

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

  • query - поисковая строка

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

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

Ответ

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

{
    "objects": [
        {
            "id": 1,
            "name": "Wildberries",
            "avatar": "http:\/\/localhost:8000\/\/storage\/uploads\/ypPdC9qVA2MZLbQ0l9nfS5LRlcMAVPiTBZhV31UY.svg",
            "created_at": "2024-07-27T18:15:28.000000Z"
        }
    ],
    "objectsCount": 1
}

Описание полей ответа
  • id - первичный ключ
  • name - название объекта
  • avatar - URL на фотографию
  • created_at - дата/время добавления в систему

Каналы продаж

Получение списка каналов продаж

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

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

  • query - поисковая строка

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

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

Ответ

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

{
    "salesChannels": [
        {
            "id": 1,
            "name": "Канал продаж 1",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-03-27T07:00:46.000000Z"
        },
        {
            "id": 2,
            "name": "Канал продаж 2",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-03-27T07:00:46.000000Z"
        },
        {
            "id": 3,
            "name": "Канал продаж 3",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-03-27T07:00:46.000000Z"
        },
        {
            "id": 4,
            "name": "Канал продаж 4",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-03-27T07:00:46.000000Z"
        },
        {
            "id": 5,
            "name": "Канал продаж 5",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-03-27T07:00:46.000000Z"
        }
    ],
    "salesChannelsCount": 5
}

Описание полей ответа
  • id - первичный ключ
  • name - название канала продаж
  • avatar - URL на фотографию
  • created_at - дата/время добавления в систему

НДС

Получение списка НДС

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

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

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

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

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

Ответ

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

{
    "vats": [
        {
            "id": 1,
            "name": "Без НДС",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-08-12T08:51:40.000000Z"
        },
        {
            "id": 2,
            "name": "10%",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-08-12T08:51:40.000000Z"
        },
        {
            "id": 3,
            "name": "20%",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-08-12T08:51:40.000000Z"
        }
    ],
    "vatsCount": 3
}

Описание полей ответа
  • id - первичный ключ
  • name - название НДС
  • avatar - URL на фотографию
  • created_at - дата/время добавления в систему

Получение выбранного значения НДС

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

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

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

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

https://beta.api.gigma.ru/vats/1

Ответ

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

{
    "vat": {
        "id": 1,
        "name": "Без НДС",
        "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
        "created_at": "2024-08-12T08:51:40.000000Z"
    }
}

Описание полей ответа
  • id - первичный ключ
  • name - название НДС
  • avatar - URL на фотографию
  • created_at - дата/время добавления в систему

Типы страниц

Получение списка типов страниц

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

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

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

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

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

Ответ

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

{
    "pageTypes": [
        {
            "id": 1,
            "name": "Страница",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-10-31T11:14:22.000000Z"
        },
        {
            "id": 2,
            "name": "Блок",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-10-31T11:14:22.000000Z"
        },
        {
            "id": 3,
            "name": "Новость",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-10-31T11:14:22.000000Z"
        }
    ],
    "pageTypesCount": 3
}

Описание полей ответа
  • id - первичный ключ
  • name - тип страницы
  • avatar - URL аватара
  • created_at - дата и время добавления

Получение выбранного типа страницы

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

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

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

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

https://beta.api.gigma.ru/page_types/1

Ответ

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

{
    "pageType": {
        "id": 1,
        "name": "Страница",
        "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
        "created_at": "2024-10-31T11:14:22.000000Z"
    }
}

Описание полей ответа
  • id - первичный ключ
  • name - тип страницы
  • avatar - URL аватара
  • created_at - дата и время добавления

Типы блоков

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

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

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

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

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

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

Ответ

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

{
    "blockTypes": [
        {
            "id": 1,
            "name": "Обычный текст",
            "avatar": "https:\/\/beta.api.gigma.ru\/\/storage\/uploads\/image-profile-1.svg",
            "created_at": "2025-01-23T09:47:38.000000Z"
        },
        {
            "id": 2,
            "name": "Длинный текст",
            "avatar": "https:\/\/beta.api.gigma.ru\/\/storage\/uploads\/image-profile-1.svg",
            "created_at": "2025-01-23T09:47:38.000000Z"
        },
        {
            "id": 3,
            "name": "Картинка",
            "avatar": "https:\/\/beta.api.gigma.ru\/\/storage\/uploads\/image-profile-2.svg",
            "created_at": "2025-01-23T09:47:38.000000Z"
        },
        {
            "id": 4,
            "name": "Видео",
            "avatar": "https:\/\/beta.api.gigma.ru\/\/storage\/uploads\/image-profile-3.svg",
            "created_at": "2025-01-23T09:47:38.000000Z"
        },
        {
            "id": 5,
            "name": "URL ссылка",
            "avatar": "https:\/\/beta.api.gigma.ru\/\/storage\/uploads\/image-profile-4.svg",
            "created_at": "2025-01-23T09:47:38.000000Z"
        }
    ],
    "blockTypesCount": 5
}

Описание полей ответа
  • id - первичный ключ
  • name - тип блока
  • avatar - URL аватара
  • created_at - дата и время добавления

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

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

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

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

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

https://beta.api.gigma.ru/block_types/1

Ответ

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

{
    "blockType": {
        "id": 1,
        "name": "Обычный текст",
        "avatar": "https:\/\/beta.api.gigma.ru\/\/storage\/uploads\/image-profile-1.svg",
        "created_at": "2025-01-23T09:47:38.000000Z"
    }
}

Описание полей ответа
  • id - первичный ключ
  • name - тип блока
  • avatar - URL аватара
  • created_at - дата и время добавления