Заказы

Предварительный расчёт стоимости заказа

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

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

products — массив выбранных товаров
products.id — ID выбранного товара
products.quantity — кол-во единиц выбранного товара

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

{
    "products": [
        {
            "id": 28504,
            "quantity": 3
        }
    ]
}

Ответ

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

{
    "price": 1952.4,
    "discount": 195.24,
    "total": 1757.16
}

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

price — общая стоимость заказа (в руб.)
discount — скидка (выгода) при оформлении заказа (в руб.)
total — сумма к оплате (в руб.)

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

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

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

Список передаваемых параметров отсутствует.

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

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

Ответ

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

{
    "orders": [
        {
            "id": 1,
            "status": {
                "id": 1,
                "name": "В сборке",
                "photo": null,
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            "price": "4900.00",
            "delivery_type": {
                "id": 1,
                "name": "Самовывоз",
                "price": "0.00",
                "is_active": 1,
                "created_at": "2024-05-13T05:26:37.000000Z"
            },
            "shop": {
                "id": 1,
                "photo": null,
                "name": "Центральный",
                "address": "г. Донецк, ул. Ленина, 1",
                "phone": "+79851234567",
                "schedule": "ПН-ПТ, с 10:00 до 18:00"
            },
            "products": [
                {
                    "id": 1,
                    "old_price": null,
                    "price": "2450.00",
                    "name": "BANILA CO Glow Fit Foundation Brush",
                    "photos": [
                        {
                            "id": 14,
                            "name": "full_covericious_glow_fit_foundation_spf25_pa__23_peanut.jpg",
                            "path": "https://beta.back.erp.itecho.ru/storage/uploads/full_covericious_glow_fit_foundation_spf25_pa__23_peanut.jpg"
                        }
                    ],
                    "quantity": 2
                }
            ],
            "created_at": "2024-05-13T05:29:39.000000Z"
        }
    ],
    "ordersCount": 1
}

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

orders — массив объектов заказов
id — первичный ключ заказа
status — объект с информацией о текущем статусе заказа
price — сумма к оплате
delivery_type — объект с информацией о способе доставки
shop — объект с информацией о выбранном магазине (если способ доставки не «Самовывоз», поле равно null)
products — массив товаров в заказе
created_at — дата и время создания заказа
ordersCount — общее количество заказов

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

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

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

delivery_type_id — ID способа доставки
delivery_subtype_id — ID подкатегорий доставки. Применяется для delivery_type_id, отличных от id = 1 (Самовывоза)
delivery_subtype_param_id — ID параметра подкатегории доставки. Применяется для delivery_subtype_id, отличных от id = 2 (Курьерская доставка)
payment_type_id — ID выбранного способа оплаты
shop_id — ID выбранного магазина (пункта выдачи)
address — адрес курьерской доставки. Используйте значение value. Применяется для delivery_subtype_id = 2 (Курьерская доставка)
products — массив выбранных товаров
products.id — ID выбранного товара
products.quantity — кол-во единиц выбранного товара

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

{
    "delivery_type_id": 2,
    "delivery_subtype_id": 2,
    "payment_type_id": 2,
    "address": "115477, г Москва, р-н Царицыно, ул Деловая, д 20",
    "products": [
        {
            "id": 1,
            "quantity": 2
        }
    ]
}

Ответ

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

{
    "order": {
        "id": 169,
        "status": {
            "id": 4,
            "name": "Можно забирать",
            "photo": null,
            "created_at": "2024-03-27T07:00:46.000000Z"
        },
        "price": "760.00",
        "delivery_type": {
            "id": 2,
            "name": "Доставка транспортной компанией СДЭК",
            "price": "300.00",
            "is_active": 1
        },
        "delivery_subtype": {
            "id": 2,
            "name": "Курьер",
            "price": "1000.00",
            "is_active": 1
        },
        "delivery_subtype_param": null,
        "payment_type": {
            "id": 1,
            "photo": "https://api.gigma.ru/storage/uploads/pay.svg",
            "name": "При получении",
            "description": "Оплата наличными или картой при получении."
        },
        "shop": null,
        "address": "115477, г Москва, р-н Царицыно, ул Деловая, д 20",
        "products": [
            {
                "id": 30525,
                "old_price": null,
                "price": "760.00",
                "name": "Мясной салат 210г",
                "photos": [
                    {
                        "id": 3253,
                        "name": "XXL_height (1).jpg",
                        "path": "https://api.gigma.ru/storage/uploads/y88lMgVYhP8fhp90va2BEDjsnlXGIVDJcGKzgm3i.jpg",
                        "link": null
                    },
                    {
                        "id": 3254,
                        "name": "XXL_height (2).jpg",
                        "path": "https://api.gigma.ru/storage/uploads/1hh3OTSweJJOuH5FcN7XOUMa1bB0DLLnOZErqKzE.jpg",
                        "link": null
                    },
                    {
                        "id": 3255,
                        "name": "XXL_height (3).jpg",
                        "path": "https://api.gigma.ru/storage/uploads/V4zfYLcFZ7QNjI5lFtasZuSO0PkywqtilzhezBMs.jpg",
                        "link": null
                    },
                    {
                        "id": 3256,
                        "name": "XXL_height (4).jpg",
                        "path": "https://api.gigma.ru/storage/uploads/9u8C3J3vmRMEOHSaCuYNB5MYluagdhrgZFaPmE7P.jpg",
                        "link": null
                    }
                ],
                "quantity": 1
            }
        ],
        "payment_link": null,
        "created_at": "2025-05-29T09:17:51.000000Z"
    }
}

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

columns — объект, содержащий информацию для генерации таблиц
pagination — объект с информацией о пагинации
data.id — первичный ключ (номер заказа)
data.created_at — дата/время заказа
data.branch — категория бизнеса
data.counterparty — объект с информацией о клиенте (icon — аватар, value — ФИО)
data.object — объект
data.promo — информация о промоакции (icon — фото, value — название)
data.source — источник заказа (icon — фото, value — название)
data.delivery_type — метод доставки
data.delivery_subtype — подтип доставки
data.delivery_subtype_param — параметр подтипа доставки
data.address — адрес
data.payment_type — тип оплаты
data.price — стоимость заказа
data.status — этап работ (icon — фото, value — название)

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

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

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

Передаваемые параметры отсутствуют.

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

https://api.gigma.ru/api/counterparty/orders/169

Ответ

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

{
  "order": {
    "id": 169,
    "status": {
      "id": 4,
      "name": "Можно забирать",
      "photo": null,
      "created_at": "2024-03-27T07:00:46.000000Z"
    },
    "price": "760.00",
    "delivery_type": {
      "id": 2,
      "name": "Доставка транспортной компанией СДЭК",
      "price": "300.00",
      "is_active": 1
    },
    "delivery_subtype": {
      "id": 2,
      "name": "Курьер",
      "price": "1000.00",
      "is_active": 1
    },
    "delivery_subtype_param": {
      "id": 1,
      "name": "г. Донецк, ул.Кручатова 1, пн-пт 10:00-18:00, сб 10:00-16:00, вс выходной"
    },
    "payment_type": {
      "id": 1,
      "photo": "https://api.gigma.ru/storage/uploads/pay.svg",
      "name": "При получении",
      "description": "Оплата наличными или картой при получении."
    },
    "address": "115477, г Москва, р-н Царицыно, ул Деловая, д 20",
    "shop": {
      "id": 19,
      "photo": null,
      "name": "Косметика",
      "address": "283011, Донецкая Народная респ, г Донецк, пр-кт Ленина, д 1",
      "latitude": "47.9763030",
      "longitude": "37.7035440",
      "phone": "78001414141",
      "schedule": null
    },
    "products": [
      {
        "id": 30525,
        "old_price": null,
        "price": "760.00",
        "name": "Мясной салат 210г",
        "photos": [
          {
            "id": 3253,
            "name": "XXL_height (1).jpg",
            "path": "https://api.gigma.ru/storage/uploads/y88lMgVYhP8fhp90va2BEDjsnlXGIVDJcGKzgm3i.jpg",
            "link": null
          }
        ],
        "quantity": 1
      }
    ],
    "payment_link": null,
    "created_at": "2025-05-29T09:17:51.000000Z"
  }
}

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

order — объект с информацией о заказе
- id — первичный ключ заказа
- status — объект с информацией о текущем статусе заказа
  - id — ID статуса
  - name — название статуса
  - photo — ссылка на фото статуса
  - created_at — дата создания статуса
- price — итоговая сумма к оплате
- delivery_type — объект с информацией о способе доставки
  - id — ID типа доставки
  - name — название типа доставки
  - price — стоимость
  - is_active — флаг активности
- delivery_subtype — объект с информацией о подтипе доставки (например, «Курьер» или «ПВЗ»)
  - id — ID подтипа
  - name — название подтипа
  - price — стоимость
  - is_active — флаг активности
- delivery_subtype_param — объект с параметрами подтипа доставки (например, адрес ПВЗ)
  - id — ID параметра
  - name — значение параметра
- payment_type — объект с информацией о способе оплаты
  - id — ID способа оплаты
  - photo — ссылка на иконку
  - name — название способа оплаты
  - description — описание
- address — адрес доставки
- shop — объект с информацией о магазине (если применимо)
  - id — ID магазина
  - photo — ссылка на фото магазина
  - name — название
  - address — адрес магазина
  - latitude — широта
  - longitude — долгота
  - phone — телефон
  - schedule — расписание работы
- products — массив товаров в заказе
  - id — ID товара
  - old_price — старая цена
  - price — текущая цена
  - name — название товара
  - photos — массив объектов с фотографиями товара
  - quantity — количество товара в заказе
- payment_link — ссылка на онлайн-оплату заказа
- created_at — дата и время создания заказа
- promo_code (string|null) — применённый промокод
- original_price (string|null) — цена до скидки
- product_discount_amount (string|null) — скидка от цены товара
- promo_discount_amount (string|null) — скидка от промокода
- total_discount_amount (string|null) — итоговая сумма скидки
- final_price (string|null) — итоговая цена к оплате с учётом всех скидок
- name (string|null) — имя покупателя в заказе
- ticket (object|null) — данные электронного билета: redeem_token, redeemed_count, total_tickets, last_redeemed_at

Подписки

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

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

Ответ

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

Оформление (checkout) подписки

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

Ответ

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

Создание подписки

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

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

nomenclature_id (int, обязательно) — ID позиции номенклатуры (с is_subscription = true)

Ответ

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

Обновление подписки

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

Ответ

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

Отмена подписки

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

Ответ

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

Возобновление подписки

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

Ответ

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

Получение платежей по подписке

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

Ответ

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

Повторная попытка оплаты подписки

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

Ответ

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