Заказы

Пошаговый сценарий с примерами — управление магазином из кода. Здесь лежит контракт каждого метода.

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

Метод: GET
URL: https://api.gigma.ru/api/orders
Авторизация: Bearer сотрудника или агента с view-orders, create-orders или edit-orders
Headers: Accept: application/json; Authorization: Bearer {access_token}
Успешный ответ: 200

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

hierarchy (string, необязательно) — all для всех доступных заказов или my только для заказов текущего manager;
counterparty_id (integer, необязательно) — ID контрагента;
department_id[] (integer[], необязательно) — ID отделов менеджеров;
order_status_id[] (integer[], необязательно) — ID статусов заказа;
application_id[] (integer[], необязательно) — ID приложений-источников;
query (string, необязательно) — поиск по объекту, номеру договора, номеру счёта или адресу, минимум 3 символа;
date_from (date, необязательно) — дата создания от;
date_to (date, необязательно) — дата создания по.

Backend всегда добавляет project_id текущего actor. Для пользователя без роли owner/admin и с назначенным branch_id список дополнительно ограничивается этим филиалом.

Endpoint возвращает всю отфильтрованную коллекцию. page и per_page здесь не поддерживаются; для UI-пагинации используйте GET /api/tables/orders.

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

GET /api/orders?hierarchy=my&order_status_id[]=1&department_id[]=7&date_from=2026-08-01
Authorization: Bearer <access_token>
Accept: application/json

Ответ

{
	"orders": [
		{
			"id": 17,
			"avatar": null,
			"status": {
				"id": 1,
				"name": "В сборке",
				"avatar": "https://api.gigma.ru/storage/uploads/default.svg",
				"created_at": "2024-03-27T07:00:46.000000Z"
			},
			"price": "4500.00",
			"promo_code": null,
			"original_price": 5000,
			"product_discount_amount": 500,
			"promo_discount_amount": 0,
			"total_discount_amount": 500,
			"final_price": 4500,
			"invoice_number": null,
			"invoice_start_date": null,
			"invoice_end_date": null,
			"application": {
				"id": 14,
				"name": "Сей момент",
				"avatar": "https://api.gigma.ru/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": null,
			"branch": {
				"id": 15,
				"name": "Торговля косметикой",
				"avatar": "https://api.gigma.ru/storage/uploads/default.svg",
				"created_at": "2024-08-01T07:50:59.000000Z"
			},
			"object": null,
			"source": {
				"id": 14,
				"name": "Сей момент",
				"avatar": "https://api.gigma.ru/storage/uploads/default.svg",
				"created_at": "2024-08-01T09:20:01.000000Z"
			},
			"sales_channel": {
				"id": 1,
				"name": "Канал продаж 1",
				"avatar": "https://api.gigma.ru/storage/uploads/default.svg",
				"created_at": "2024-03-27T07:00:46.000000Z"
			},
			"manager": {
				"id": 1,
				"first_name": "Артём",
				"last_name": "Полищук",
				"middle_name": "Николаевич",
				"name": "Полищук Артём"
			},
			"promotion": null,
			"contract": null,
			"contract_number": null,
			"contract_start_date": null,
			"contract_end_date": null,
			"name": null,
			"refund_request": {
				"requested_at": null,
				"requested_by_user_id": null,
				"comment": null,
				"email_sent_at": null
			},
			"ticket": {
				"redeem_token": null,
				"redeemed_count": 0,
				"total_tickets": 1,
				"last_redeemed_at": null,
				"last_redeemed_by": null
			}
		}
	],
	"ordersCount": 1
}

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

orders (object[], обязательно) — массив ресурсов заказа; структура элемента совпадает с GET /api/orders/{id};
ordersCount (integer, обязательно) — количество заказов после применения фильтров;
orders[].counterparty (object, необязательно) — клиент заказа или null, если заказ создан без контрагента;
orders[].ticket (object, обязательно) — данные гашения билета с дополнительной проверкой project/branch scope.

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

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

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

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

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

https://api.gigma.ru/api/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://api.gigma.ru/api/orders/{id}
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

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

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

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

https://api.gigma.ru/api/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,
        "name": null,
        "promo_code": null,
        "original_price": null,
        "product_discount_amount": null,
        "promo_discount_amount": null,
        "total_discount_amount": null,
        "final_price": null,
        "refund_request": {
            "requested_at": null,
            "requested_by_user_id": null,
            "comment": null,
            "email_sent_at": null
        },
        "ticket": {
            "redeem_token": null,
            "redeemed_count": null,
            "total_tickets": null,
            "last_redeemed_at": null,
            "last_redeemed_by": null
        }
    }
}

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

