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

Справочники

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

Метод: GET
URL: https://beta.api.gigma.ru/counterparty/prices
Авторизация: -
Headers: Token: {токен приложения из Gigma}

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

  • query- опциональный параметр, используемый для поиска товаров по названию
  • country_id[] - массив опциональных параметров для фильтрации товаров по ID страны. Для получения списка стран используйте запрос
  • category_id[] - массив опциональных параметров для фильтрации товаров по ID категории. Для получения списка категорий используйте запрос
  • brand_id[] - массив опциональных параметров для фильтрации товаров по ID бренда. Для получения списка брендов используйте запрос
  • order_by - сортировка по: price_asc (увеличению цены), price_desc (уменьшению цены), popularity_asc (увеличению популярности), popularity_desc (уменьшению популярности)
  • available - наличи: online (в интернет-магазинах), offline (в розничным магазинах)
  • sale - true, если поиск товаров со скидками, false - по всем товарам
  • price_from - минимальная цена товара (числовое значение). Для получения минимальной возможной цены и ограничения соответствующей шкалы используйте запрос
  • price_to - максимальная цена товара (числовое значение). Для получения минимальной возможной цены и ограничения соответствующей шкалы используйте запрос

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

https://beta.api.gigma.ru/counterparty/prices

Ответ

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

{
    "min_price": 1,
    "max_price": 10000
}

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

  • min_price - минимальная цена
  • max_price - максимальная цена

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

Метод: GET
URL: https://beta.api.gigma.ru/counterparty/categories
Авторизация: Bearer token
Headers: Token: {токен приложения из Gigma}

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

  • limit - опциональный параметр для указания ограничения кол-ва возвращаемых значений. По умолчанию возвращаются все значения;
  • parent_id - ID родительской категории (для отображения подчиненных элементов). При отсутствии параметра возвращаются только основных категории.

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

https://beta.api.gigma.ru/counterparty/categories?limit=2&parent_id=1

Ответ

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

{
    "categories": [
        {
            "id": 2,
            "name": "Для макияжа",
            "photo": "https:\/\/beta.back.erp.itecho.ru\/\/storage\/uploads\/default.jpg",
            "parent": {
                "id": 1,
                "name": "Аксессуары",
                "photo": "https:\/\/beta.back.erp.itecho.ru\/\/storage\/uploads\/default.jpg",
                "parent": null
            }
        },
        {
            "id": 3,
            "name": "Косметические инструменты",
            "photo": "https:\/\/beta.back.erp.itecho.ru\/\/storage\/uploads\/default.jpg",
            "parent": {
                "id": 1,
                "name": "Аксессуары",
                "photo": "https:\/\/beta.back.erp.itecho.ru\/\/storage\/uploads\/default.jpg",
                "parent": null
            }
        }
    ],
    "categoriesCount": 2
}

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

  • id - первичный ключ
  • name - название категории
  • photo - ссылка на фото категории
  • parent - объект, аналогичный текущему

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

Метод: GET
URL: https://beta.api.gigma.ru/counterparty/brands
Авторизация: Bearer token
Headers: Token: {токен приложения из Gigma}

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

  • limit - опциональный параметр для указания ограничения кол-ва возвращаемых значений. По умолчанию возвращаются все значения.

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

https://beta.api.gigma.ru/counterparty/brands

Ответ

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

{
    "brands": [
        {
            "id": 1,
            "name": "Elizavecca",
            "photo": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/default_brand.png",
            "created_at": "2024-05-02T06:03:54.000000Z"
        },
        {
            "id": 2,
            "name": "Tony Moly",
            "photo": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/default_brand.png",
            "created_at": "2024-05-02T06:03:54.000000Z"
        }
    ],
    "brandsCount": 2
}

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

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

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

Метод: GET
URL: https://beta.api.gigma.ru/counterparty/countries
Авторизация: Bearer token
Headers: Token: {токен приложения из Gigma}

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

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

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

https://beta.api.gigma.ru/counterparty/countries

Ответ

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

