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

Магазины

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

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

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

  • query - поисковая строка
  • city_id - ID города из справочника
  • branch_id - ID бизнеса из справочника
  • is_shop - флаг, указывающий на то, является ли значение магазином (true) или пунктом выдачи (false)

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

https://beta.api.gigma.ru/tables/shops?query=Сей

Ответ

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

{
    "columns": [
        {
            "id": 124,
            "table_id": 16,
            "order": 0,
            "key": "id",
            "has_icon": 0,
            "text": "№"
        },
        {
            "id": 125,
            "table_id": 16,
            "order": 1,
            "key": "name",
            "has_icon": 1,
            "text": "Название"
        },
        {
            "id": 126,
            "table_id": 16,
            "order": 2,
            "key": "branch",
            "has_icon": 1,
            "text": "Направление бизнеса"
        },
        {
            "id": 127,
            "table_id": 16,
            "order": 3,
            "key": "city",
            "has_icon": 0,
            "text": "Город"
        },
        {
            "id": 128,
            "table_id": 16,
            "order": 4,
            "key": "address",
            "has_icon": 0,
            "text": "Адрес"
        },
        {
            "id": 129,
            "table_id": 16,
            "order": 5,
            "key": "creator",
            "has_icon": 1,
            "text": "Добавил"
        },
        {
            "id": 130,
            "table_id": 16,
            "order": 6,
            "key": "schedule",
            "has_icon": 0,
            "text": "График работы"
        }
    ],
    "shops": [
        {
            "id": 17,
            "name": {
                "icon": "http:\/\/localhost:8000\/\/storage\/uploads\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
                "value": "Сей Момент"
            },
            "branch": {
                "icon": "http:\/\/localhost:8000\/\/storage\/uploads\/b9t9B4Y4Fq6dAKvgVW2vhzFJ12ZrgRgvVHdMnfjt.png",
                "value": "ИП Дерюгин Дмитрий Александрович"
            },
            "city": {
                "id": 1,
                "name": "Москва",
                "created_at": "2024-04-19T09:18:41.000000Z"
            },
            "address": "115477, г Москва, р-н Царицыно, ул Деловая, д 20",
            "creator": {
                "icon": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "value": "Полищук Артём"
            },
            "schedule": "Ежедневно, с 10:00 до 18:00"
        },
        {
            "id": 1,
            "name": {
                "icon": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "value": "Центральный"
            },
            "branch": null,
            "city": {
                "id": 1,
                "name": "Москва",
                "created_at": "2024-04-19T09:18:41.000000Z"
            },
            "address": "г. Донецк, ул. Ленина, 1",
            "creator": {
                "icon": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "value": "Полищук Артём"
            },
            "schedule": "ПН-ПТ, с 10:00 до 18:00"
        },
        {
            "id": 2,
            "name": {
                "icon": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "value": "Новосибирский"
            },
            "branch": null,
            "city": {
                "id": 2,
                "name": "Новосибирск",
                "created_at": "2024-04-19T09:18:41.000000Z"
            },
            "address": "г. Новосибирск, ул. Красный проспект, 65",
            "creator": {
                "icon": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "value": "Полищук Артём"
            },
            "schedule": "Ежедневно, с 10:00 до 18:00"
        },
        {
            "id": 3,
            "name": {
                "icon": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "value": "Столичный"
            },
            "branch": null,
            "city": {
                "id": 3,
                "name": "Ростов-на-Дону",
                "created_at": "2024-04-19T09:18:41.000000Z"
            },
            "address": "г. Москва, ул. Красная Площадь, 1",
            "creator": {
                "icon": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "value": "Полищук Артём"
            },
            "schedule": "Ежедневно, круглосуточно"
        }
    ],
    "pagination": {
        "total": 4,
        "per_page": 10,
        "current_page": 1,
        "last_page": 1,
        "from": 1,
        "to": 4
    }
}

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

  • columns - объект, содержащий информацию для генерации таблиц
  • id - первичный ключ
  • name - объект с информацией названии магазина
  • branch - объект с информацией о бизнеса (первый из массива)
  • city - город, в котором расположен магазин
  • address - полный адрес магазина
  • creator - объект, содержащий информацию о пользователе, который добавил запись в БД
  • schedule - график работы магазина
  • per_page - кол-во элементов на странице
  • prev_page_url - URL предыдущей страницы
  • from - номер первого элемента на выбранной странице
  • to - номер крайнего элемента на выбранной странице
  • total - общее кол-во записей

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

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

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

  • query - поисковая строка
  • city_id - ID города из справочника
  • branch_id - ID бизнеса из справочника
  • is_shop - флаг, указывающий на то, является ли значение магазином (true) или пунктом выдачи (false)

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

