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

Склады

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

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

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

  • owned_by_us - иерархия (принадлежность) склада: свой (true), чужой (false)
  • type_id[] - массив ID типов хранимых товаров из справочника
  • city_id[] - массив ID городов из справочника
  • page - текущая страница (для пагинации)
  • per_page - кол-во элементов на странице
  • query - поисковая строка
  • date_from - "дата с..." (от даты добавления в систему)
  • date_to - "дата по..." (от даты добавления в систему)

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

https://beta.api.gigma.ru/tables/warehouses?query=коледино&owned_by_us=0&storage_unit_id[]=1&city_id[]=1

Ответ

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

{
    "columns": [
        {
            "id": 81,
            "table_id": 11,
            "order": 0,
            "key": "id",
            "has_icon": 0,
            "text": "№"
        },
        {
            "id": 82,
            "table_id": 11,
            "order": 1,
            "key": "name",
            "has_icon": 1,
            "text": "Название"
        },
        {
            "id": 83,
            "table_id": 11,
            "order": 2,
            "key": "owner",
            "has_icon": 0,
            "text": "Принадлежность"
        },
        {
            "id": 84,
            "table_id": 11,
            "order": 3,
            "key": "city",
            "has_icon": 0,
            "text": "Город"
        },
        {
            "id": 85,
            "table_id": 11,
            "order": 4,
            "key": "creator",
            "has_icon": 1,
            "text": "Добавил"
        },
        {
            "id": 86,
            "table_id": 11,
            "order": 5,
            "key": "storage_capacity",
            "has_icon": 0,
            "text": "Емкость"
        }
    ],
    "warehouses": [
        {
            "id": 3,
            "name": {
                "icon": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "value": "Коледино WB"
            },
            "owner": "Чужой",
            "city": "Москва",
            "creator": {
                "icon": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "value": "Полищук Артём"
            },
            "storage_capacity": 5000000,
            "storage_unit": "Литр"
        }
    ],
    "pagination": {
        "total": 1,
        "per_page": 10,
        "current_page": 1,
        "last_page": 1,
        "from": 1,
        "to": 1
    }
}

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

  • id - первичный ключ (номер склада)
  • name - название склада
  • owner - принадлежность склада (свой/чужой)
  • city - город
  • creator - добавил в систему
  • storage_capacity - объем склада
  • storage_unit - единицы измерения

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

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

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

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

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

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

Ответ

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

{
    "warehouse": {
        "id": 1,
        "name": "Подольск",
        "photo": null,
        "code": 1,
        "owned_by_us": false,
        "address": "Троицкая улица, 20, деревня Коледино, городской округ Подольск, Московская область",
        "storage_capacity": 5000000,
        "storage_unit": {
            "id": 1,
            "name": "Литр",
            "abbreviation": "л"
        },
        "city": {
            "id": 1,
            "name": "Москва",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-04-19T09:18:41.000000Z"
        },
        "counterparty": {
            "id": 54,
            "type": {
                "id": 2,
                "name": "Поставщик",
                "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            "manager": {
                "id": 1,
                "first_name": "Артём",
                "last_name": "Полищук",
                "middle_name": "Николаевич",
                "name": "Полищук Артём"
            },
            "avatar": null,
            "name": "ООО \"НЕТФЛИКС\"",
            "registered_at": "2008-10-20",
            "inn": "7743277284",
            "kpp": null,
            "head": "Чуйков Андрей Николаевич",
            "legal_address": "г Москва, ул Адмирала Макарова, д 8 стр 1, помещ V ком 15, 15",
            "phone_1": "71231412412",
            "phone_2": "74416763277",
            "email": "asdaslow@gmail.com",
            "created_at": "2024-06-11T15:00:33.000000Z",
            "updated_at": "2024-06-11T19:33:38.000000Z"
        }
    }
}

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

  • id - первичный ключ (номер склада)
  • photo - объект с информацией о фотографии склада. Для получения информации о возвращаемых полях см. запрос
  • code - уникальный код склада
  • owned_by_us - принадлежность склада (свой/чужой)
  • address - адрес склада
  • city - объект с информацией о городе из справочника
  • creator - объект с информацией о создателе записи. Для получения информации о возвращаемых полях см. запрос
  • storage_capacity - объем склада
  • storage_unit - объект с информацией о единицах измерения. Для получения информации о возвращаемых полях см. запрос