{
    "countries": [
        {
            "id": 1,
            "name": "Россия",
            "created_at": "2024-04-10T06:59:28.000000Z"
        },
        {
            "id": 2,
            "name": "США",
            "created_at": "2024-04-10T06:59:28.000000Z"
        },
    ],
    "countriesCount": 2
}

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

  • id - первичный ключ
  • name - название страны
  • created_at - дата/время добавления в систему

Получение списка способов оплаты

Метод: GET
URL: https://beta.api.gigma.ru/counterparty/payment_types
Авторизация: -
Headers: Token: {токен приложения из Gigma}

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

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

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

https://beta.api.gigma.ru/counterparty/payment_types

Ответ

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

{
    "paymentTypes": [
        {
            "id": 1,
            "photo": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/pay.svg",
            "name": "При получении",
            "description": "Оплата наличными или картой при получении."
        },
        {
            "id": 2,
            "photo": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/cart.svg",
            "name": "Онлайн",
            "description": "Оплата через платежный сервис"
        }
    ],
    "paymentTypesCount": 2
}

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

  • id - первичный ключ
  • photo - фото способа оплаты
  • name - название
  • description - описание

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

Метод: GET
URL: https://beta.api.gigma.ru/counterparty/delivery_types
Авторизация: -
Headers: Token: {токен приложения из Gigma}
Параметры запроса: Отсутствуют.

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

https://beta.api.gigma.ru/counterparty/delivery_types

Ответ

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

{
    "deliveryType": [
        {
            "id": 1,
            "name": "Самовывоз",
            "price": "0.00",
            "is_active": 1
        },
        {
            "id": 2,
            "name": "Доставка транспортной компанией СДЭК",
            "price": "300.00",
            "is_active": 1
        }
    ],
    "deliveryTypeCount": 2
}

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

  • deliveryTypes — массив объектов способов доставки:
  • id — первичный ключ;
  • name — название способа доставки;
  • price — минимальная стоимость доставки;
  • is_active — флаг доступности способа для оформления (1 — доступен, 0 — недоступен);
  • deliveryTypesCount — общее количество способов доставки.

Примечание
При выборе способа доставки «Самовывоз» требуется выполнить дополнительный запрос для получения списка доступных магазинов.

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

Метод: GET
URL: https://beta.api.gigma.ru/counterparty/delivery_types/{id}/subtypes
Авторизация: -
Headers: Token: {токен приложения из Gigma}
Параметры запроса: Отсутствуют.

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

https://beta.api.gigma.ru/counterparty/delivery_types/2/subtypes

Ответ

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

{
    "deliverySubtypes": [
        {
            "id": 1,
            "name": "Офис транспортной компании СДЭК",
            "price": "300.00",
            "is_active": 1
        },
        {
            "id": 2,
            "name": "Курьер",
            "price": "1000.00",
            "is_active": 1
        }
    ],
    "deliverySubtypesCount": 2
}

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

  • deliverySubtypes — массив объектов подкатегорий способов доставки:
  • id — первичный ключ;
  • name — название пункта выдачи;
  • deliverySubtypesCount — общее количество подкатегорий.

Примечание
При выборе способа доставки Курьер требуется выполнить дополнительный запрос для поиска адреса по Dadata. Используйте значение value.

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

Метод: GET
URL: https://beta.api.gigma.ru/counterparty/delivery_types/{id}/subtypes/{id}/params
Авторизация: -
Headers: Token: {токен приложения из Gigma}
Параметры запроса: Отсутствуют.

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

https://beta.api.gigma.ru/counterparty/delivery_types/2/subtypes/1/params

Ответ

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

{
    "deliverySubtypeParams": [
        {
            "id": 1,
            "name": "г. Донецк, ул.Кручатова 1, пн-пт 10:00-18:00, сб 10:00-16:00, вс выходной"
        },
        {
            "id": 2,
            "name": "г. Новосибирск, ул. Советская 64, пн-пт 10:00-18:00, сб 10:00-16:00, вс выходной"
        }
    ],
    "deliverySubtypeParamsCount": 2
}

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

  • deliverySubtypeParams — массив объектов параметров подкатегорий способов доставки:
  • id — первичный ключ;
  • name — название пункта выдачи;
  • deliverySubtypesCount — общее количество параметров подкатегорий.

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

