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

Заказы

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

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

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

  • order_status_id - массив ID статусов заказа из справочника
  • application_id - массив ID источников заказа из запроса
  • department_id - массив ID отделов из запроса
  • hierarchy - all для получения всех заказов, my - только своих
  • page - текущая страница (для пагинации)
  • per_page - кол-во элементов на странице
  • query - поисковая строка
  • date_from - "дата с..." (от даты добавления в систему)
  • date_to - "дата по..." (от даты добавления в систему)

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

https://beta.api.gigma.ru/tables/orders?query=коледино&order_status_id[]=1&application_id[]=1?hierarchy=my&department_id[]=1

Ответ

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

{
    "columns": [
        {
            "id": 26,
            "table_id": 4,
            "order": 0,
            "key": "id",
            "has_icon": 0,
            "text": "№"
        },
        {
            "id": 27,
            "table_id": 4,
            "order": 1,
            "key": "created_at",
            "has_icon": 0,
            "text": "Создан"
        },
        {
            "id": 28,
            "table_id": 4,
            "order": 2,
            "key": "branch",
            "has_icon": 1,
            "text": "Бизнес"
        },
        {
            "id": 29,
            "table_id": 4,
            "order": 3,
            "key": "counterparty",
            "has_icon": 1,
            "text": "Клиент"
        },
        {
            "id": 30,
            "table_id": 4,
            "order": 4,
            "key": "object",
            "has_icon": 1,
            "text": "Проект\/Объект"
        },
        {
            "id": 31,
            "table_id": 4,
            "order": 5,
            "key": "source",
            "has_icon": 1,
            "text": "Источник"
        },
        {
            "id": 32,
            "table_id": 4,
            "order": 6,
            "key": "manager",
            "has_icon": 1,
            "text": "Менеджер"
        },
        {
            "id": 33,
            "table_id": 4,
            "order": 7,
            "key": "sales_channel",
            "has_icon": 1,
            "text": "Канал продаж"
        },
        {
            "id": 87,
            "table_id": 4,
            "order": 8,
            "key": "promo",
            "has_icon": 1,
            "text": "Промоакция"
        },
        {
            "id": 106,
            "table_id": 4,
            "order": 9,
            "key": "price",
            "has_icon": 0,
            "text": "Сумма"
        },
        {
            "id": 107,
            "table_id": 4,
            "order": 10,
            "key": "status",
            "has_icon": 0,
            "text": "Статус\/Этап"
        }
    ],
    "orders": [
        {
            "id": 16,
            "created_at": "27.07.2024 12:43",
            "branch": {
                "icon": "http:\/\/localhost:8000\/\/storage\/uploads\/9qzh2GCaYpRpaxXnql0JZYpIesu3qlvQLV2OBhcN.png",
                "value": "Продажа косметики"
            },
            "counterparty": {
                "icon": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "value": " "
            },
            "object": null,
            "source": {
                "icon": "http:\/\/localhost:8000\/\/storage\/uploads\/uPINajA2l2XPB44ojjTEd88wRKxRwsWXIlrgg2iX.jpg",
                "value": "Сей момент"
            },
            "manager": {
                "icon": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "value": "Полищук Артём"
            },
            "sales_channel": {
                "icon": "http:\/\/localhost:8000\/\/storage\/uploads\/uPINajA2l2XPB44ojjTEd88wRKxRwsWXIlrgg2iX.jpg",
                "value": "Сей момент"
            },
            "promotion": null,
            "price": null,
            "status": {
                "icon": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "value": "В сборке"
            }
        }
    ],
    "pagination": {
        "total": 1,
        "per_page": 1,
        "current_page": 1,
        "last_page": 1,
        "from": 1,
        "to": 1
    }
}

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

  • columns - массив столбцов
  • pagination - объект с информацией, необходимой для пагинации
  • id - первичный ключ (номер заказа)
  • created_at - дата/время создания заказа
  • branch - объект с информацией о бизнесе
  • counterparty - объект с информацией о клиенте (контрагенте)
  • object - объект с информацией об объекте
  • source - объект с информацией об источнике заказа
  • manager - объект с информацией о менеджере
  • sales_channel - объект с информацией о канале продаж
  • promotion - объект с информацией о промоакции
  • price - стоимость заказа
  • status - объект с информацией о статусе заказа

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

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

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

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

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

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