Добавление склада

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

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

  • photo_id - ID фотографии склада из справочника
  • name - название склада
  • code - уникальный код склада
  • owned_by_us - принадлежность склада (свой/чужой)
  • address - адрес склада, полученный из запроса
  • city_id - ID города из справочника
  • storage_capacity - объем склада (целочисленное значение)
  • storage_unit_id - ID единиц измерения из справочника
  • counterparty_id - ID поставщика из списка контрагентов

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

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

{
    "photo_id": 1,
    "code": 1,
    "name": "Коледино WB",
    "owned_by_us": false,
    "address": "Троицкая улица, 20, деревня Коледино, городской округ Подольск, Московская область",
    "storage_capacity": 5000000,
    "storage_unit_id": 1,
    "city_id": 1,
    "counterparty_id": 54
}

Ответ

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

{
    "warehouse": {
        "id": 5,
        "name": "Подольск",
        "photo": null,
        "code": 1,
        "owned_by_us": false,
        "address": "Троицкая улица, 20, деревня Коледино, городской округ Подольск, Московская область",
        "storage_capacity": 5000000,
        "storage_unit": {
            "id": 1,
            "name": "Литр",
            "abbreviation": "л"
        },
        "city": {
            "id": 1,
            "name": "Москва",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-04-19T09:18:41.000000Z"
        },
        "counterparty": {
            "id": 54,
            "type": {
                "id": 2,
                "name": "Поставщик",
                "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            "manager": {
                "id": 1,
                "first_name": "Артём",
                "last_name": "Полищук",
                "middle_name": "Николаевич",
                "name": "Полищук Артём"
            },
            "avatar": null,
            "name": "ООО \"НЕТФЛИКС\"",
            "registered_at": "2008-10-20",
            "inn": "7743277284",
            "kpp": null,
            "head": "Чуйков Андрей Николаевич",
            "legal_address": "г Москва, ул Адмирала Макарова, д 8 стр 1, помещ V ком 15, 15",
            "phone_1": "71231412412",
            "phone_2": "74416763277",
            "email": "asdaslow@gmail.com",
            "created_at": "2024-06-11T15:00:33.000000Z",
            "updated_at": "2024-06-11T19:33:38.000000Z"
        }
    }
}

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

Возвращаемые поля аналогичны запросу.

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

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

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

  • photo_id - ID фотографии склада из справочника
  • name - название склада
  • code - уникальный код склада
  • owned_by_us - принадлежность склада (свой/чужой)
  • address - адрес склада, полученный из запроса
  • city_id - ID города из справочника
  • storage_capacity - объем склада (целочисленное значение)
  • storage_unit_id - ID единиц измерения из справочника
  • counterparty_id - ID поставщика из списка контрагентов. Использовать counterparty_type_id с ID = 2 (Поставщик)

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

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

{
    "photo_id": 1,
    "code": 1,
    "name": "Коледино WB",
    "owned_by_us": false,
    "address": "Троицкая улица, 20, деревня Коледино, городской округ Подольск, Московская область",
    "storage_capacity": 5000000,
    "storage_unit_id": 1,
    "city_id": 1,
    "counterparty_id": 54
}

Ответ

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

{
    "warehouse": {
        "id": 5,
        "name": "Коледино WB",
        "photo": null,
        "code": 1,
        "owned_by_us": false,
        "address": "Троицкая улица, 20, деревня Коледино, городской округ Подольск, Московская область",
        "storage_capacity": 5000000,
        "storage_unit": {
            "id": 1,
            "name": "Литр",
            "abbreviation": "л"
        },
        "city": {
            "id": 1,
            "name": "Москва",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-04-19T09:18:41.000000Z"
        },
        "counterparty": {
            "id": 54,
            "type": {
                "id": 2,
                "name": "Поставщик",
                "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            "manager": {
                "id": 1,
                "first_name": "Артём",
                "last_name": "Полищук",
                "middle_name": "Николаевич",
                "name": "Полищук Артём"
            },
            "avatar": null,
            "name": "ООО \"НЕТФЛИКС\"",
            "registered_at": "2008-10-20",
            "inn": "7743277284",
            "kpp": null,
            "head": "Чуйков Андрей Николаевич",
            "legal_address": "г Москва, ул Адмирала Макарова, д 8 стр 1, помещ V ком 15, 15",
            "phone_1": "71231412412",
            "phone_2": "74416763277",
            "email": "asdaslow@gmail.com",
            "created_at": "2024-06-11T15:00:33.000000Z",
            "updated_at": "2024-06-11T19:33:38.000000Z"
        }
    }
}

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