Метод: GET
URL: https://beta.api.gigma.ru/counterparty/shops
Авторизация: -
Headers: Token: {токен приложения из Gigma}
Параметры запроса: Отсутствуют.

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

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

Ответ

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

{
    "shops": [
        {
            "id": 1,
            "photo": null,
            "name": "Центральный",
            "address": "г. Донецк, ул. Ленина, 1",
            "phone": "+79851234567",
            "schedule": "ПН-ПТ, с 10:00 до 18:00"
        },
        {
            "id": 2,
            "photo": null,
            "name": "Новосибирский",
            "address": "г. Новосибирск, ул. Красный проспект, 65",
            "phone": "+79851234567",
            "schedule": "Ежедневно, с 10:00 до 18:00"
        },
        {
            "id": 3,
            "photo": null,
            "name": "Столичный",
            "address": "г. Москва, ул. Красная Площадь, 1",
            "phone": "+79851234567",
            "schedule": "Ежедневно, круглосуточно"
        }
    ],
    "shopsCount": 3
}

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

  • shops — массив объектов магазинов:
  • id — первичный ключ;
  • photo — URL фотографии магазина (или null, если отсутствует);
  • name — название магазина;
  • address — адрес пункта выдачи;
  • phone — контактный телефон;
  • schedule — график работы;
  • shopsCount — общее количество магазинов.

Получение списка рекламных слайдов

Метод: GET
URL: https://beta.api.gigma.ru/counterparty/slides
Авторизация: -
Headers: Token: {токен приложения из Gigma}

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

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

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

https://beta.api.gigma.ru/counterparty/slides

Ответ

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

{
    "slides": [
        {
            "id": 1,
            "photo": "http:\/\/localhost:8000\/storage\/uploads\/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
            "name": "Улётное лето",
            "description": "Получите скидку 20% на всё*",
            "link": "Получите скидку 20% на всё*"
        }
    ],
    "slidesCount": 1
}

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

  • id - первичный ключ
  • photo - фото рекламного слайда
  • name - название
  • description - описание
  • link - ссылка для перехода (привязать к картинке)

Поиск адресов (Dadata)

Метод: POST
URL: https://beta.api.gigma.ru/counterparty/search_address
Авторизация: -
Headers: Token: {токен приложения из Gigma}

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

  • query - поисковый запрос

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

https://beta.api.gigma.ru/counterparty/search_address

{
    "query": "Деловая 20, Москва"
}

Ответ

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

{
    "addresses": [
        {
            "name": "г Москва, ул Деловая, д 20",
            "value": "115477, г Москва, р-н Царицыно, ул Деловая, д 20"
        },
        {
            "name": "г Москва, ул Деловая, д 11 стр 20",
            "value": "115477, г Москва, р-н Царицыно, ул Деловая, д 11 стр 20"
        },
        {
            "name": "г Москва, ул Деловая, д 20 стр 2",
            "value": "115477, г Москва, р-н Царицыно, ул Деловая, д 20 стр 2"
        },
        {
            "name": "г Москва, ул Деловая, д 20 стр 3",
            "value": "115477, г Москва, р-н Царицыно, ул Деловая, д 20 стр 3"
        },
        {
            "name": "г Москва, ул Деловая, д 20 стр 4",
            "value": "115477, г Москва, р-н Царицыно, ул Деловая, д 20 стр 4"
        }
    ],
    "addressesCount": 5
}

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

  • name - краткий формат адреса
  • value - полный формат адреса

--

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

Метод: GET
URL: https://beta.api.gigma.ru/api/counterparty/dictionaries
Авторизация: Bearer token
Headers: Token: {токен приложения из Gigma}

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

  • include - Опциональный параметр. Строка, содержащая список справочников, разделенных запятыми, которые необходимо загрузить.
    • Доступные значения: categories, brands, countries, tags, popular_requests
    • По умолчанию: Если параметр не указан, будут загружены все справочники (categories, brands, countries, tags, popular_requests).

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

https://beta.api.gigma.ru/api/counterparty/dictionaries?include=categories,brands,popular_requests

Ответ

При успешном действии возвращается HTTP-код 200 с JSON-объектом, содержащим запрошенные справочники. 