https://beta.api.gigma.ru/shops?query=Сей

Ответ

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

{
    "shops": [
        {
            "id": 3,
            "photo": {
                "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",
                "created_at": "2024-04-18T13:37:45.000000Z",
                "updated_at": "2024-04-18T13:37:45.000000Z"
            },
            "name": "Столичный",
            "address": "г. Москва, ул. Красная Площадь, 1",
            "phone": "+79851234567",
            "schedule": "Ежедневно, круглосуточно"
        }
    ],
    "shopsCount": 1
}

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

  • id - первичный ключ
  • photo - объект с информацией о фотографии магазина
  • name - название магазина
  • address - полный адрес магазина
  • schedule - график работы магазина

Добавление магазина

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

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

  • avatar_id - ID файла после его загрузки на сервер при помощи [[#Добавление файла|запроса]]
  • code - уникальный код магазина
  • name - название магазина
  • address - адрес магазина, полученный из Dadata
  • branches[] - массив ID бизнесов из запроса
  • warehouses[] - массив ID складов из запроса
  • phone - номер телефона

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

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

{
    "avatar_id": 1,
    "is_shop": true,
    "code": "10",
    "name": "Сей Момент",
    "address": "115477, г Москва, р-н Царицыно, ул Деловая, д 20",
    "branches": [
        15
    ],
    "warehouses": [
        1,
        2,
        3
    ],
    "phone": "79999999999",
}

Ответ

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

{
    "shop": {
        "id": 4,
        "is_shop": true,
        "avatar": {
            "id": 1,
            "name": "logo.svg",
            "type": {
                "id": 1,
                "name": "Трудовой договор",
                "avatar": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/default.svg",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            "path": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
            "created_at": "2024-04-14T20:04:32.000000Z",
            "updated_at": "2024-04-14T20:04:32.000000Z"
        },
        "code": "10",
        "name": "Сей Момент",
        "branches": [
            {
                "id": 15,
                "code": "1",
                "name": "ИП Дерюгин Дмитрий Александрович",
                "photo": null,
                "owned_by_us": false,
                "address": "283045, Донецкая Народная респ, г Донецк, ул Профессоров Богославских, д 5а",
                "storage_capacity": null,
                "storage_unit": null,
                "city": null,
                "counterparty": null
            }
        ],
        "warehouses": [
            {
                "id": 1,
                "code": null,
                "name": "Петухова",
                "photo": null,
                "owned_by_us": true,
                "address": "Петухова 155\/1 к4",
                "storage_capacity": 100000,
                "storage_unit": {
                    "id": 2,
                    "name": "Кубический метр",
                    "abbreviation": "м³"
                },
                "city": {
                    "id": 2,
                    "name": "Новосибирск",
                    "avatar": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/default.svg",
                    "created_at": "2024-04-19T09:18:41.000000Z"
                },
                "counterparty": null
            },
            {
                "id": 2,
                "code": null,
                "name": "Ленина",
                "photo": null,
                "owned_by_us": true,
                "address": "Ленина 25",
                "storage_capacity": 100000,
                "storage_unit": {
                    "id": 2,
                    "name": "Кубический метр",
                    "abbreviation": "м³"
                },
                "city": {
                    "id": 2,
                    "name": "Новосибирск",
                    "avatar": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/default.svg",
                    "created_at": "2024-04-19T09:18:41.000000Z"
                },
                "counterparty": null
            },
            {
                "id": 3,
                "code": null,
                "name": "Коледино WB",
                "photo": null,
                "owned_by_us": false,
                "address": "Троицкая улица, 20, деревня Коледино, городской округ Подольск, Московская область",
                "storage_capacity": 5000000,
                "storage_unit": {
                    "id": 1,
                    "name": "Литр",
                    "abbreviation": "л"
                },
                "city": {
                    "id": 1,
                    "name": "Москва",
                    "avatar": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/default.svg",
                    "created_at": "2024-04-19T09:18:41.000000Z"
                },
                "counterparty": null
            }
        ],
        "address": "115477, г Москва, р-н Царицыно, ул Деловая, д 20",
        "phone": "79999999999"
    }
}

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

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

Обновление выбранного магазина

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

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

  • avatar_id - ID файла после его загрузки на сервер при помощи [[#Добавление файла|запроса]]
  • code - уникальный код магазина
  • name - название магазина
  • address - адрес магазина, полученный из Dadata
  • branches[] - массив ID бизнесов из запроса
  • warehouses[] - массив ID складов из запроса
  • phone - номер телефона

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

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

{
    "avatar_id": 1,
    "is_shop": true,
    "code": "10",
    "name": "Сей Момент",
    "address": "115477, г Москва, р-н Царицыно, ул Деловая, д 20",
    "branches": [
        15
    ],
    "warehouses": [
        1,
        2,
        3
    ],
    "phone": "79999999999",
}

Ответ

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

{
    "shop": {
        "id": 4,
        "is_shop": true,
        "avatar": {
            "id": 1,
            "name": "logo.svg",
            "type": {
                "id": 1,
                "name": "Трудовой договор",
                "avatar": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/default.svg",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            "path": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
            "created_at": "2024-04-14T20:04:32.000000Z",
            "updated_at": "2024-04-14T20:04:32.000000Z"
        },
        "code": "10",
        "name": "Сей Момент",
        "branches": [
            {
                "id": 15,
                "code": "1",
                "name": "ИП Дерюгин Дмитрий Александрович",
                "photo": null,
                "owned_by_us": false,
                "address": "283045, Донецкая Народная респ, г Донецк, ул Профессоров Богославских, д 5а",
                "storage_capacity": null,
                "storage_unit": null,
                "city": null,
                "counterparty": null
            }
        ],
        "warehouses": [
            {
                "id": 1,
                "code": null,
                "name": "Петухова",
                "photo": null,
                "owned_by_us": true,
                "address": "Петухова 155\/1 к4",
                "storage_capacity": 100000,
                "storage_unit": {
                    "id": 2,
                    "name": "Кубический метр",
                    "abbreviation": "м³"
                },
                "city": {
                    "id": 2,
                    "name": "Новосибирск",
                    "avatar": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/default.svg",
                    "created_at": "2024-04-19T09:18:41.000000Z"
                },
                "counterparty": null
            },
            {
                "id": 2,
                "code": null,
                "name": "Ленина",
                "photo": null,
                "owned_by_us": true,
                "address": "Ленина 25",
                "storage_capacity": 100000,
                "storage_unit": {
                    "id": 2,
                    "name": "Кубический метр",
                    "abbreviation": "м³"
                },
                "city": {
                    "id": 2,
                    "name": "Новосибирск",
                    "avatar": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/default.svg",
                    "created_at": "2024-04-19T09:18:41.000000Z"
                },
                "counterparty": null
            },
            {
                "id": 3,
                "code": null,
                "name": "Коледино WB",
                "photo": null,
                "owned_by_us": false,
                "address": "Троицкая улица, 20, деревня Коледино, городской округ Подольск, Московская область",
                "storage_capacity": 5000000,
                "storage_unit": {
                    "id": 1,
                    "name": "Литр",
                    "abbreviation": "л"
                },
                "city": {
                    "id": 1,
                    "name": "Москва",
                    "avatar": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/default.svg",
                    "created_at": "2024-04-19T09:18:41.000000Z"
                },
                "counterparty": null
            }
        ],
        "address": "115477, г Москва, р-н Царицыно, ул Деловая, д 20",
        "phone": "79999999999"
    }
}

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

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

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

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

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

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

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

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

Ответ

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

{
    "shop": {
        "id": 4,
        "is_shop": true,
        "avatar": {
            "id": 1,
            "name": "logo.svg",
            "type": {
                "id": 1,
                "name": "Трудовой договор",
                "avatar": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/default.svg",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            "path": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
            "created_at": "2024-04-14T20:04:32.000000Z",
            "updated_at": "2024-04-14T20:04:32.000000Z"
        },
        "code": "10",
        "name": "Сей Момент",
        "branches": [
            {
                "id": 15,
                "code": "1",
                "name": "ИП Дерюгин Дмитрий Александрович",
                "photo": null,
                "owned_by_us": false,
                "address": "283045, Донецкая Народная респ, г Донецк, ул Профессоров Богославских, д 5а",
                "storage_capacity": null,
                "storage_unit": null,
                "city": null,
                "counterparty": null
            }
        ],
        "warehouses": [
            {
                "id": 1,
                "code": null,
                "name": "Петухова",
                "photo": null,
                "owned_by_us": true,
                "address": "Петухова 155\/1 к4",
                "storage_capacity": 100000,
                "storage_unit": {
                    "id": 2,
                    "name": "Кубический метр",
                    "abbreviation": "м³"
                },
                "city": {
                    "id": 2,
                    "name": "Новосибирск",
                    "avatar": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/default.svg",
                    "created_at": "2024-04-19T09:18:41.000000Z"
                },
                "counterparty": null
            },
            {
                "id": 2,
                "code": null,
                "name": "Ленина",
                "photo": null,
                "owned_by_us": true,
                "address": "Ленина 25",
                "storage_capacity": 100000,
                "storage_unit": {
                    "id": 2,
                    "name": "Кубический метр",
                    "abbreviation": "м³"
                },
                "city": {
                    "id": 2,
                    "name": "Новосибирск",
                    "avatar": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/default.svg",
                    "created_at": "2024-04-19T09:18:41.000000Z"
                },
                "counterparty": null
            },
            {
                "id": 3,
                "code": null,
                "name": "Коледино WB",
                "photo": null,
                "owned_by_us": false,
                "address": "Троицкая улица, 20, деревня Коледино, городской округ Подольск, Московская область",
                "storage_capacity": 5000000,
                "storage_unit": {
                    "id": 1,
                    "name": "Литр",
                    "abbreviation": "л"
                },
                "city": {
                    "id": 1,
                    "name": "Москва",
                    "avatar": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/default.svg",
                    "created_at": "2024-04-19T09:18:41.000000Z"
                },
                "counterparty": null
            }
        ],
        "address": "115477, г Москва, р-н Царицыно, ул Деловая, д 20",
        "phone": "79999999999",
        "schedule": "Ежедневно, с 10:00 до 18:00"
    }
}

Описание полей ответа
  • id - первичный ключ;
  • code - уникальный код магазина;
  • name - название магазина;
  • is_shop - флаг, указывающий на то, является ли значение магазином (true) или пунктом выдачи (false);
  • avatar - объект с информацией о загруженном файле. Для получения детальной информации о возвращаемых полях см. запрос;
  • branches - массив объектов с информацией о бизнесе. Для получения информации о возвращаемых полях см. запрос;
  • warehouses - массив объектов с информацией о складе. Для получения информации о возвращаемых полях см. запрос;
  • address - адрес магазина;
  • phone - номер телефона магазина;
  • schedule - график работы.

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

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

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

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

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

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

Ответ

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

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

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

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

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

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

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

https://beta.api.gigma.ru/shops/4/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 - дата выполнения действия

Режим работы

Будние/выходные дни

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

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

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

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

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

https://beta.api.gigma.ru/shops/17/hours

Ответ

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

{
    "hours": [
        {
            "id": 1,
            "day_of_week": "ПН",
            "is_working_day": true,
            "work_start_time": "09:00:00",
            "work_end_time": "18:00:00",
            "break_start_time": null,
            "break_end_time": null
        }
    ],
    "hoursCount": 1
}

Описание полей ответа
  • id - первичный ключ;
  • day_of_week - день недели;
  • is_working_day - флаг, указывающий на то, является ли день рабочим (true) или выходным (false);
  • work_start_time - время начала рабочего дня;
  • work_end_time - время завершения рабочего дня;
  • break_start_time - время начала перерыва;
  • break_end_time - время окончания перерыва;

Добавление дней и часов работы выбранного магазина

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

Параметры запроса
  • day_of_week - день недели. Доступные значения: ПН,ВТ,СР,ЧТ,ПТ,СБ,ВС;
  • is_working_day - флаг, указывающий на то, является ли день рабочим (true) или выходным (false);
  • work_start_time - время начала рабочего дня;
  • work_end_time - время завершения рабочего дня;
  • break_start_time - время начала перерыва;
  • break_end_time - время окончания перерыва;
Пример запроса

https://beta.api.gigma.ru/shops/17/hours 

{
    "day_of_week": "ПН",
    "is_working_day": true,
    "work_start_time": "09:00",
    "work_end_time": "18:00",
    "break_start_time": "13:00",
    "break_end_time": "14:00"
}

Ответ

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

{
    "hour": {
        "id": 4,
        "day_of_week": "ПН",
        "is_working_day": true,
        "work_start_time": "09:00",
        "work_end_time": "18:00",
        "break_start_time": "13:00",
        "break_end_time": "14:00"
    }
}

Описание полей ответа
  • id - первичный ключ;
  • day_of_week - день недели;
  • is_working_day - флаг, указывающий на то, является ли день рабочим (true) или выходным (false);
  • work_start_time - время начала рабочего дня;
  • work_end_time - время завершения рабочего дня;
  • break_start_time - время начала перерыва;
  • break_end_time - время окончания перерыва;

Обновление дней и часов работы выбранного магазина

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

Параметры запроса
  • day_of_week - день недели. Доступные значения: ПН,ВТ,СР,ЧТ,ПТ,СБ,ВС;
  • is_working_day - флаг, указывающий на то, является ли день рабочим (true) или выходным (false);
  • work_start_time - время начала рабочего дня;
  • work_end_time - время завершения рабочего дня;
  • break_start_time - время начала перерыва;
  • break_end_time - время окончания перерыва;
Пример запроса

https://beta.api.gigma.ru/shops/17/hours/1 

{
    "day_of_week": "ПН",
    "is_working_day": true,
    "work_start_time": "09:00",
    "work_end_time": "18:00",
    "break_start_time": null,
    "break_end_time": null
}

Ответ

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

{
    "hour": {
        "id": 4,
        "day_of_week": "ПН",
        "is_working_day": true,
        "work_start_time": "09:00",
        "work_end_time": "18:00",
        "break_start_time": null,
        "break_end_time": null
    }
}

Описание полей ответа
  • id - первичный ключ;
  • day_of_week - день недели;
  • is_working_day - флаг, указывающий на то, является ли день рабочим (true) или выходным (false);
  • work_start_time - время начала рабочего дня;
  • work_end_time - время завершения рабочего дня;
  • break_start_time - время начала перерыва;
  • break_end_time - время окончания перерыва;

Удаление выбранных дней и часов работы магазина

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

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

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

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

https://beta.api.gigma.ru/shops/17/hours/1

Ответ

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

{
    "message": "Shop hour deleted successfully."
}

Праздничные дни

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

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

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

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

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

https://beta.api.gigma.ru/shops/17/holidays

Ответ

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

{
    "holidays": {
        "work_start_time": "09:00:00",
        "work_end_time": "18:00:00",
        "break_start_time": null,
        "break_end_time": null
    }
}

Описание полей ответа
  • work_start_time - время начала рабочего дня;
  • work_end_time - время завершения рабочего дня;
  • break_start_time - время начала перерыва;
  • break_end_time - время окончания перерыва;

Обновление графика работы в праздничные дни выбранного магазина

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

Параметры запроса
  • work_start_time - время начала рабочего дня;
  • work_end_time - время завершения рабочего дня;
  • break_start_time - время начала перерыва;
  • break_end_time - время окончания перерыва;
Пример запроса

https://beta.api.gigma.ru/shops/17/holidays 

{
    "work_start_time": "09:00",
    "work_end_time": "18:00",
    "break_start_time": "12:00",
    "break_end_time": "13:00"
}

Ответ

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

{
    "holidays": {
        "work_start_time": "09:00",
        "work_end_time": "18:00",
        "break_start_time": "12:00",
        "break_end_time": "13:00"
    }
}

Описание полей ответа
  • work_start_time - время начала рабочего дня;
  • work_end_time - время завершения рабочего дня;
  • break_start_time - время начала перерыва;
  • break_end_time - время окончания перерыва;

Исключения

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

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

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

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

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

https://beta.api.gigma.ru/shops/17/exceptions

Ответ

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

{
    "exceptions": [
        {
            "id": 1,
            "exception_start_date": "2024-08-10",
            "exception_end_date": "2024-08-12"
        }
    ],
    "exceptionsCount": 1
}

Описание полей ответа
  • id - первичный ключ;
  • exception_start_date - дата начала периода выходных дней;
  • exception_end_date - дата окончания периода выходных дней.

Добавление промежутка дней-исключений для выбранного магазина

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

Параметры запроса
  • exception_start_date - дата начала периода выходных дней;
  • exception_end_date - дата окончания периода выходных дней;
Пример запроса

https://beta.api.gigma.ru/shops/17/exceptions 

{
    "exception_start_date": "2024-08-10",
    "exception_end_date": "2024-08-12"
}

Ответ

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

{
    "exception": {
        "id": 1,
        "exception_start_date": "2024-08-10",
        "exception_end_date": "2024-08-12"
    }
}

Описание полей ответа
  • id - первичный ключ;
  • exception_start_date - дата начала периода выходных дней;
  • exception_end_date - дата окончания периода выходных дней.

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

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

Параметры запроса
  • exception_start_date - дата начала периода выходных дней;
  • exception_end_date - дата окончания периода выходных дней;
Пример запроса

https://beta.api.gigma.ru/shops/17/exceptions/1 

{
    "exception_start_date": "2024-08-10",
    "exception_end_date": "2024-08-12"
}

Ответ

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

{
    "exception": {
        "id": 1,
        "exception_start_date": "2024-08-10",
        "exception_end_date": "2024-08-12"
    }
}

Описание полей ответа
  • id - первичный ключ;
  • exception_start_date - дата начала периода выходных дней;
  • exception_end_date - дата окончания периода выходных дней;

Удаление промежутка дней-исключения для выбранного магазина

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

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

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

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

https://beta.api.gigma.ru/shops/17/exceptions/1

Ответ

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

{
    "message": "Shop exception deleted successfully."
}