Возвращаемые поля аналогичны запросу.

Удаление склада

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

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

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

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

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

Ответ

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

{
    "message": "Warehouse deleted."
}

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

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

Интеграции

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

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

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

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

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

https://beta.api.gigma.ru/warehouses/7/integrations

Ответ

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

{
    "integrations": [
        {
            "id": 1,
            "integration_id": 10,
            "name": "Wildberries",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "is_active": 0
        },
        {
            "id": 2,
            "integration_id": 11,
            "name": "Ozon",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "is_active": 0
        },
        {
            "id": 3,
            "integration_id": 12,
            "name": "Яндекс Маркет",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "is_active": 0
        },
        {
            "id": 4,
            "integration_id": 13,
            "name": "Купер",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "is_active": 0
        }
    ],
    "integrationsCount": 4
}

Описание полей ответа
  • id - первичный ключ
  • integration_id - ID интеграции из справочника
  • name - название интеграции
  • avatar - URL-адрес фотографии
  • is_active - статус (false - неактивна; true - активна)

Обновление статуса выбранной интеграции

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

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

  • is_active - булевый флаг, означающий текущий статус интеграции

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

https://beta.api.gigma.ru/warehouses/7/integrations/1 

{
    "is_active": 1
}

Ответ

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

{
    "integration": {
        "id": 1,
        "integration_id": 10,
        "name": "Wildberries",
        "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
        "is_active": 1
    }
}
Описание полей ответа

Возвращаемые поля аналогичны ответу.

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

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

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

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

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

https://beta.api.gigma.ru/warehouses/7/integrations/1/parameters

Ответ

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

{
    "parameters": [
        {
            "id": 2,
            "key_1": "login",
            "description_1": "Логин\/ID",
            "key_2": "password",
            "description_2": "Пароль",
            "value_1": "dsfsdfdsf",
            "value_2": "sdfdsfsd"
        }
    ],
    "parametersCount": 1
}

Описание полей ответа
  • id - первичный ключ
  • key_1 - ключ 1
  • description_1 - описание 1
  • key_2 - ключ 2
  • description_2 - описание 2
  • value_1 - значение 1
  • value_2 - значение 2

Добавление параметров для выбранной интеграции

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

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

  • integration_parameter_id - ID параметра интеграции из запроса;
  • value_1 - значение 1;
  • value_2 - значение 2;

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

https://beta.api.gigma.ru/warehouses/7/integrations/1/parameters 

{
    "integration_parameter_id": 10,
    "value_1": "83432434234",
    "value_2": "sdfdsxcvxcvfsd"
}

Ответ

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

{
    "parameter": {
        "id": 2,
        "key_1": "login",
        "description_1": "Логин\/ID",
        "key_2": "password",
        "description_2": "Пароль",
        "value_1": "dsfsdfdsf",
        "value_2": "sdfdsfsd"
    }
}

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

Возвращаемые поля аналогичны ответу.

Удаление параметров из выбранной интеграции

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

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

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

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

https://beta.api.gigma.ru/warehouses/7/integrations/1/parameters/1

Ответ

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

{
    "message": "Parameter successfully deleted."
}

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

Получение истории изменений

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

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

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

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

https://beta.api.gigma.ru/warehouses/7/history

Ответ

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

{
    "histories": [
        {
            "id": 283,
            "icon": "check",
            "color": "primary",
            "title": "Создание",
            "description": "Создание: Полищук Артём",
            "datetime": "15.07.2024 05:46"
        },
        {
            "id": 284,
            "icon": "edit",
            "color": "success",
            "title": "Редактирование",
            "description": "Редактирование: Полищук Артём",
            "datetime": "15.07.2024 07:06"
        }
    ],
    "historiesCount": 2
}

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