Ответ

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

{
    "order": {
        "id": 17,
        "avatar": {
            "id": 763,
            "name": "ai monsters.jpg",
            "type": {
                "id": 2,
                "name": "Аватар",
                "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            "path": "http:\/\/localhost:8000\/storage\/uploads\/AsQsvs5VPbIo6YkYlnlQel39T7RS01zYD2NPlYYv.jpg",
            "created_at": "2024-08-01T15:55:09.000000Z",
            "updated_at": "2024-08-01T15:55:09.000000Z"
        },
        "status": {
            "id": 1,
            "name": "В сборке",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-03-27T07:00:46.000000Z"
        },
        "invoice_number": null,
        "invoice_start_date": null,
        "invoice_end_date": null,
        "application": {
            "id": 14,
            "name": "Сей момент",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-08-01T09:20:01.000000Z"
        },
        "counterparty": {
            "id": 56,
            "name": "ООО \"РОГА И КОПЫТА\""
        },
        "delivery_type": {
            "id": 1,
            "name": "Самовывоз",
            "price": "0.00",
            "is_active": 1,
            "created_at": "2024-05-13T05:26:37.000000Z"
        },
        "address": "357100, Ставропольский край, г Невинномысск",
        "branch": {
            "id": 15,
            "name": "Торговля косметикой",
            "avatar": "http:\/\/localhost:8000\/\/storage\/uploads\/b9t9B4Y4Fq6dAKvgVW2vhzFJ12ZrgRgvVHdMnfjt.png",
            "created_at": "2024-08-01T07:50:59.000000Z"
        },
        "object": null,
        "source": {
            "id": 14,
            "name": "Сей момент",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-08-01T09:20:01.000000Z"
        },
        "sales_channel": {
            "id": 1,
            "name": "Канал продаж 1",
            "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": "Полищук Артём"
        },
        "promotion": {
            "id": 1,
            "name": "Улётное лето",
            "avatar": "http:\/\/localhost:8000\/\/storage\/uploads\/default_brand.png",
            "created_at": "2024-07-28T16:59:24.000000Z"
        },
        "contract": null,
        "contract_number": null,
        "contract_start_date": null,
        "contract_end_date": null
    }
}

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

  • id - первичный ключ (номер заказа)
  • avatar - объект с информацией о фотографии заказа. Для получения информации о возвращаемых полях см. запрос
  • status - объект с информацией о статусе заказа. Для получения информации о возвращаемых полях см. запрос
  • invoice_number - номер счёта
  • application - объект с информацией о приложении. Для получения информации о возвращаемых полях см. запрос
  • invoice_start_date - дата счёта (дата создания счёта)
  • invoice_end_date - дата окончания срока действия счёта
  • counterparty - объект с информацией о контрагенте. Для получения информации о возвращаемых полях см. запрос
  • delivery_type - объект с информацией о способе доставки заказа. Для получения информации о возвращаемых полях см. запрос
  • address - адрес
  • branch - объект с информацией о бизнесе. Для получения информации о возвращаемых полях см. запрос
  • object - информация об объекте. Для получения информации о возвращаемых полях см. запрос
  • source - объект с информацией об источнике заказа. Для получения информации о возвращаемых полях см. запрос
  • sales_channel - объект с информацией о канале продаж. Для получения информации о возвращаемых полях см. запрос
  • manager - объект с информацией о менеджере. Для получения информации о возвращаемых полях см. запрос
  • promotion - объект с информацией о промоакции. Для получения информации о возвращаемых полях см. запрос
  • contract - объект с информацией о договоре. Для получения информации о возвращаемых полях см. запрос
  • contract_number - номер договора
  • contract_start_date - дата начала договора
  • contract_end_date - дата окончания договора

Добавление заказа

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

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

  • avatar_id - ID фотографии склада из справочника
  • counterparty_id - ID контрагента из справочника
  • delivery_type_id - ID типа доставки из справочника
  • address - адрес заказа, полученный из запроса
  • shop_id - ID магазина из справочника. Рекомендуется использовать с параметром branch_id, чтобы получить актуальный для этого бизнеса список магазинов
  • branch_id - ID бизнеса из справочника
  • object_id - ID объекта из справочника
  • application_id - ID источника из справочника
  • sales_channel_id - ID канала продаж из справочника
  • manager_id - ID менеджера из справочника
  • promotion_id - ID промоакции из справочника
  • contract_number - номер договора
  • contract_id - ID договора из справочника
  • contract_start_date - дата начала действия договора
  • contract_end_date - дата окончания действия договора
  • invoice_number - номер счёта
  • invoice_start_date - дата счёта (дата создания счёта)
  • invoice_end_date - дата окончания срока действия счёта

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

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

{
    "avatar_id": 1,
    "counterparty_id": 3,
    "delivery_type_id": 1,
    "address": "г Москва, пл Комсомольская, д 20",
    "branch_id": 1,
    "shop_id": 1,
    "object_id": null,
    "application_id": 10,
    "sales_channel_id": 1,
    "manager_id": 1,
    "promotion_id": null,
    "contract_number": "А-35/2024",
    "contract_id": 1,
    "contract_start_date": "2024-01-11",
    "contract_end_date": "2024-01-11",
    "invoice_number": "123123",
    "invoice_start_date": "2024-01-11",
    "invoice_end_date": "2024-01-11"
}

Ответ

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

{
    "order": {
        "id": 17,
        "avatar": {
            "id": 763,
            "name": "ai monsters.jpg",
            "type": {
                "id": 2,
                "name": "Аватар",
                "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            "path": "http:\/\/localhost:8000\/storage\/uploads\/AsQsvs5VPbIo6YkYlnlQel39T7RS01zYD2NPlYYv.jpg",
            "created_at": "2024-08-01T15:55:09.000000Z",
            "updated_at": "2024-08-01T15:55:09.000000Z"
        },
        "status": {
            "id": 1,
            "name": "В сборке",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-03-27T07:00:46.000000Z"
        },
        "invoice_number": null,
        "invoice_start_date": null,
        "invoice_end_date": null,
        "application": {
            "id": 14,
            "name": "Сей момент",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-08-01T09:20:01.000000Z"
        },
        "counterparty": {
            "id": 56,
            "name": "ООО \"РОГА И КОПЫТА\""
        },
        "delivery_type": {
            "id": 1,
            "name": "Самовывоз",
            "price": "0.00",
            "is_active": 1,
            "created_at": "2024-05-13T05:26:37.000000Z"
        },
        "address": "357100, Ставропольский край, г Невинномысск",
        "shop": {
            "id": 1,
            "photo": {
                "id": 1,
                "name": "logo.svg",
                "type": {
                    "id": 1,
                    "name": "Трудовой договор",
                    "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                    "created_at": "2024-03-27T07:00:46.000000Z"
                },
                "path": "http:\/\/localhost:8000\/storage\/uploads\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
                "created_at": "2024-04-14T20:04:32.000000Z",
                "updated_at": "2024-04-14T20:04:32.000000Z"
            },
            "name": "Центральный",
            "address": "г. Ростов-на-Дону, ул. Ленина, 1",
            "phone": "+79851234567",
            "schedule": "ПН-ПТ, с 10:00 до 18:00"
        },
        "branch": {
            "id": 15,
            "name": "Торговля косметикой",
            "avatar": "http:\/\/localhost:8000\/\/storage\/uploads\/b9t9B4Y4Fq6dAKvgVW2vhzFJ12ZrgRgvVHdMnfjt.png",
            "created_at": "2024-08-01T07:50:59.000000Z"
        },
        "object": null,
        "source": {
            "id": 14,
            "name": "Сей момент",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-08-01T09:20:01.000000Z"
        },
        "sales_channel": {
            "id": 1,
            "name": "Канал продаж 1",
            "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": "Полищук Артём"
        },
        "promotion": {
            "id": 1,
            "name": "Улётное лето",
            "avatar": "http:\/\/localhost:8000\/\/storage\/uploads\/default_brand.png",
            "created_at": "2024-07-28T16:59:24.000000Z"
        },
        "contract": null,
        "contract_number": null,
        "contract_start_date": null,
        "contract_end_date": null
    }
}

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

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

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

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

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

  • avatar_id - ID фотографии склада из справочника
  • counterparty_id - ID контрагента из справочника
  • delivery_type_id - ID типа доставки из справочника
  • address - адрес заказа, полученный из запроса
  • shop_id - ID магазина из справочника. Рекомендуется использовать с параметром branch_id, чтобы получить актуальный для этого бизнеса список магазинов
  • branch_id - ID бизнеса из справочника
  • object_id - ID объекта из справочника
  • application_id - ID источника из справочника
  • sales_channel_id - ID канала продаж из справочника
  • manager_id - ID менеджера из справочника
  • promotion_id - ID промоакции из справочника
  • contract_number - номер договора
  • contract_id - ID договора из справочника
  • contract_start_date - дата начала действия договора
  • contract_end_date - дата окончания действия договора
  • invoice_number - номер счёта
  • invoice_start_date - дата счёта (дата создания счёта)
  • invoice_end_date - дата окончания срока действия счёта

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

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

{
    "avatar_id": 1,
    "counterparty_id": 3,
    "delivery_type_id": 1,
    "address": "г Москва, пл Комсомольская, д 20",
    "branch_id": 1,
    "object_id": null,
    "application_id": 10,
    "sales_channel_id": 1,
    "manager_id": 1,
    "promotion_id": null,
    "contract_number": "А-35/2024",
    "contract_id": 1,
    "contract_start_date": "2024-01-11",
    "contract_end_date": "2024-01-11",
    "invoice_number": "123123",
    "invoice_start_date": "2024-01-11",
    "invoice_end_date": "2024-01-11"
}

Ответ

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

{
    "order": {
        "id": 17,
        "avatar": {
            "id": 763,
            "name": "ai monsters.jpg",
            "type": {
                "id": 2,
                "name": "Аватар",
                "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            "path": "http:\/\/localhost:8000\/storage\/uploads\/AsQsvs5VPbIo6YkYlnlQel39T7RS01zYD2NPlYYv.jpg",
            "created_at": "2024-08-01T15:55:09.000000Z",
            "updated_at": "2024-08-01T15:55:09.000000Z"
        },
        "status": {
            "id": 1,
            "name": "В сборке",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-03-27T07:00:46.000000Z"
        },
        "invoice_number": null,
        "invoice_start_date": null,
        "invoice_end_date": null,
        "application": {
            "id": 14,
            "name": "Сей момент",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-08-01T09:20:01.000000Z"
        },
        "counterparty": {
            "id": 56,
            "name": "ООО \"РОГА И КОПЫТА\""
        },
        "delivery_type": {
            "id": 1,
            "name": "Самовывоз",
            "price": "0.00",
            "is_active": 1,
            "created_at": "2024-05-13T05:26:37.000000Z"
        },
        "address": "357100, Ставропольский край, г Невинномысск",
        "shop": {
            "id": 1,
            "photo": {
                "id": 1,
                "name": "logo.svg",
                "type": {
                    "id": 1,
                    "name": "Трудовой договор",
                    "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                    "created_at": "2024-03-27T07:00:46.000000Z"
                },
                "path": "http:\/\/localhost:8000\/storage\/uploads\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
                "created_at": "2024-04-14T20:04:32.000000Z",
                "updated_at": "2024-04-14T20:04:32.000000Z"
            },
            "name": "Центральный",
            "address": "г. Ростов-на-Дону, ул. Ленина, 1",
            "phone": "+79851234567",
            "schedule": "ПН-ПТ, с 10:00 до 18:00"
        },
        "branch": {
            "id": 15,
            "name": "Торговля косметикой",
            "avatar": "http:\/\/localhost:8000\/\/storage\/uploads\/b9t9B4Y4Fq6dAKvgVW2vhzFJ12ZrgRgvVHdMnfjt.png",
            "created_at": "2024-08-01T07:50:59.000000Z"
        },
        "object": null,
        "source": {
            "id": 14,
            "name": "Сей момент",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-08-01T09:20:01.000000Z"
        },
        "sales_channel": {
            "id": 1,
            "name": "Канал продаж 1",
            "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": "Полищук Артём"
        },
        "promotion": {
            "id": 1,
            "name": "Улётное лето",
            "avatar": "http:\/\/localhost:8000\/\/storage\/uploads\/default_brand.png",
            "created_at": "2024-07-28T16:59:24.000000Z"
        },
        "contract": null,
        "contract_number": null,
        "contract_start_date": null,
        "contract_end_date": null
    }
}

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

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

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

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

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

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

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

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

Ответ

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

{
    "message": "Order deleted."
}

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

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

Содержание заказа

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

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

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

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

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

https://beta.api.gigma.ru/tables/orders?query=картридж

Ответ

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

{
    "columns": [
        {
            "id": 108,
            "table_id": 14,
            "order": 0,
            "key": "code",
            "has_icon": 0,
            "text": "Код"
        },
        {
            "id": 109,
            "table_id": 14,
            "order": 1,
            "key": "name",
            "has_icon": 1,
            "text": "Наименование"
        },
        {
            "id": 110,
            "table_id": 14,
            "order": 2,
            "key": "warehouse",
            "has_icon": 1,
            "text": "Склад"
        },
        {
            "id": 111,
            "table_id": 14,
            "order": 3,
            "key": "city",
            "has_icon": 0,
            "text": "Город"
        },
        {
            "id": 112,
            "table_id": 14,
            "order": 4,
            "key": "brand",
            "has_icon": 1,
            "text": "Торговая марка"
        },
        {
            "id": 113,
            "table_id": 14,
            "order": 5,
            "key": "vat",
            "has_icon": 0,
            "text": "Ставка НДС"
        },
        {
            "id": 114,
            "table_id": 14,
            "order": 6,
            "key": "unit",
            "has_icon": 0,
            "text": "Ед. изм."
        },
        {
            "id": 115,
            "table_id": 14,
            "order": 7,
            "key": "price",
            "has_icon": 0,
            "text": "Цена"
        },
        {
            "id": 116,
            "table_id": 14,
            "order": 8,
            "key": "quantity",
            "has_icon": 0,
            "text": "Кол-во"
        },
        {
            "id": 117,
            "table_id": 14,
            "order": 9,
            "key": "amount",
            "has_icon": 0,
            "text": "Сумма"
        }
    ],
    "orderNomenclatures": [
        {
            "id": 19,
            "code": "1234",
            "name": {
                "icon": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "value": "Tony Moly Soft Touch Air Puff 5P"
            },
            "warehouse": {
                "icon": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "value": "Петухова"
            },
            "city": "Новосибирск",
            "brand": {
                "icon": "http:\/\/localhost:8000\/\/storage\/uploads\/default_brand.png",
                "value": "Tony Moly"
            },
            "vat": "20.00",
            "unit": "ед",
            "quantity": 5,
            "price": "900.00",
            "amount": "4500.00"
        },
        {
            "id": 20,
            "code": "123",
            "name": {
                "icon": "http:\/\/localhost:8000\/\/storage\/uploads\/lp9ypkHwfjK2bULPWbllznxFlGt71e3hUMnPFn2F.webp",
                "value": "BANILA CO Glow Fit Foundation Brush"
            },
            "warehouse": {
                "icon": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "value": "Петухова"
            },
            "city": "Новосибирск",
            "brand": {
                "icon": "http:\/\/localhost:8000\/\/storage\/uploads\/default_brand.png",
                "value": "Holika Holika"
            },
            "vat": "20.00",
            "unit": "ед",
            "quantity": 1,
            "price": "204500.00",
            "amount": "204500.00"
        }
    ],
    "pagination": {
        "total": 2,
        "per_page": 10,
        "current_page": 1,
        "last_page": 1,
        "from": 1,
        "to": 2
    }
}

Описание полей ответа
  • columns - массив столбцов
  • pagination - объект с информацией, необходимой для пагинации
  • id - первичный ключ
  • name - объект с номенклатурным наименованием товара
  • warehouse - объект с наименованием склада
  • city - город
  • brand - объект с информацией о производителе
  • vat - НДС
  • unit - единицы измерения товара
  • quantity - кол-во товара
  • price - стоимость за 1 единицу
  • amount - общая стоимость

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

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

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

  • warehouse_nomenclature_id - ID позиции на складе из запроса с параметром query
  • quantity - кол-во товара
  • storage_unit_id - ID единицы измерения из запроса
  • price - стоимость товара
  • vat_id - ID НДС. Для получения списка значения используйте запрос

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

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

{
    "warehouse_nomenclature_id": 1,
    "quantity": 1,
    "storage_unit_id": 1,
    "price": 100,
    "vat_id": 1
}

Ответ

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

{
    "id": 23,
    "orderNomenclature": {
        "warehouseNomenclature": {
            "id": 1,
            "avatar": "http:\/\/localhost:8000\/\/storage\/uploads\/kcdDZKHha8HbujO4z80uYmOsayHHxTXZrM2q6GEN.webp",
            "name": "BANILA CO Glow Fit Foundation Brush \/ Склад Петухова \/ 5 ед \/ 204500.00 руб"
        },
        "quantity": 1,
        "unit": {
            "id": 1,
            "name": "Литр",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-06-24T09:57:10.000000Z"
        },
        "price": "1.00",
        "vat": {
            "id": 1,
            "name": "Без НДС",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-08-12T08:51:40.000000Z"
        },
        "amount": "1.00"
    }
}

Описание полей ответа
  • id - ID (первичный ключ) товарной позиции в заказе
  • warehouseNomenclature - объект с информацией о товаре, хранимом на складе
  • quantity - кол-во товара
  • unit - объект с информацией о единицах измерения из запроса
  • price - цена товара
  • vat - НДС
  • amount - общая стоимость товарной позиции

Обновление товаров в заказе

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

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

  • warehouse_nomenclature_id - ID позиции на складе из запроса с параметром query
  • quantity - кол-во товара
  • storage_unit_id - ID единицы измерения из запроса
  • price - стоимость товара
  • vat_id - ID НДС. Для получения списка значения используйте запрос

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

https://beta.api.gigma.ru/orders/16/nomenclatures/{id}

{
    "warehouse_nomenclature_id": 1,
    "quantity": 1,
    "storage_unit_id": 1,
    "price": 100,
    "vat_id": 1
}

Ответ

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

{
    "id": 23,
    "orderNomenclature": {
        "warehouseNomenclature": {
            "id": 1,
            "avatar": "http:\/\/localhost:8000\/\/storage\/uploads\/kcdDZKHha8HbujO4z80uYmOsayHHxTXZrM2q6GEN.webp",
            "name": "BANILA CO Glow Fit Foundation Brush \/ Склад Петухова \/ 5 ед \/ 204500.00 руб"
        },
        "quantity": 1,
        "unit": {
            "id": 1,
            "name": "Литр",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-06-24T09:57:10.000000Z"
        },
        "price": "1.00",
        "vat": {
            "id": 1,
            "name": "Без НДС",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-08-12T08:51:40.000000Z"
        },
        "amount": "1.00"
    }
}

Описание полей ответа
  • id - ID (первичный ключ) товарной позиции в заказе
  • warehouseNomenclature - объект с информацией о товаре, хранимом на складе
  • quantity - кол-во товара
  • unit - объект с информацией о единицах измерения из запроса
  • price - цена товара
  • vat - НДС
  • amount - общая стоимость товарной позиции

Удаление товаров из заказа

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

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

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

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

https://beta.api.gigma.ru/orders/16/nomenclatures/28

Ответ

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

{
    "message": "Order nomenclature deleted"
}

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

Файлы

Получение списка файлов (табличное представление)

Метод: GET
URL: https://beta.api.gigma.ru/tables/orders/{id}/files

Авторизация: Bearer token

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

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

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

https://beta.api.gigma.ru/tables/orders/18/files

Ответ

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

{
    "columns": [
        {
            "id": 34,
            "table_id": 5,
            "order": 0,
            "key": "id",
            "has_icon": 0,
            "text": "№"
        },
        {
            "id": 35,
            "table_id": 5,
            "order": 1,
            "key": "created_at",
            "has_icon": 0,
            "text": "Дата"
        },
        {
            "id": 36,
            "table_id": 5,
            "order": 2,
            "key": "creator",
            "has_icon": 1,
            "text": "Создатель"
        },
        {
            "id": 37,
            "table_id": 5,
            "order": 3,
            "key": "name",
            "has_icon": 0,
            "text": "Название"
        },
        {
            "id": 38,
            "table_id": 5,
            "order": 3,
            "key": "path",
            "has_icon": 0,
            "text": "Ссылка"
        }
    ],
    "files": [
        {
            "id": 4,
            "creator": {
                "icon": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                "value": "Полищук Артём"
            },
            "name": "Rating container.svg",
            "path": "http:\/\/localhost:8000\/storage\/uploads\/u7TY0sLEoWiFgeglUHHbWgchUIS41yhAPZ0uMuYX.svg",
            "created_at": "18.04.2024 13:50"
        }
    ],
    "pagination": {
        "total": 1,
        "per_page": 10,
        "current_page": 1,
        "last_page": 1,
        "from": 1,
        "to": 1
    }
}

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

Добавление файла

Метод: POST
URL: https://beta.api.gigma.ru/orders/{id}/files

Авторизация: Bearer token

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

  • file - загружаемый документ

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

https://beta.api.gigma.ru/orders/18/files

{
    "file": FILE('path')
}

Ответ

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

{
    "file": {
        "id": 593,
        "name": "Инфо Агбис (2).txt",
        "type": {
            "id": 3,
            "name": "Документ к заказу",
            "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
            "created_at": "2024-03-27T07:00:46.000000Z"
        },
        "path": "http:\/\/localhost:8000\/storage\/uploads\/QWu9ghBy6kfsXsEQZBuIqhpEoY8ghrCIFZhBdpwj.txt",
        "created_at": "2024-07-31T07:06:37.000000Z",
        "updated_at": "2024-07-31T07:06:37.000000Z"
    }
}

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

Удаление файла

Удаление файла из заказа полностью аналогично стандартному удалению файла. Для получения информации о процедуре см. запрос.

История изменений

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

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

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

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

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

https://beta.api.gigma.ru/orders/18/history

Ответ

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

{
    "orders": {
        "current_page": 1,
        "data": [
            {
                "id": 1,
                "icon": "done",
                "color": "success",
                "title": "Создан заказ №18",
                "description": "Создал(-а) Артём Полищук",
                "dateTime": "31.07.2024"
            },
            {
                "id": 2,
                "icon": "done",
                "color": "success",
                "title": "Отредактирован заказ №18",
                "description": "Отредактировал(-а) Артём Полищук",
                "dateTime": "31.07.2024"
            }
        ],
        "first_page_url": "http:\/\/192.168.0.43:8000\/api\/orders\/18\/history?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "http:\/\/192.168.0.43:8000\/api\/orders\/18\/history?page=1",
        "links": [
            {
                "url": null,
                "label": "« Предыдущая",
                "active": false
            },
            {
                "url": "http:\/\/192.168.0.43:8000\/api\/orders\/18\/history?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Следующая »",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "http:\/\/192.168.0.43:8000\/api\/orders\/18\/history",
        "per_page": 10,
        "prev_page_url": null,
        "to": 2,
        "total": 2
    }
}

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