id — первичный ключ (номер заказа)
avatar — объект с информацией о фотографии заказа
status — объект с информацией о статусе заказа
price — итоговая цена заказа
promo_code — применённый промокод
original_price — исходная цена до скидок
product_discount_amount — скидка по товарам
promo_discount_amount — скидка по промокоду
total_discount_amount — суммарная скидка
final_price — итоговая цена после всех скидок
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 — дата окончания договора
name — произвольное название заказа
refund_request — объект с информацией о запросе возврата: requested_at, requested_by_user_id, comment, email_sent_at
ticket — поля гашения билета (только для авторизованных с доступом к заказу): redeem_token, redeemed_count, total_tickets, last_redeemed_at, last_redeemed_by

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

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

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

⚠ Реальный minimum (Order/StoreRequest в itecho-erp-backend): только counterparty_id + manager_id. Остальные поля опциональны на уровне валидатора.

counterparty_id (int, обязательно) — ID контрагента (GET /api/counterparties)
manager_id (int, обязательно) — ID менеджера (GET /api/managers)
avatar_id (int, опционально) — ID фотографии (GET /api/files)
delivery_type_id (int, опционально) — ID типа доставки (GET /api/delivery_types)
address (string, опционально) — адрес заказа (min:3)
shop_id (int, опционально) — ID магазина (GET /api/shops). Рекомендуется с branch_id
branch_id (int, опционально) — ID бизнеса (GET /api/branches)
object_id (int, опционально) — ID объекта
application_id (int, опционально) — ID источника (E-Commerce application)
sales_channel_id (int, опционально) — ID канала продаж
promotion_id (int, опционально) — ID промоакции
contract_number (string, опционально) — номер договора
contract_id (int, опционально) — ID файла договора (GET /api/files)
contract_start_date (date, опционально) — YYYY-MM-DD
contract_end_date (date, опционально) — YYYY-MM-DD
invoice_number (string, опционально) — номер счёта
invoice_start_date (date, опционально) — YYYY-MM-DD
invoice_end_date (date, опционально) — YYYY-MM-DD

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

{
    "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://api.gigma.ru/api/orders/{id}
Авторизация: Bearer token
Headers: Authorization: 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 — дата окончания срока действия счёта

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

{
    "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 аналогичен ответу запроса получения выбранного заказа.

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

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

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

Маршрута нет: ресурс объявлен как apiResource('orders')->only(['index', 'show', 'store', 'update']), поэтому DELETE /api/orders/{id} до контроллера не доходит.

Обходной путь через статус тоже не работает: контракт PUT /api/orders/{id} не принимает order_status_id — валидация отбрасывает поле, запрос вернёт 200, а статус останется прежним. Отменяют и проводят заказ по этапам в интерфейсе платформы.

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

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

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

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

query — поисковая строка

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

https://api.gigma.ru/api/tables/orders/16/nomenclatures?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 — общая стоимость

Добавление товаров в заказ (= создание Reservation) ⚠ backend bug

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

⚠ Backend bug: endpoint часто возвращает 500 на корректных входных данных. Bypass: дождаться фикса бэка либо использовать E-Commerce flow (POST /api/counterparty/orders), который создаёт резервации внутри транзакции.

NB: под капотом этот endpoint создаёт запись Reservation (см. erp-rules §18.7). {id} в PUT/DELETE …/nomenclatures/{id} — это id записи Reservation, не nomenclature_id.

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

⚠ Реальный minimum (OrderNomenclature/StoreRequest): только quantity (min:1). Остальные — опциональны.

quantity (int, обязательно) — кол-во, ≥ 1
nomenclature_id (int, опционально) — ID номенклатуры из GET /api/nomenclatures. Без него резерв создаётся без привязки к конкретному товару.
storage_unit_id (int, опционально) — ID единицы измерения (GET /api/storage_units)
price (string, опционально) — цена decimal-string ("1000.00")
vat_id (int, опционально) — ID ставки НДС (GET /api/vats)

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

{
    "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://api.gigma.ru/api/orders/{id}/nomenclatures/{nomenclatureId}
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

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

nomenclature_id — ID номенклатуры (GET /api/nomenclatures)
quantity — кол-во товара
storage_unit_id — ID единицы измерения
price — стоимость товара
vat_id — ID НДС

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

{
    "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://api.gigma.ru/api/orders/{id}/nomenclatures/{nomenclatureId}
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

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

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

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

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

Ответ

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

{
    "message": "Order nomenclature deleted"
}

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

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

Файлы

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

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

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

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

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

https://api.gigma.ru/api/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://api.gigma.ru/api/orders/{id}/files
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

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

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

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

{
    "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://api.gigma.ru/api/orders/{id}/history
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

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

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

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

https://api.gigma.ru/api/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": "&laquo; Предыдущая",
                "active": false
            },
            {
                "url": "http://192.168.0.43:8000/api/orders/18/history?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Следующая &raquo;",
                "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 — описание

Запрос возврата

Запрос возврата по заказу

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

Создаёт запрос на возврат по заказу. Фиксирует время запроса, инициатора и комментарий.

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

comment (string, опционально) — причина возврата

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

{
    "comment": "Товар не подошёл по размеру"
}

Ответ

При успешном действии возвращается HTTP код 200 с обновлённым объектом заказа (те же поля, что и в GET /api/orders/{id}).