{
    "dictionaries": {
        "categories": [
            {
                "id": 499,
                "name": "Массаж",
                "photo": "[https://beta.api.gigma.ru//storage/uploads/IUSGEJhjX6X6rCmrvf7KjOYTIQ5EVZGo3OwOGYWZ.jpg](https://beta.api.gigma.ru//storage/uploads/IUSGEJhjX6X6rCmrvf7KjOYTIQ5EVZGo3OwOGYWZ.jpg)",
                "parent": null
            },
            {
                "id": 498,
                "name": "Подарочный набор",
                "photo": "[https://beta.api.gigma.ru//storage/uploads/EPpuxvitfnruxQqfmchzSIh19IhlXQNVOIgAnHE9.png](https://beta.api.gigma.ru//storage/uploads/EPpuxvitfnruxQqfmchzSIh19IhlXQNVOIgAnHE9.png)",
                "parent": null
            }
        ],
        "brands": [
            {
                "id": 119,
                "name": "Dream Woman",
                "photo": "[https://beta.api.gigma.ru/storage/uploads/W9JHUSOzebZHEA7DGInsemlxb2RMMDMZwUF2AslG.webp](https://beta.api.gigma.ru/storage/uploads/W9JHUSOzebZHEA7DGInsemlxb2RMMDMZwUF2AslG.webp)",
                "created_at": "2025-03-12T07:48:42.000000Z"
            },
            {
                "id": 120,
                "name": "Grace Day",
                "photo": "[https://beta.api.gigma.ru/storage/uploads/qS3JoH94zyx6jjMHTsYnZVfz9JMDmvGzShe8aksR.jpg](https://beta.api.gigma.ru/storage/uploads/qS3JoH94zyx6jjMHTsYnZVfz9JMDmvGzShe8aksR.jpg)",
                "created_at": "2025-03-12T07:57:53.000000Z"
            }
        ],
        "countries": [
            {
                "id": 1,
                "name": "Россия",
                "photo": null,
                "created_at": "2024-04-10T06:59:28.000000Z"
            }
        ],
        "tags": [
            {
                "id": 2,
                "name": "Аксессуар",
                "photo": null,
                "created_at": "2024-04-10T07:03:08.000000Z"
            }
        ],
        "popular_requests": [
            {
                "id": 126,
                "value": "сыворотка",
                "created_at": "2025-06-23T17:50:42.000000Z"
            },
            {
                "id": 122,
                "value": "эффект",
                "created_at": "2025-06-23T09:01:31.000000Z"
            }
        ]
    }
}

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

Поле dictionaries содержит объект, ключи которого соответствуют запрошенным справочникам. - categories - (массив объектов) Массив объектов, представляющих категории. - id - (integer) Уникальный идентификатор категории. - name - (string) Название категории. - photo - (string|null) URL-адрес фотографии категории. null, если нет фото. - parent - (object|null) Объект, аналогичный текущей категории, представляющий родительскую категорию. null для категорий верхнего уровня.

  • brands - (массив объектов) Массив объектов, представляющих бренды.

    • id - (integer) Уникальный идентификатор бренда.
    • name - (string) Название бренда.
    • photo - (string|null) URL-адрес фотографии бренда. null, если нет фото.
    • created_at - (string) Дата и время создания бренда в формате ISO 8601.

  • countries - (массив объектов) Массив объектов, представляющих страны.

    • id - (integer) Уникальный идентификатор страны.
    • name - (string) Название страны.
    • photo - (string|null) URL-адрес фотографии страны. null, если нет фото.
    • created_at - (string) Дата и время создания записи о стране в формате ISO 8601.

  • tags - (массив объектов) Массив объектов, представляющих теги номенклатуры.

    • id - (integer) Уникальный идентификатор тега.
    • name - (string) Название тега.
    • photo - (string|null) URL-адрес фотографии тега. null, если нет фото.
    • created_at - (string) Дата и время создания тега в формате ISO 8601.

  • popular_requests - (массив объектов) Массив объектов, представляющих популярные поисковые запросы. Каждый объект содержит информацию о запросе.

    • id - (integer) Идентификатор последней записи запроса в группе (если поле value не уникально).
    • value - (string) Текст поискового запроса.
    • created_at - (string) Дата и время создания последней записи запроса в группе в формате ISO 8601.