Промоакции и скидки

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

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

Ответ

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

{
    "promotions": [
        {
            "id": 1,
            "name": "Тестовая промоакция",
            "avatar": "https://api.gigma.ru/storage/uploads/default.svg",
            "created_at": "2024-07-27T18:13:40.000000Z"
        }
    ],
    "promotionsCount": 1
}

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

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

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

• query — поисковая строка
• status — фильтр по статусу
• application_id — фильтр по приложению

Ответ

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

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

• name (string, обязательно) — название скидки
• application_id (int, обязательно) — ID приложения
• discount_type (string) — тип: "percent" | "fixed"
• discount_value (string) — значение скидки, decimal-string
• code (string, опционально) — промокод
• description (string, опционально) — описание
• min_order_amount (string, опционально) — минимальная сумма заказа для применения
• max_discount_amount (string, опционально) — максимальная сумма скидки
• total_usage_limit (int, опционально) — лимит использований всего
• per_client_usage_limit (int, опционально) — лимит использований на одного клиента
• audience (string, опционально) — аудитория: "all" | "new" | "returning"
• starts_at (string, опционально) — дата начала ISO 8601
• ends_at (string, опционально) — дата окончания ISO 8601

Ответ

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

Ответ

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

{
    "discount": {
        "id": 1,
        "project_id": 10,
        "application_id": 1,
        "branch_id": 5,
        "name": "Скидка 10% на первый заказ",
        "code": "FIRST10",
        "description": "Для новых покупателей",
        "status": "active",
        "effective_status": "active",
        "discount_type": "percent",
        "discount_value": "10.00",
        "min_order_amount": "500.00",
        "max_discount_amount": "1000.00",
        "total_usage_limit": 100,
        "total_used_count": 5,
        "per_client_usage_limit": 1,
        "usage_percent": 5,
        "audience": "new",
        "starts_at": "2026-01-01T00:00:00.000000Z",
        "ends_at": "2026-12-31T23:59:59.000000Z",
        "url": null,
        "paused_at": null,
        "archived_at": null,
        "share_path": "/share/discount/FIRST10",
        "magic_link": "https://api.gigma.ru/api/d/FIRST10",
        "created_by": { "id": 1, "name": "Артём" },
        "updated_by": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z",
        "latest_usages": []
    }
}

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

• status — статус скидки (задан вручную): "active" | "paused" | "archived"
• effective_status — реальный статус с учётом дат и лимитов (может отличаться от status)
• discount_type — тип скидки: "percent" (процент) | "fixed" (фиксированная сумма)
• discount_value — значение скидки, decimal-string
• total_used_count — сколько раз скидка уже применялась
• usage_percent — процент использования от total_usage_limit (0–100)
• audience — кому доступна скидка: "all" | "new" | "returning"
• share_path — путь для шаринга промокода в E-Commerce приложении
• magic_link — прямая ссылка для активации скидки
• paused_at — время постановки на паузу (или null)
• archived_at — время архивирования (или null)
• latest_usages — последние применения скидки (массив объектов)

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

Те же параметры, что и при создании.

Ответ

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

Ответ

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

Ответ

При успешном действии возвращается HTTP код 200 со сводной статистикой по скидкам (количество активных, на паузе, архивных, итоговая экономия покупателей и т.п.).

Временно останавливает скидку. effective_status становится "paused", поле paused_at заполняется.

Ответ

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

Снимает паузу и возобновляет скидку. paused_at сбрасывается в null.

Ответ

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

Переводит скидку в архив. archived_at заполняется текущим временем.

Ответ

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

Ответ

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